dropbox.team.UsersSelectorArg

class documentation

class UsersSelectorArg(bb.Union): (source)

Argument for selecting a list of users, either by team_member_ids, external_ids or emails. 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 list of [str] team.UsersSelectorArg.team_member_ids: List of member IDs. :ivar list of [str] team.UsersSelectorArg.external_ids: List of external user IDs. :ivar list of [str] team.UsersSelectorArg.emails: List of email addresses.

Class Method	`emails`	Create an instance of this class set to the ``emails`` tag with value ``val``.
Class Method	`external_ids`	Create an instance of this class set to the ``external_ids`` tag with value ``val``.
Class Method	`team_member_ids`	Create an instance of this class set to the ``team_member_ids`` tag with value ``val``.
Method	`get_emails`	List of email addresses.
Method	`get_external_ids`	List of external user IDs.
Method	`get_team_member_ids`	List of member IDs.
Method	`is_emails`	Check if the union tag is ``emails``.
Method	`is_external_ids`	Check if the union tag is ``external_ids``.
Method	`is_team_member_ids`	Check if the union tag is ``team_member_ids``.
Method	`_process_custom_annotations`	Undocumented
Class Variable	`_catch_all`	Undocumented

@classmethod
def emails(cls, val): (source) ¶

Create an instance of this class set to the ``emails`` tag with value ``val``. :param list of [str] val: :rtype: UsersSelectorArg

@classmethod
def external_ids(cls, val): (source) ¶

Create an instance of this class set to the ``external_ids`` tag with value ``val``. :param list of [str] val: :rtype: UsersSelectorArg

@classmethod
def team_member_ids(cls, val): (source) ¶

Create an instance of this class set to the ``team_member_ids`` tag with value ``val``. :param list of [str] val: :rtype: UsersSelectorArg

def get_emails(self): (source) ¶

List of email addresses. Only call this if :meth:`is_emails` is true. :rtype: list of [str]

def get_external_ids(self): (source) ¶

List of external user IDs. Only call this if :meth:`is_external_ids` is true. :rtype: list of [str]

def get_team_member_ids(self): (source) ¶

List of member IDs. Only call this if :meth:`is_team_member_ids` is true. :rtype: list of [str]

def is_emails(self): (source) ¶

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

def is_external_ids(self): (source) ¶

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

def is_team_member_ids(self): (source) ¶

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

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

Undocumented

_catch_all = (source) ¶

Undocumented