DBSHARINGMountFolderError

Objective-C

@interface DBSHARINGMountFolderError : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGMountFolderError : NSObject, DBSerializable, NSCopying

The MountFolderError 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 “inside_shared_folder”.

    Description of the “inside_shared_folder” tag state: Mounting would cause a shared folder to be inside another, which is disallowed.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsideSharedFolder;

    Swift

    init(insideSharedFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “insufficient_quota” tag state: The current user does not have enough space to mount the shared folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsufficientQuota:
    (nonnull DBSHARINGInsufficientQuotaAmounts *)insufficientQuota;

    Swift

    init(insufficientQuota: DBSHARINGInsufficientQuotaAmounts)

    Parameters

    insufficientQuota

    The current user does not have enough space to mount the shared folder.

    Return Value

    An initialized instance.

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

    Description of the “already_mounted” tag state: The shared folder is already mounted.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAlreadyMounted;

    Swift

    init(alreadyMounted: ())

    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 “not_mountable”.

    Description of the “not_mountable” tag state: The shared folder is not mountable. One example where this can occur is when the shared folder belongs within a team folder in the user’s Dropbox.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNotMountable;

    Swift

    init(notMountable: ())

    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 “inside_shared_folder”.

    Declaration

    Objective-C

    - (BOOL)isInsideSharedFolder;

    Swift

    func isInsideSharedFolder() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isInsufficientQuota;

    Swift

    func isInsufficientQuota() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isAlreadyMounted;

    Swift

    func isAlreadyMounted() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isNotMountable;

    Swift

    func isNotMountable() -> Bool

    Return Value

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

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