DBSHARINGFileMemberActionError

@interface DBSHARINGFileMemberActionError : NSObject <DBSerializable, NSCopying>

The FileMemberActionError union.

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

  • Initializes union class with tag state of invalid_member.

    Description of the invalid_member tag state: Specified member was not found.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidMember;

    Swift

    init(invalidMember: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of no_permission.

    Description of the no_permission tag state: User does not have permission to perform this action on this member.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNoPermission;

    Swift

    init(noPermission: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of access_error.

    Description of the access_error tag state: Specified file was invalid or user does not have access.

    Declaration

    Objective-C

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

    Swift

    init(accessError: DBSHARINGSharingFileAccessError)

    Parameters

    accessError

    Specified file was invalid or user does not have access.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of no_explicit_access.

    Description of the no_explicit_access tag state: The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.

    Declaration

    Objective-C

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

    Swift

    init(noExplicitAccess: DBSHARINGMemberAccessLevelResult)

    Parameters

    noExplicitAccess

    The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.

    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.

  • Retrieves whether the union’s current tag state has value invalid_member.

    Declaration

    Objective-C

    - (BOOL)isInvalidMember;

    Swift

    func isInvalidMember() -> Bool

    Return Value

    Whether the union’s current tag state has value invalid_member.

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