DBSHARINGShareFolderError

Objective-C

@interface DBSHARINGShareFolderError : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGShareFolderError : NSObject, DBSerializable, NSCopying

The ShareFolderError 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 “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 “bad_path”.

    Description of the “bad_path” tag state: path in DBSHARINGShareFolderArg is invalid.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithBadPath:
    (nonnull DBSHARINGSharePathError *)badPath;

    Swift

    init(badPath: DBSHARINGSharePathError)

    Parameters

    badPath

    path in DBSHARINGShareFolderArg is invalid.

    Return Value

    An initialized instance.

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

    Description of the “team_policy_disallows_member_policy” tag state: Team policy is more restrictive than memberPolicy in DBSHARINGShareFolderArg.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamPolicyDisallowsMemberPolicy;

    Swift

    init(teamPolicyDisallowsMemberPolicy: ())

    Return Value

    An initialized instance.

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

    Description of the “disallowed_shared_link_policy” tag state: The current user’s account is not allowed to select the specified sharedLinkPolicy in DBSHARINGShareFolderArg.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDisallowedSharedLinkPolicy;

    Swift

    init(disallowedSharedLinkPolicy: ())

    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.

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

Tag state methods

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isBadPath;

    Swift

    func isBadPath() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTeamPolicyDisallowsMemberPolicy;

    Swift

    func isTeamPolicyDisallowsMemberPolicy() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isDisallowedSharedLinkPolicy;

    Swift

    func isDisallowedSharedLinkPolicy() -> Bool

    Return Value

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

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