DBSHARINGModifySharedLinkSettingsError

Objective-C

@interface DBSHARINGModifySharedLinkSettingsError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGModifySharedLinkSettingsError : NSObject, DBSerializable, NSCopying

The ModifySharedLinkSettingsError 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 “shared_link_not_found”.

    Description of the “shared_link_not_found” tag state: The shared link wasn’t found.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSharedLinkNotFound;

    Swift

    init(sharedLinkNotFound: ())

    Return Value

    An initialized instance.

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

    Description of the “shared_link_access_denied” tag state: The caller is not allowed to access this shared link.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSharedLinkAccessDenied;

    Swift

    init(sharedLinkAccessDenied: ())

    Return Value

    An initialized instance.

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

    Description of the “unsupported_link_type” tag state: This type of link is not supported; use files instead.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnsupportedLinkType;

    Swift

    init(unsupportedLinkType: ())

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

    Description of the “email_not_verified” tag state: This user’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here https://www.dropbox.com/help/317.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEmailNotVerified;

    Swift

    init(emailNotVerified: ())

    Return Value

    An initialized instance.

Tag state methods

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

    Declaration

    Objective-C

    - (BOOL)isSharedLinkNotFound;

    Swift

    func isSharedLinkNotFound() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isSharedLinkAccessDenied;

    Swift

    func isSharedLinkAccessDenied() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isUnsupportedLinkType;

    Swift

    func isUnsupportedLinkType() -> Bool

    Return Value

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

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