DBSHARINGUpdateFolderMemberError

Objective-C

@interface DBSHARINGUpdateFolderMemberError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGUpdateFolderMemberError : NSObject, DBSerializable, NSCopying

The UpdateFolderMemberError 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

Constructors

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

    Declaration

    Objective-C

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

    Swift

    init(accessError: DBSHARINGSharedFolderAccessError)

    Parameters

    accessError

    (no description).

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMemberError:
        (nonnull DBSHARINGSharedFolderMemberError *)memberError;

    Swift

    init(memberError: DBSHARINGSharedFolderMemberError)

    Parameters

    memberError

    (no description).

    Return Value

    An initialized instance.

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

    Description of the “no_explicit_access” tag state: If updating the access type required the member to be added to the shared folder and there was an error when adding the member.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNoExplicitAccess:
        (nonnull DBSHARINGAddFolderMemberError *)noExplicitAccess;

    Swift

    init(noExplicitAccess: DBSHARINGAddFolderMemberError)

    Parameters

    noExplicitAccess

    If updating the access type required the member to be added to the shared folder and there was an error when adding the member.

    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 downgrading a member from editor to viewer. 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 “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 “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 “member_error”.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isMemberError;

    Swift

    func isMemberError() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isNoExplicitAccess;

    Swift

    func isNoExplicitAccess() -> Bool

    Return Value

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

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