DBTEAMLOGContextLogInfo

Objective-C

@interface DBTEAMLOGContextLogInfo : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLOGContextLogInfo : NSObject, DBSerializable, NSCopying

The ContextLogInfo union.

The primary entity on which the action was done.

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

    Description of the “anonymous” tag state: Anonymous context.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAnonymous;

    Swift

    init(anonymous: ())

    Return Value

    An initialized instance.

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

    Description of the “non_team_member” tag state: Action was done on behalf of a non team member.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNonTeamMember:
        (nonnull DBTEAMLOGNonTeamMemberLogInfo *)nonTeamMember;

    Swift

    init(nonTeamMember: DBTEAMLOGNonTeamMemberLogInfo)

    Parameters

    nonTeamMember

    Action was done on behalf of a non team member.

    Return Value

    An initialized instance.

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

    Description of the “organization_team” tag state: Action was done on behalf of a team that’s part of an organization.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOrganizationTeam:
        (nonnull DBTEAMLOGTeamLogInfo *)organizationTeam;

    Swift

    init(organizationTeam: DBTEAMLOGTeamLogInfo)

    Parameters

    organizationTeam

    Action was done on behalf of a team that’s part of an organization.

    Return Value

    An initialized instance.

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

    Description of the “team” tag state: Action was done on behalf of the team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeam;

    Swift

    init(team: ())

    Return Value

    An initialized instance.

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

    Description of the “team_member” tag state: Action was done on behalf of a team member.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamMember:
        (nonnull DBTEAMLOGTeamMemberLogInfo *)teamMember;

    Swift

    init(teamMember: DBTEAMLOGTeamMemberLogInfo)

    Parameters

    teamMember

    Action was done on behalf of a team member.

    Return Value

    An initialized instance.

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

    Description of the “trusted_non_team_member” tag state: Action was done on behalf of a trusted non team member.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTrustedNonTeamMember:
        (nonnull DBTEAMLOGTrustedNonTeamMemberLogInfo *)trustedNonTeamMember;

    Swift

    init(trustedNonTeamMember: DBTEAMLOGTrustedNonTeamMemberLogInfo)

    Parameters

    trustedNonTeamMember

    Action was done on behalf of a trusted non team member.

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

    Declaration

    Objective-C

    - (BOOL)isAnonymous;

    Swift

    func isAnonymous() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isNonTeamMember;

    Swift

    func isNonTeamMember() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isOrganizationTeam;

    Swift

    func isOrganizationTeam() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isTeamMember;

    Swift

    func isTeamMember() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isTrustedNonTeamMember;

    Swift

    func isTrustedNonTeamMember() -> Bool

    Return Value

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

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