class documentation

class RelocationError(bb.Union): (source)

Known subclasses: dropbox.files.RelocationBatchError

View In Hierarchy

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 files.RelocationError.cant_copy_shared_folder: Shared folders can't be copied. :ivar files.RelocationError.cant_nest_shared_folder: Your move operation would result in nested shared folders. This is not allowed. :ivar files.RelocationError.cant_move_folder_into_itself: You cannot move a folder into itself. :ivar files.RelocationError.too_many_files: The operation would involve more than 10,000 files and folders. :ivar files.RelocationError.duplicated_or_nested_paths: There are duplicated/nested paths among ``RelocationArg.from_path`` and ``RelocationArg.to_path``. :ivar files.RelocationError.cant_transfer_ownership: Your move operation would result in an ownership transfer. You may reissue the request with the field ``RelocationArg.allow_ownership_transfer`` to true. :ivar files.RelocationError.insufficient_quota: The current user does not have enough space to move or copy the files. :ivar files.RelocationError.internal_error: Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely. :ivar files.RelocationError.cant_move_shared_folder: Can't move the shared folder to the given destination. :ivar MoveIntoVaultError RelocationError.cant_move_into_vault: Some content cannot be moved into Vault under certain circumstances, see detailed error. :ivar MoveIntoFamilyError RelocationError.cant_move_into_family: Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.

Class Method cant_move_into_family Create an instance of this class set to the ``cant_move_into_family`` tag with value ``val``.
Class Method cant_move_into_vault Create an instance of this class set to the ``cant_move_into_vault`` tag with value ``val``.
Class Method from_lookup Create an instance of this class set to the ``from_lookup`` tag with value ``val``.
Class Method from_write Create an instance of this class set to the ``from_write`` tag with value ``val``.
Class Method to Create an instance of this class set to the ``to`` tag with value ``val``.
Method get_cant_move_into_family Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.
Method get_cant_move_into_vault Some content cannot be moved into Vault under certain circumstances, see detailed error.
Method get_from_lookup Only call this if :meth:`is_from_lookup` is true.
Method get_from_write Only call this if :meth:`is_from_write` is true.
Method get_to Only call this if :meth:`is_to` is true.
Method is_cant_copy_shared_folder Check if the union tag is ``cant_copy_shared_folder``.
Method is_cant_move_folder_into_itself Check if the union tag is ``cant_move_folder_into_itself``.
Method is_cant_move_into_family Check if the union tag is ``cant_move_into_family``.
Method is_cant_move_into_vault Check if the union tag is ``cant_move_into_vault``.
Method is_cant_move_shared_folder Check if the union tag is ``cant_move_shared_folder``.
Method is_cant_nest_shared_folder Check if the union tag is ``cant_nest_shared_folder``.
Method is_cant_transfer_ownership Check if the union tag is ``cant_transfer_ownership``.
Method is_duplicated_or_nested_paths Check if the union tag is ``duplicated_or_nested_paths``.
Method is_from_lookup Check if the union tag is ``from_lookup``.
Method is_from_write Check if the union tag is ``from_write``.
Method is_insufficient_quota Check if the union tag is ``insufficient_quota``.
Method is_internal_error Check if the union tag is ``internal_error``.
Method is_other Check if the union tag is ``other``.
Method is_to Check if the union tag is ``to``.
Method is_too_many_files Check if the union tag is ``too_many_files``.
Class Variable cant_copy_shared_folder Undocumented
Class Variable cant_move_folder_into_itself Undocumented
Class Variable cant_move_shared_folder Undocumented
Class Variable cant_nest_shared_folder Undocumented
Class Variable cant_transfer_ownership Undocumented
Class Variable duplicated_or_nested_paths Undocumented
Class Variable insufficient_quota Undocumented
Class Variable internal_error Undocumented
Class Variable other Undocumented
Class Variable too_many_files Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def cant_move_into_family(cls, val): (source)

Create an instance of this class set to the ``cant_move_into_family`` tag with value ``val``. :param MoveIntoFamilyError val: :rtype: RelocationError

@classmethod
def cant_move_into_vault(cls, val): (source)

Create an instance of this class set to the ``cant_move_into_vault`` tag with value ``val``. :param MoveIntoVaultError val: :rtype: RelocationError

@classmethod
def from_lookup(cls, val): (source)

Create an instance of this class set to the ``from_lookup`` tag with value ``val``. :param LookupError val: :rtype: RelocationError

@classmethod
def from_write(cls, val): (source)

Create an instance of this class set to the ``from_write`` tag with value ``val``. :param WriteError val: :rtype: RelocationError

@classmethod
def to(cls, val): (source)

Create an instance of this class set to the ``to`` tag with value ``val``. :param WriteError val: :rtype: RelocationError

def get_cant_move_into_family(self): (source)

Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error. Only call this if :meth:`is_cant_move_into_family` is true. :rtype: MoveIntoFamilyError

def get_cant_move_into_vault(self): (source)

Some content cannot be moved into Vault under certain circumstances, see detailed error. Only call this if :meth:`is_cant_move_into_vault` is true. :rtype: MoveIntoVaultError

def get_from_lookup(self): (source)

Only call this if :meth:`is_from_lookup` is true. :rtype: LookupError

def get_from_write(self): (source)

Only call this if :meth:`is_from_write` is true. :rtype: WriteError

def get_to(self): (source)

Only call this if :meth:`is_to` is true. :rtype: WriteError

def is_cant_copy_shared_folder(self): (source)

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

def is_cant_move_folder_into_itself(self): (source)

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

def is_cant_move_into_family(self): (source)

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

def is_cant_move_into_vault(self): (source)

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

def is_cant_move_shared_folder(self): (source)

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

def is_cant_nest_shared_folder(self): (source)

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

def is_cant_transfer_ownership(self): (source)

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

def is_duplicated_or_nested_paths(self): (source)

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

def is_from_lookup(self): (source)

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

def is_from_write(self): (source)

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

def is_insufficient_quota(self): (source)

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

def is_internal_error(self): (source)

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

def is_other(self): (source)

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

def is_to(self): (source)

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

def is_too_many_files(self): (source)

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

cant_copy_shared_folder = (source)

Undocumented

cant_move_folder_into_itself = (source)

Undocumented

cant_move_shared_folder = (source)

Undocumented

cant_nest_shared_folder = (source)

Undocumented

cant_transfer_ownership = (source)

Undocumented

duplicated_or_nested_paths = (source)

Undocumented

insufficient_quota = (source)

Undocumented

internal_error = (source)

Undocumented

Undocumented

too_many_files = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented