DBSHARINGUnmountFolderError

Objective-C

@interface DBSHARINGUnmountFolderError : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGUnmountFolderError : NSObject, DBSerializable, NSCopying

The UnmountFolderError 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) DBSHARINGUnmountFolderErrorTag tag;

Swift

var tag: DBSHARINGUnmountFolderErrorTag { get }

accessError
(no description). - 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 }

Constructors


                    
                    
                    -initWithAccessError:

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.

-initWithNoPermission
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.
-initWithNotUnmountable
Initializes union class with tag state of “not_unmountable”.

Description of the “not_unmountable” tag state: The shared folder can’t be unmounted. One example where this can occur is when the shared folder’s parent folder is also a shared folder that resides in the current user’s Dropbox.
Declaration
Objective-C

- (nonnull instancetype)initWithNotUnmountable;
Swift

init(notUnmountable: ())
Return Value

An initialized instance.
-initWithOther
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

-isAccessError
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”.
-isNoPermission
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”.
-isNotUnmountable
Retrieves whether the union’s current tag state has value “not_unmountable”.
Declaration
Objective-C

- (BOOL)isNotUnmountable;
Swift

func isNotUnmountable() -> Bool
Return Value

Whether the union’s current tag state has value “not_unmountable”.
-isOther
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”.
-tagName
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.