dropbox.sharing.CreateSharedLinkWithSettingsError

class documentation

class CreateSharedLinkWithSettingsError(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.CreateSharedLinkWithSettingsError.email_not_verified: This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address `here <https://www.dropbox.com/help/317>`_. :ivar Optional[SharedLinkAlreadyExistsMetadata] sharing.CreateSharedLinkWithSettingsError.shared_link_already_exists: The shared link already exists. You can call :route:`list_shared_links` to get the existing link, or use the provided metadata if it is returned. :ivar SharedLinkSettingsError CreateSharedLinkWithSettingsError.settings_error: There is an error with the given settings. :ivar sharing.CreateSharedLinkWithSettingsError.access_denied: The user is not allowed to create a shared link to the specified file. For example, this can occur if the file is restricted or if the user's links are `banned <https://help.dropbox.com/files-folders/share/banned-links>`_.

Class Method path Create an instance of this class set to the ``path`` tag with value ``val``.
Class Method settings_error Create an instance of this class set to the ``settings_error`` tag with value ``val``.
Class Method shared_link_already_exists Create an instance of this class set to the ``shared_link_already_exists`` tag with value ``val``.
Method get_path Only call this if :meth:`is_path` is true.
Method get_settings_error There is an error with the given settings.
Method get_shared_link_already_exists The shared link already exists. You can call :meth:`dropbox.dropbox_client.Dropbox.sharing_list_shared_links` to get the existing link, or use the provided metadata if it is returned.
Method is_access_denied Check if the union tag is ``access_denied``.
Method is_email_not_verified Check if the union tag is ``email_not_verified``.
Method is_path Check if the union tag is ``path``.
Method is_settings_error Check if the union tag is ``settings_error``.
Method is_shared_link_already_exists Check if the union tag is ``shared_link_already_exists``.
Class Variable access_denied Undocumented
Class Variable email_not_verified Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def path(cls, val): (source)

Create an instance of this class set to the ``path`` tag with value ``val``. :param files.LookupError val: :rtype: CreateSharedLinkWithSettingsError

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

Create an instance of this class set to the ``settings_error`` tag with value ``val``. :param SharedLinkSettingsError val: :rtype: CreateSharedLinkWithSettingsError

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

Create an instance of this class set to the ``shared_link_already_exists`` tag with value ``val``. :param SharedLinkAlreadyExistsMetadata val: :rtype: CreateSharedLinkWithSettingsError

def get_path(self): (source)

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

def get_settings_error(self): (source)

There is an error with the given settings. Only call this if :meth:`is_settings_error` is true. :rtype: SharedLinkSettingsError

def get_shared_link_already_exists(self): (source)

The shared link already exists. You can call :meth:`dropbox.dropbox_client.Dropbox.sharing_list_shared_links` to get the existing link, or use the provided metadata if it is returned. Only call this if :meth:`is_shared_link_already_exists` is true. :rtype: SharedLinkAlreadyExistsMetadata

def is_access_denied(self): (source)

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

def is_email_not_verified(self): (source)

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

def is_path(self): (source)

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

def is_settings_error(self): (source)

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

def is_shared_link_already_exists(self): (source)

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

access_denied = (source)

Undocumented

email_not_verified = (source)

Undocumented

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

Undocumented

_catch_all = (source)

Undocumented