class documentation

class ActionDetails(bb.Union): (source)

View In Hierarchy

Additional information indicating the action taken that caused status change. This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar MemberRemoveActionType ActionDetails.remove_action: Define how the user was removed from the team. :ivar TeamInviteDetails ActionDetails.team_invite_details: Additional information relevant when someone is invited to the team. :ivar JoinTeamDetails ActionDetails.team_join_details: Additional information relevant when a new member joins the team.

Class Method remove_action Create an instance of this class set to the ``remove_action`` tag with value ``val``.
Class Method team_invite_details Create an instance of this class set to the ``team_invite_details`` tag with value ``val``.
Class Method team_join_details Create an instance of this class set to the ``team_join_details`` tag with value ``val``.
Method get_remove_action Define how the user was removed from the team.
Method get_team_invite_details Additional information relevant when someone is invited to the team.
Method get_team_join_details Additional information relevant when a new member joins the team.
Method is_other Check if the union tag is ``other``.
Method is_remove_action Check if the union tag is ``remove_action``.
Method is_team_invite_details Check if the union tag is ``team_invite_details``.
Method is_team_join_details Check if the union tag is ``team_join_details``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def remove_action(cls, val): (source)

Create an instance of this class set to the ``remove_action`` tag with value ``val``. :param MemberRemoveActionType val: :rtype: ActionDetails

@classmethod
def team_invite_details(cls, val): (source)

Create an instance of this class set to the ``team_invite_details`` tag with value ``val``. :param TeamInviteDetails val: :rtype: ActionDetails

@classmethod
def team_join_details(cls, val): (source)

Create an instance of this class set to the ``team_join_details`` tag with value ``val``. :param JoinTeamDetails val: :rtype: ActionDetails

def get_remove_action(self): (source)

Define how the user was removed from the team. Only call this if :meth:`is_remove_action` is true. :rtype: MemberRemoveActionType

def get_team_invite_details(self): (source)

Additional information relevant when someone is invited to the team. Only call this if :meth:`is_team_invite_details` is true. :rtype: TeamInviteDetails

def get_team_join_details(self): (source)

Additional information relevant when a new member joins the team. Only call this if :meth:`is_team_join_details` is true. :rtype: JoinTeamDetails

def is_other(self): (source)

Check if the union tag is ``other``. :rtype: bool

def is_remove_action(self): (source)

Check if the union tag is ``remove_action``. :rtype: bool

def is_team_invite_details(self): (source)

Check if the union tag is ``team_invite_details``. :rtype: bool

def is_team_join_details(self): (source)

Check if the union tag is ``team_join_details``. :rtype: bool

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)

Undocumented

_catch_all: str = (source)

Undocumented