dropbox.sharing.JobError

class documentation

class JobError(bb.Union): (source)

Error occurred while performing an asynchronous job from :meth:`dropbox.dropbox_client.Dropbox.sharing_unshare_folder` or :meth:`dropbox.dropbox_client.Dropbox.sharing_remove_folder_member`. 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 UnshareFolderError JobError.unshare_folder_error: Error occurred while performing :meth:`dropbox.dropbox_client.Dropbox.sharing_unshare_folder` action. :ivar RemoveFolderMemberError JobError.remove_folder_member_error: Error occurred while performing :meth:`dropbox.dropbox_client.Dropbox.sharing_remove_folder_member` action. :ivar RelinquishFolderMembershipError JobError.relinquish_folder_membership_error: Error occurred while performing :meth:`dropbox.dropbox_client.Dropbox.sharing_relinquish_folder_membership` action.

Class Method	`relinquish_folder_membership_error`	Create an instance of this class set to the ``relinquish_folder_membership_error`` tag with value ``val``.
Class Method	`remove_folder_member_error`	Create an instance of this class set to the ``remove_folder_member_error`` tag with value ``val``.
Class Method	`unshare_folder_error`	Create an instance of this class set to the ``unshare_folder_error`` tag with value ``val``.
Method	`get_relinquish_folder_membership_error`	Error occurred while performing :meth:`dropbox.dropbox_client.Dropbox.sharing_relinquish_folder_membership` action.
Method	`get_remove_folder_member_error`	Error occurred while performing :meth:`dropbox.dropbox_client.Dropbox.sharing_remove_folder_member` action.
Method	`get_unshare_folder_error`	Error occurred while performing :meth:`dropbox.dropbox_client.Dropbox.sharing_unshare_folder` action.
Method	`is_other`	Check if the union tag is ``other``.
Method	`is_relinquish_folder_membership_error`	Check if the union tag is ``relinquish_folder_membership_error``.
Method	`is_remove_folder_member_error`	Check if the union tag is ``remove_folder_member_error``.
Method	`is_unshare_folder_error`	Check if the union tag is ``unshare_folder_error``.
Class Variable	`other`	Undocumented
Method	`_process_custom_annotations`	Undocumented
Class Variable	`_catch_all`	Undocumented

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

Create an instance of this class set to the ``relinquish_folder_membership_error`` tag with value ``val``. :param RelinquishFolderMembershipError val: :rtype: JobError

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

Create an instance of this class set to the ``remove_folder_member_error`` tag with value ``val``. :param RemoveFolderMemberError val: :rtype: JobError

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

Create an instance of this class set to the ``unshare_folder_error`` tag with value ``val``. :param UnshareFolderError val: :rtype: JobError

def get_relinquish_folder_membership_error(self): (source) ¶

Error occurred while performing :meth:`dropbox.dropbox_client.Dropbox.sharing_relinquish_folder_membership` action. Only call this if :meth:`is_relinquish_folder_membership_error` is true. :rtype: RelinquishFolderMembershipError

def get_remove_folder_member_error(self): (source) ¶

Error occurred while performing :meth:`dropbox.dropbox_client.Dropbox.sharing_remove_folder_member` action. Only call this if :meth:`is_remove_folder_member_error` is true. :rtype: RemoveFolderMemberError

def get_unshare_folder_error(self): (source) ¶

Error occurred while performing :meth:`dropbox.dropbox_client.Dropbox.sharing_unshare_folder` action. Only call this if :meth:`is_unshare_folder_error` is true. :rtype: UnshareFolderError

def is_other(self): (source) ¶

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

def is_relinquish_folder_membership_error(self): (source) ¶

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

def is_remove_folder_member_error(self): (source) ¶

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

def is_unshare_folder_error(self): (source) ¶

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

other = (source) ¶

Undocumented

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

Undocumented

_catch_all: str = (source) ¶

Undocumented