class documentation
class UserSelectorArg(bb.Union): (source)
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 |
Create an instance of this class set to the ``external_id`` tag with value ``val``. |
Class Method | team |
Create an instance of this class set to the ``team_member_id`` tag with value ``val``. |
Method | get |
Only call this if :meth:`is_email` is true. |
Method | get |
Only call this if :meth:`is_external_id` is true. |
Method | get |
Only call this if :meth:`is_team_member_id` is true. |
Method | is |
Check if the union tag is ``email``. |
Method | is |
Check if the union tag is ``external_id``. |
Method | is |
Check if the union tag is ``team_member_id``. |
Method | _process |
Undocumented |
Class Variable | _catch |
Undocumented |
Create an instance of this class set to the ``email`` tag with value ``val``. :param str val: :rtype: UserSelectorArg
Create an instance of this class set to the ``external_id`` tag with value ``val``. :param str val: :rtype: UserSelectorArg
Create an instance of this class set to the ``team_member_id`` tag with value ``val``. :param str val: :rtype: UserSelectorArg