dropbox.sharing.ShareFolderJobStatus

class documentation

class ShareFolderJobStatus(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 SharedFolderMetadata ShareFolderJobStatus.complete: The share job has finished. The value is the metadata for the folder.

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 share job has finished. The value is the metadata for the folder.
Method	`get_failed`	Only call this if :meth:`is_failed` is true.
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 SharedFolderMetadata val: :rtype: ShareFolderJobStatus

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

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

def get_complete(self): (source) ¶

The share job has finished. The value is the metadata for the folder. Only call this if :meth:`is_complete` is true. :rtype: SharedFolderMetadata

def get_failed(self): (source) ¶

Only call this if :meth:`is_failed` is true. :rtype: ShareFolderError

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