class documentation

class UserSelectorArg(bb.Union): (source)

View In Hierarchy

Argument for selecting a single user, either by team_member_id, external_id or email. 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.

Class Method email Create an instance of this class set to the ``email`` tag with value ``val``.
Class Method external_id Create an instance of this class set to the ``external_id`` tag with value ``val``.
Class Method team_member_id Create an instance of this class set to the ``team_member_id`` tag with value ``val``.
Method get_email Only call this if :meth:`is_email` is true.
Method get_external_id Only call this if :meth:`is_external_id` is true.
Method get_team_member_id Only call this if :meth:`is_team_member_id` is true.
Method is_email Check if the union tag is ``email``.
Method is_external_id Check if the union tag is ``external_id``.
Method is_team_member_id Check if the union tag is ``team_member_id``.
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def email(cls, val): (source)

Create an instance of this class set to the ``email`` tag with value ``val``. :param str val: :rtype: UserSelectorArg

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

Create an instance of this class set to the ``external_id`` tag with value ``val``. :param str val: :rtype: UserSelectorArg

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

Create an instance of this class set to the ``team_member_id`` tag with value ``val``. :param str val: :rtype: UserSelectorArg

def get_email(self): (source)

Only call this if :meth:`is_email` is true. :rtype: str

def get_external_id(self): (source)

Only call this if :meth:`is_external_id` is true. :rtype: str

def get_team_member_id(self): (source)

Only call this if :meth:`is_team_member_id` is true. :rtype: str

def is_email(self): (source)

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

def is_external_id(self): (source)

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

def is_team_member_id(self): (source)

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

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

Undocumented

_catch_all = (source)

Undocumented