class documentation

class TeamMemberStatus(bb.Union): (source)

View In Hierarchy

The user's status as a member of a specific team. 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 team.TeamMemberStatus.active: User has successfully joined the team. :ivar team.TeamMemberStatus.invited: User has been invited to a team, but has not joined the team yet. :ivar team.TeamMemberStatus.suspended: User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member. :ivar RemovedStatus TeamMemberStatus.removed: User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.

Class Method removed Create an instance of this class set to the ``removed`` tag with value ``val``.
Method get_removed User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
Method is_active Check if the union tag is ``active``.
Method is_invited Check if the union tag is ``invited``.
Method is_removed Check if the union tag is ``removed``.
Method is_suspended Check if the union tag is ``suspended``.
Class Variable active Undocumented
Class Variable invited Undocumented
Class Variable suspended Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def removed(cls, val): (source)

Create an instance of this class set to the ``removed`` tag with value ``val``. :param RemovedStatus val: :rtype: TeamMemberStatus

def get_removed(self): (source)

User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list. Only call this if :meth:`is_removed` is true. :rtype: RemovedStatus

def is_active(self): (source)

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

def is_invited(self): (source)

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

def is_removed(self): (source)

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

def is_suspended(self): (source)

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

Undocumented

Undocumented

suspended = (source)

Undocumented

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

Undocumented

_catch_all = (source)

Undocumented