dropbox.team.MembersAddJobStatus

class documentation

class MembersAddJobStatus(async_.PollResultBase): (source)

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 [MemberAddResult] team.MembersAddJobStatus.complete: The asynchronous job has finished. For each member that was specified in the parameter :type:`MembersAddArg` that was provided to :route:`members/add`, a corresponding item is returned in this list. :ivar str team.MembersAddJobStatus.failed: The asynchronous job returned an error. The string contains an error message.

Class Method	`complete`	Create an instance of this class set to the ``complete`` tag with value ``val``.
Class Method	`failed`	Create an instance of this class set to the ``failed`` tag with value ``val``.
Method	`get_complete`	The asynchronous job has finished. For each member that was specified in the parameter :class:`MembersAddArg` that was provided to :meth:`dropbox.dropbox_client.Dropbox.team_members_add`, a corresponding item is returned in this list.
Method	`get_failed`	The asynchronous job returned an error. The string contains an error message.
Method	`is_complete`	Check if the union tag is ``complete``.
Method	`is_failed`	Check if the union tag is ``failed``.
Method	`_process_custom_annotations`	Undocumented

Inherited from PollResultBase:

Method	`is_in_progress`	Check if the union tag is ``in_progress``.
Class Variable	`in_progress`	Undocumented
Class Variable	`_catch_all`	Undocumented

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

Create an instance of this class set to the ``complete`` tag with value ``val``. :param list of [MemberAddResult] val: :rtype: MembersAddJobStatus

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

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

def get_complete(self): (source) ¶

The asynchronous job has finished. For each member that was specified in the parameter :class:`MembersAddArg` that was provided to :meth:`dropbox.dropbox_client.Dropbox.team_members_add`, a corresponding item is returned in this list. Only call this if :meth:`is_complete` is true. :rtype: list of [MemberAddResult]

def get_failed(self): (source) ¶

The asynchronous job returned an error. The string contains an error message. Only call this if :meth:`is_failed` is true. :rtype: str

def is_complete(self): (source) ¶

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

def is_failed(self): (source) ¶

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

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

overrides dropbox.async_.PollResultBase._process_custom_annotations

Undocumented