dropbox.async_.LaunchResultBase

class documentation

class LaunchResultBase(bb.Union): (source)

Known subclasses: dropbox.async_.LaunchEmptyResult, dropbox.files.CreateFolderBatchLaunch, dropbox.files.DeleteBatchLaunch, dropbox.files.RelocationBatchLaunch, dropbox.files.RelocationBatchV2Launch, dropbox.files.SaveUrlResult, dropbox.files.UploadSessionFinishBatchLaunch, dropbox.sharing.ShareFolderLaunch, dropbox.team.MembersAddLaunch, dropbox.team.MembersAddLaunchV2Result, dropbox.team.TeamFolderArchiveLaunch

View In Hierarchy

Result returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response. See :class:`LaunchEmptyResult` for an example. 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 str async.LaunchResultBase.async_job_id: This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

Class Method	`async_job_id`	Create an instance of this class set to the ``async_job_id`` tag with value ``val``.
Method	`get_async_job_id`	This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
Method	`is_async_job_id`	Check if the union tag is ``async_job_id``.
Method	`_process_custom_annotations`	Undocumented
Class Variable	`_catch_all`	Undocumented

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

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

def get_async_job_id(self): (source) ¶

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job. Only call this if :meth:`is_async_job_id` is true. :rtype: str

def is_async_job_id(self): (source) ¶

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

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

overridden in dropbox.async_.LaunchEmptyResult, dropbox.files.CreateFolderBatchLaunch, dropbox.files.DeleteBatchLaunch, dropbox.files.RelocationBatchLaunch, dropbox.files.RelocationBatchV2Launch, dropbox.files.SaveUrlResult, dropbox.files.UploadSessionFinishBatchLaunch, dropbox.sharing.ShareFolderLaunch, dropbox.team.MembersAddLaunch, dropbox.team.MembersAddLaunchV2Result, dropbox.team.TeamFolderArchiveLaunch

Undocumented

_catch_all = (source) ¶

overridden in dropbox.files.CreateFolderBatchLaunch, dropbox.files.DeleteBatchLaunch, dropbox.files.RelocationBatchLaunch, dropbox.files.UploadSessionFinishBatchLaunch, dropbox.team.MembersAddLaunchV2Result

Undocumented