DBTEAMTeamFolderCreateError

Objective-C

@interface DBTEAMTeamFolderCreateError : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMTeamFolderCreateError : NSObject, DBSerializable, NSCopying

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

    Description of the “invalid_folder_name” tag state: The provided 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 provided 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.

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

    Description of the “sync_settings_error” tag state: An error occurred setting the sync settings.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSyncSettingsError:
    (nonnull DBFILESSyncSettingsError *)syncSettingsError;

    Swift

    init(syncSettingsError: DBFILESSyncSettingsError)

    Parameters

    syncSettingsError

    An error occurred setting the sync settings.

    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 “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 whether the union’s current tag state has value “sync_settings_error”.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isSyncSettingsError;

    Swift

    func isSyncSettingsError() -> Bool

    Return Value

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