DBSHARINGLinkAudience

Objective-C

@interface DBSHARINGLinkAudience : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGLinkAudience : NSObject, DBSerializable, NSCopying

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

    Description of the “public” tag state: Link is accessible by anyone.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPublic;

    Swift

    init(withPublic: ())

    Return Value

    An initialized instance.

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

    Description of the “team” tag state: Link is accessible only by team members.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeam;

    Swift

    init(team: ())

    Return Value

    An initialized instance.

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

    Description of the “no_one” tag state: The link can be used by no one. The link merely points the user to the content, and does not grant additional rights to the user. Members of the content who use this link can only access the content with their pre-existing access rights.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNoOne;

    Swift

    init(noOne: ())

    Return Value

    An initialized instance.

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

    Description of the “password” tag state: Use require_password instead. 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 “members”.

    Description of the “members” tag state: Link is accessible only by members of the content.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMembers;

    Swift

    init(members: ())

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

    Declaration

    Objective-C

    - (BOOL)isTeam;

    Swift

    func isTeam() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isNoOne;

    Swift

    func isNoOne() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isMembers;

    Swift

    func isMembers() -> Bool

    Return Value

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

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