DBSHARINGVisibility

Objective-C

@interface DBSHARINGVisibility : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGVisibility : NSObject, DBSerializable, NSCopying

The Visibility union.

Who can access a shared link. The most open visibility is public. The default depends on many aspects, such as team and user preferences and shared folder settings.

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

    Description of the “public” tag state: Anyone who has received the link can access it. No login required.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPublic;

    Swift

    init(withPublic: ())

    Return Value

    An initialized instance.

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

    Description of the “team_only” tag state: Only members of the same team can access the link. Login is required.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamOnly;

    Swift

    init(teamOnly: ())

    Return Value

    An initialized instance.

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

    Description of the “password” tag state: A link-specific password is required to access the link. Login is not required.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPassword;

    Swift

    init(password: ())

    Return Value

    An initialized instance.

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

    Description of the “team_and_password” tag state: Only members of the same team who have the link-specific password can access the link.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamAndPassword;

    Swift

    init(teamAndPassword: ())

    Return Value

    An initialized instance.

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

    Description of the “shared_folder_only” tag state: Only members of the shared folder containing the linked file can access the link. Login is required.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSharedFolderOnly;

    Swift

    init(sharedFolderOnly: ())

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

    Declaration

    Objective-C

    - (BOOL)isPublic;

    Swift

    func isPublic() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTeamOnly;

    Swift

    func isTeamOnly() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isPassword;

    Swift

    func isPassword() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTeamAndPassword;

    Swift

    func isTeamAndPassword() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isSharedFolderOnly;

    Swift

    func isSharedFolderOnly() -> Bool

    Return Value

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

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