DBSHARINGCreateSharedLinkWithSettingsError

@interface DBSHARINGCreateSharedLinkWithSettingsError
    : NSObject <DBSerializable, NSCopying>

The CreateSharedLinkWithSettingsError union.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

  • Initializes union class with tag state of path.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull DBFILESLookupError *)path;

    Swift

    init(path: DBFILESLookupError)

    Parameters

    path

    (no description).

    Return Value

    An initialized instance.

  • Initializes union class with tag state of email_not_verified.

    Description of the email_not_verified tag state: User’s email should be verified.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEmailNotVerified;

    Swift

    init(emailNotVerified: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of shared_link_already_exists.

    Description of the shared_link_already_exists tag state: The shared link already exists. You can call listSharedLinks to get the existing link.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSharedLinkAlreadyExists;

    Swift

    init(sharedLinkAlreadyExists: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of settings_error.

    Description of the settings_error tag state: There is an error with the given settings.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSettingsError:
        (nonnull DBSHARINGSharedLinkSettingsError *)settingsError;

    Swift

    init(settingsError: DBSHARINGSharedLinkSettingsError)

    Parameters

    settingsError

    There is an error with the given settings.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of access_denied.

    Description of the access_denied tag state: Access to the requested path is forbidden.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAccessDenied;

    Swift

    init(accessDenied: ())

    Return Value

    An initialized instance.

  • Retrieves whether the union’s current tag state has value path.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isPath;

    Swift

    func isPath() -> Bool

    Return Value

    Whether the union’s current tag state has value path.

  • Retrieves whether the union’s current tag state has value email_not_verified.

    Declaration

    Objective-C

    - (BOOL)isEmailNotVerified;

    Swift

    func isEmailNotVerified() -> Bool

    Return Value

    Whether the union’s current tag state has value email_not_verified.

  • Retrieves whether the union’s current tag state has value shared_link_already_exists.

    Declaration

    Objective-C

    - (BOOL)isSharedLinkAlreadyExists;

    Swift

    func isSharedLinkAlreadyExists() -> Bool

    Return Value

    Whether the union’s current tag state has value shared_link_already_exists.

  • Retrieves whether the union’s current tag state has value settings_error.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isSettingsError;

    Swift

    func isSettingsError() -> Bool

    Return Value

    Whether the union’s current tag state has value settings_error.

  • Retrieves whether the union’s current tag state has value access_denied.

    Declaration

    Objective-C

    - (BOOL)isAccessDenied;

    Swift

    func isAccessDenied() -> Bool

    Return Value

    Whether the union’s current tag state has value access_denied.

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