dropbox.sharing.SharePathError

class documentation

class SharePathError(bb.Union): (source)

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 sharing.SharePathError.is_file: A file is at the specified path. :ivar sharing.SharePathError.inside_shared_folder: We do not support sharing a folder inside a shared folder. :ivar sharing.SharePathError.contains_shared_folder: We do not support shared folders that contain shared folders. :ivar sharing.SharePathError.contains_app_folder: We do not support shared folders that contain app folders. :ivar sharing.SharePathError.contains_team_folder: We do not support shared folders that contain team folders. :ivar sharing.SharePathError.is_app_folder: We do not support sharing an app folder. :ivar sharing.SharePathError.inside_app_folder: We do not support sharing a folder inside an app folder. :ivar sharing.SharePathError.is_public_folder: A public folder can't be shared this way. Use a public link instead. :ivar sharing.SharePathError.inside_public_folder: A folder inside a public folder can't be shared this way. Use a public link instead. :ivar SharedFolderMetadata SharePathError.already_shared: Folder is already shared. Contains metadata about the existing shared folder. :ivar sharing.SharePathError.invalid_path: Path is not valid. :ivar sharing.SharePathError.is_osx_package: We do not support sharing a Mac OS X package. :ivar sharing.SharePathError.inside_osx_package: We do not support sharing a folder inside a Mac OS X package. :ivar sharing.SharePathError.is_vault: We do not support sharing the Vault folder. :ivar sharing.SharePathError.is_vault_locked: We do not support sharing a folder inside a locked Vault. :ivar sharing.SharePathError.is_family: We do not support sharing the Family folder.

Class Method already_shared Create an instance of this class set to the ``already_shared`` tag with value ``val``.
Method get_already_shared Folder is already shared. Contains metadata about the existing shared folder.
Method is_already_shared Check if the union tag is ``already_shared``.
Method is_contains_app_folder Check if the union tag is ``contains_app_folder``.
Method is_contains_shared_folder Check if the union tag is ``contains_shared_folder``.
Method is_contains_team_folder Check if the union tag is ``contains_team_folder``.
Method is_inside_app_folder Check if the union tag is ``inside_app_folder``.
Method is_inside_osx_package Check if the union tag is ``inside_osx_package``.
Method is_inside_public_folder Check if the union tag is ``inside_public_folder``.
Method is_inside_shared_folder Check if the union tag is ``inside_shared_folder``.
Method is_invalid_path Check if the union tag is ``invalid_path``.
Method is_is_app_folder Check if the union tag is ``is_app_folder``.
Method is_is_family Check if the union tag is ``is_family``.
Method is_is_file Check if the union tag is ``is_file``.
Method is_is_osx_package Check if the union tag is ``is_osx_package``.
Method is_is_public_folder Check if the union tag is ``is_public_folder``.
Method is_is_vault Check if the union tag is ``is_vault``.
Method is_is_vault_locked Check if the union tag is ``is_vault_locked``.
Method is_other Check if the union tag is ``other``.
Class Variable contains_app_folder Undocumented
Class Variable contains_shared_folder Undocumented
Class Variable contains_team_folder Undocumented
Class Variable inside_app_folder Undocumented
Class Variable inside_osx_package Undocumented
Class Variable inside_public_folder Undocumented
Class Variable inside_shared_folder Undocumented
Class Variable invalid_path Undocumented
Class Variable is_app_folder Undocumented
Class Variable is_family Undocumented
Class Variable is_file Undocumented
Class Variable is_osx_package Undocumented
Class Variable is_public_folder Undocumented
Class Variable is_vault Undocumented
Class Variable is_vault_locked Undocumented
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def already_shared(cls, val): (source)

Create an instance of this class set to the ``already_shared`` tag with value ``val``. :param SharedFolderMetadata val: :rtype: SharePathError

def get_already_shared(self): (source)

Folder is already shared. Contains metadata about the existing shared folder. Only call this if :meth:`is_already_shared` is true. :rtype: SharedFolderMetadata

def is_already_shared(self): (source)

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

def is_contains_app_folder(self): (source)

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

def is_contains_shared_folder(self): (source)

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

def is_contains_team_folder(self): (source)

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

def is_inside_app_folder(self): (source)

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

def is_inside_osx_package(self): (source)

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

def is_inside_public_folder(self): (source)

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

def is_inside_shared_folder(self): (source)

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

def is_invalid_path(self): (source)

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

def is_is_app_folder(self): (source)

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

def is_is_family(self): (source)

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

def is_is_file(self): (source)

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

def is_is_osx_package(self): (source)

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

def is_is_public_folder(self): (source)

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

def is_is_vault(self): (source)

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

def is_is_vault_locked(self): (source)

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

def is_other(self): (source)

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

contains_app_folder = (source)

Undocumented

contains_shared_folder = (source)

Undocumented

contains_team_folder = (source)

Undocumented

inside_app_folder = (source)

Undocumented

inside_osx_package = (source)

Undocumented

inside_public_folder = (source)

Undocumented

inside_shared_folder = (source)

Undocumented

invalid_path = (source)

Undocumented

is_app_folder = (source)

Undocumented

is_family = (source)

Undocumented

is_file = (source)

Undocumented

is_osx_package = (source)

Undocumented

is_public_folder = (source)

Undocumented

is_vault = (source)

Undocumented

is_vault_locked = (source)

Undocumented

other = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented