DBSHARINGSharedLinkSettingsError

Objective-C

@interface DBSHARINGSharedLinkSettingsError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGSharedLinkSettingsError : NSObject, DBSerializable, NSCopying

The SharedLinkSettingsError 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_settings”.

    Description of the “invalid_settings” tag state: The given settings are invalid (for example, all attributes of the SharedLinkSettings are empty, the requested visibility is password in DBSHARINGRequestedVisibility but the linkPassword in DBSHARINGSharedLinkSettings is missing, expires in DBSHARINGSharedLinkSettings is set to the past, etc.).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidSettings;

    Swift

    init(invalidSettings: ())

    Return Value

    An initialized instance.

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

    Description of the “not_authorized” tag state: User is not allowed to modify the settings of this link. Note that basic users can only set public in DBSHARINGRequestedVisibility as the requestedVisibility in DBSHARINGSharedLinkSettings and cannot set expires in DBSHARINGSharedLinkSettings.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNotAuthorized;

    Swift

    init(notAuthorized: ())

    Return Value

    An initialized instance.

Tag state methods

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

    Declaration

    Objective-C

    - (BOOL)isInvalidSettings;

    Swift

    func isInvalidSettings() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isNotAuthorized;

    Swift

    func isNotAuthorized() -> Bool

    Return Value

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

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