DBSHARINGUnshareFolderError

Objective-C

@interface DBSHARINGUnshareFolderError : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGUnshareFolderError : NSObject, DBSerializable, NSCopying

The UnshareFolderError 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 “team_folder”.

    Description of the “team_folder” tag state: This action cannot be performed on a team shared folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamFolder;

    Swift

    init(teamFolder: ())

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

    Description of the “too_many_files” tag state: This shared folder has too many files to be unshared.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyFiles;

    Swift

    init(tooManyFiles: ())

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

    Declaration

    Objective-C

    - (BOOL)isTeamFolder;

    Swift

    func isTeamFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTooManyFiles;

    Swift

    func isTooManyFiles() -> Bool

    Return Value

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

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