DBTEAMLOGActionDetails

Objective-C

@interface DBTEAMLOGActionDetails : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLOGActionDetails : NSObject, DBSerializable, NSCopying

The ActionDetails union.

Additional information indicating the action taken that caused status change.

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

    Description of the “remove_action” tag state: Define how the user was removed from the team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRemoveAction:
        (nonnull DBTEAMLOGMemberRemoveActionType *)removeAction;

    Swift

    init(removeAction: DBTEAMLOGMemberRemoveActionType)

    Parameters

    removeAction

    Define how the user was removed from the team.

    Return Value

    An initialized instance.

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

    Description of the “team_invite_details” tag state: Additional information relevant when someone is invited to the team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamInviteDetails:
        (nonnull DBTEAMLOGTeamInviteDetails *)teamInviteDetails;

    Swift

    init(teamInviteDetails: DBTEAMLOGTeamInviteDetails)

    Parameters

    teamInviteDetails

    Additional information relevant when someone is invited to the team.

    Return Value

    An initialized instance.

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

    Description of the “team_join_details” tag state: Additional information relevant when a new member joins the team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamJoinDetails:
        (nonnull DBTEAMLOGJoinTeamDetails *)teamJoinDetails;

    Swift

    init(teamJoin teamJoinDetails: DBTEAMLOGJoinTeamDetails)

    Parameters

    teamJoinDetails

    Additional information relevant when a new member joins the team.

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isRemoveAction;

    Swift

    func isRemoveAction() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isTeamInviteDetails;

    Swift

    func isTeamInvite() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isTeamJoinDetails;

    Swift

    func isTeamJoin() -> Bool

    Return Value

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

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