DBTEAMTeamFolderRenameError

Objective-C

@interface DBTEAMTeamFolderRenameError : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMTeamFolderRenameError : NSObject, DBSerializable, NSCopying

The TeamFolderRenameError 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 DBTEAMTeamFolderAccessError *)accessError;

    Swift

    init(accessError: DBTEAMTeamFolderAccessError)

    Parameters

    accessError

    (no description).

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithStatusError:
    (nonnull DBTEAMTeamFolderInvalidStatusError *)statusError;

    Swift

    init(statusError: DBTEAMTeamFolderInvalidStatusError)

    Parameters

    statusError

    (no description).

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamSharedDropboxError:
    (nonnull DBTEAMTeamFolderTeamSharedDropboxError *)teamSharedDropboxError;

    Swift

    init(teamSharedDropboxError: DBTEAMTeamFolderTeamSharedDropboxError)

    Parameters

    teamSharedDropboxError

    (no description).

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

    Description of the “invalid_folder_name” tag state: The provided folder name cannot be used.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidFolderName;

    Swift

    init(invalidFolderName: ())

    Return Value

    An initialized instance.

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

    Description of the “folder_name_already_used” tag state: There is already a team folder with the same name.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFolderNameAlreadyUsed;

    Swift

    init(folderNameAlreadyUsed: ())

    Return Value

    An initialized instance.

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

    Description of the “folder_name_reserved” tag state: The provided name cannot be used because it is reserved.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFolderNameReserved;

    Swift

    init(folderNameReserved: ())

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isStatusError;

    Swift

    func isStatusError() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isTeamSharedDropboxError;

    Swift

    func isTeamSharedDropboxError() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInvalidFolderName;

    Swift

    func isInvalidFolderName() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isFolderNameAlreadyUsed;

    Swift

    func isFolderNameAlreadyUsed() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isFolderNameReserved;

    Swift

    func isFolderNameReserved() -> Bool

    Return Value

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

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