DBSHARINGAddFileMemberError

Objective-C

@interface DBSHARINGAddFileMemberError : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGAddFileMemberError : NSObject, DBSerializable, NSCopying

The AddFileMemberError union.

Errors for addFileMember.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

tag

Represents the union’s current tag state.

Declaration

Objective-C

@property (nonatomic, readonly) DBSHARINGAddFileMemberErrorTag tag;

Swift

var tag: DBSHARINGAddFileMemberErrorTag { get }

userError
(no description). - note: Ensure the isUserError method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBSHARINGSharingUserError *_Nonnull userError;
Swift

var userError: DBSHARINGSharingUserError { get }
accessError
(no description). - note: Ensure the isAccessError method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBSHARINGSharingFileAccessError *_Nonnull accessError;
Swift

var accessError: DBSHARINGSharingFileAccessError { get }

Constructors


                    
                    
                    -initWithUserError:

Initializes union class with tag state of “user_error”.

Declaration

Objective-C

- (nonnull instancetype)initWithUserError:
    (nonnull DBSHARINGSharingUserError *)userError;

Swift

init(userError: DBSHARINGSharingUserError)

Parameters


                                userError

(no description).

Return Value

An initialized instance.


                    
                    
                    -initWithAccessError:

Initializes union class with tag state of “access_error”.

Declaration

Objective-C

- (nonnull instancetype)initWithAccessError:
    (nonnull DBSHARINGSharingFileAccessError *)accessError;

Swift

init(accessError: DBSHARINGSharingFileAccessError)

Parameters


                                accessError

(no description).

Return Value

An initialized instance.

-initWithRateLimit
Initializes union class with tag state of “rate_limit”.

Description of the “rate_limit” tag state: The user has reached the rate limit for invitations.
Declaration
Objective-C

- (nonnull instancetype)initWithRateLimit;
Swift

init(rateLimit: ())
Return Value

An initialized instance.
-initWithInvalidComment
Initializes union class with tag state of “invalid_comment”.

Description of the “invalid_comment” tag state: The custom message did not pass comment permissions checks.
Declaration
Objective-C

- (nonnull instancetype)initWithInvalidComment;
Swift

init(invalidComment: ())
Return Value

An initialized instance.
-initWithOther
Initializes union class with tag state of “other”.
Declaration
Objective-C

- (nonnull instancetype)initWithOther;
Swift

init(other: ())
Return Value

An initialized instance.

Tag state methods

-isUserError
Retrieves whether the union’s current tag state has value “user_error”.

Note

Call this method and ensure it returns true before accessing the userError property, otherwise a runtime exception will be thrown.
Declaration
Objective-C

- (BOOL)isUserError;
Swift

func isUserError() -> Bool
Return Value

Whether the union’s current tag state has value “user_error”.
-isAccessError
Retrieves whether the union’s current tag state has value “access_error”.

Note

Call this method and ensure it returns true before accessing the accessError property, otherwise a runtime exception will be thrown.
Declaration
Objective-C

- (BOOL)isAccessError;
Swift

func isAccessError() -> Bool
Return Value

Whether the union’s current tag state has value “access_error”.
-isRateLimit
Retrieves whether the union’s current tag state has value “rate_limit”.
Declaration
Objective-C

- (BOOL)isRateLimit;
Swift

func isRateLimit() -> Bool
Return Value

Whether the union’s current tag state has value “rate_limit”.
-isInvalidComment
Retrieves whether the union’s current tag state has value “invalid_comment”.
Declaration
Objective-C

- (BOOL)isInvalidComment;
Swift

func isInvalidComment() -> Bool
Return Value

Whether the union’s current tag state has value “invalid_comment”.
-isOther
Retrieves whether the union’s current tag state has value “other”.
Declaration
Objective-C

- (BOOL)isOther;
Swift

func isOther() -> Bool
Return Value

Whether the union’s current tag state has value “other”.
-tagName
Retrieves string value of union’s current tag state.
Declaration
Objective-C

- (nonnull NSString *)tagName;
Swift

func tagName() -> String
Return Value

A human-readable string representing the union’s current tag state.