DBSHARINGAddFolderMemberError

Objective-C

@interface DBSHARINGAddFolderMemberError : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGAddFolderMemberError : NSObject, DBSerializable, NSCopying

The AddFolderMemberError union.

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) DBSHARINGAddFolderMemberErrorTag tag;

    Swift

    var tag: DBSHARINGAddFolderMemberErrorTag { get }

  • Unable to access shared folder. - note: Ensure the isAccessError method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBSHARINGSharedFolderAccessError *_Nonnull accessError;

    Swift

    var accessError: DBSHARINGSharedFolderAccessError { get }

  • members in DBSHARINGAddFolderMemberArg contains a bad invitation recipient. - note: Ensure the isBadMember method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBSHARINGAddMemberSelectorError *_Nonnull badMember;

    Swift

    var badMember: DBSHARINGAddMemberSelectorError { get }

  • The value is the member limit that was reached. - note: Ensure the isTooManyMembers method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull tooManyMembers;

    Swift

    var tooManyMembers: NSNumber { get }

  • The value is the pending invite limit that was reached. - note: Ensure the isTooManyPendingInvites method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull tooManyPendingInvites;

    Swift

    var tooManyPendingInvites: NSNumber { get }

Constructors

  • Initializes union class with tag state of “access_error”.

    Description of the “access_error” tag state: Unable to access shared folder.

    Declaration

    Objective-C

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

    Swift

    init(accessError: DBSHARINGSharedFolderAccessError)

    Parameters

    accessError

    Unable to access shared folder.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “email_unverified”.

    Description of the “email_unverified” tag state: This user’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here https://www.dropbox.com/help/317.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEmailUnverified;

    Swift

    init(emailUnverified: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “banned_member”.

    Description of the “banned_member” tag state: The current user has been banned.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithBannedMember;

    Swift

    init(bannedMember: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “bad_member”.

    Description of the “bad_member” tag state: members in DBSHARINGAddFolderMemberArg contains a bad invitation recipient.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithBadMember:
    (nonnull DBSHARINGAddMemberSelectorError *)badMember;

    Swift

    init(badMember: DBSHARINGAddMemberSelectorError)

    Parameters

    badMember

    members in DBSHARINGAddFolderMemberArg contains a bad invitation recipient.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “cant_share_outside_team”.

    Description of the “cant_share_outside_team” tag state: Your team policy does not allow sharing outside of the team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCantShareOutsideTeam;

    Swift

    init(cantShareOutsideTeam: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “too_many_members”.

    Description of the “too_many_members” tag state: The value is the member limit that was reached.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyMembers:
    (nonnull NSNumber *)tooManyMembers;

    Swift

    init(tooManyMembers: NSNumber)

    Parameters

    tooManyMembers

    The value is the member limit that was reached.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “too_many_pending_invites”.

    Description of the “too_many_pending_invites” tag state: The value is the pending invite limit that was reached.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyPendingInvites:
    (nonnull NSNumber *)tooManyPendingInvites;

    Swift

    init(tooManyPendingInvites: NSNumber)

    Parameters

    tooManyPendingInvites

    The value is the pending invite limit that was reached.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “rate_limit”.

    Description of the “rate_limit” tag state: The current user has hit the limit of invites they can send per day. Try again in 24 hours.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRateLimit;

    Swift

    init(rateLimit: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “too_many_invitees”.

    Description of the “too_many_invitees” tag state: The current user is trying to share with too many people at once.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyInvitees;

    Swift

    init(tooManyInvitees: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “insufficient_plan”.

    Description of the “insufficient_plan” tag state: The current user’s account doesn’t support this action. An example of this is when adding a read-only member. This action can only be performed by users that have upgraded to a Pro or Business plan.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsufficientPlan;

    Swift

    init(insufficientPlan: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “team_folder”.

    Description of the “team_folder” tag state: This action cannot be performed on a team shared folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamFolder;

    Swift

    init(teamFolder: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “no_permission”.

    Description of the “no_permission” tag state: The current user does not have permission to perform this action.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNoPermission;

    Swift

    init(noPermission: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “invalid_shared_folder”.

    Description of the “invalid_shared_folder” tag state: Invalid shared folder error will be returned as an access_error.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidSharedFolder;

    Swift

    init(invalidSharedFolder: ())

    Return Value

    An initialized instance.

  • 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

  • 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”.

  • Retrieves whether the union’s current tag state has value “email_unverified”.

    Declaration

    Objective-C

    - (BOOL)isEmailUnverified;

    Swift

    func isEmailUnverified() -> Bool

    Return Value

    Whether the union’s current tag state has value “email_unverified”.

  • Retrieves whether the union’s current tag state has value “banned_member”.

    Declaration

    Objective-C

    - (BOOL)isBannedMember;

    Swift

    func isBannedMember() -> Bool

    Return Value

    Whether the union’s current tag state has value “banned_member”.

  • Retrieves whether the union’s current tag state has value “bad_member”.

    Note

    Call this method and ensure it returns true before accessing the badMember property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isBadMember;

    Swift

    func isBadMember() -> Bool

    Return Value

    Whether the union’s current tag state has value “bad_member”.

  • Retrieves whether the union’s current tag state has value “cant_share_outside_team”.

    Declaration

    Objective-C

    - (BOOL)isCantShareOutsideTeam;

    Swift

    func isCantShareOutsideTeam() -> Bool

    Return Value

    Whether the union’s current tag state has value “cant_share_outside_team”.

  • Retrieves whether the union’s current tag state has value “too_many_members”.

    Note

    Call this method and ensure it returns true before accessing the tooManyMembers property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isTooManyMembers;

    Swift

    func isTooManyMembers() -> Bool

    Return Value

    Whether the union’s current tag state has value “too_many_members”.

  • Retrieves whether the union’s current tag state has value “too_many_pending_invites”.

    Note

    Call this method and ensure it returns true before accessing the tooManyPendingInvites property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isTooManyPendingInvites;

    Swift

    func isTooManyPendingInvites() -> Bool

    Return Value

    Whether the union’s current tag state has value “too_many_pending_invites”.

  • 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”.

  • Retrieves whether the union’s current tag state has value “too_many_invitees”.

    Declaration

    Objective-C

    - (BOOL)isTooManyInvitees;

    Swift

    func isTooManyInvitees() -> Bool

    Return Value

    Whether the union’s current tag state has value “too_many_invitees”.

  • Retrieves whether the union’s current tag state has value “insufficient_plan”.

    Declaration

    Objective-C

    - (BOOL)isInsufficientPlan;

    Swift

    func isInsufficientPlan() -> Bool

    Return Value

    Whether the union’s current tag state has value “insufficient_plan”.

  • Retrieves whether the union’s current tag state has value “team_folder”.

    Declaration

    Objective-C

    - (BOOL)isTeamFolder;

    Swift

    func isTeamFolder() -> Bool

    Return Value

    Whether the union’s current tag state has value “team_folder”.

  • Retrieves whether the union’s current tag state has value “no_permission”.

    Declaration

    Objective-C

    - (BOOL)isNoPermission;

    Swift

    func isNoPermission() -> Bool

    Return Value

    Whether the union’s current tag state has value “no_permission”.

  • Retrieves whether the union’s current tag state has value “invalid_shared_folder”.

    Declaration

    Objective-C

    - (BOOL)isInvalidSharedFolder;

    Swift

    func isInvalidSharedFolder() -> Bool

    Return Value

    Whether the union’s current tag state has value “invalid_shared_folder”.

  • 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”.

  • 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.