dropbox.team.BaseTeamFolderError

class documentation

class BaseTeamFolderError(bb.Union): (source)

Known subclasses: dropbox.team.TeamFolderActivateError, dropbox.team.TeamFolderArchiveError, dropbox.team.TeamFolderPermanentlyDeleteError, dropbox.team.TeamFolderRenameError, dropbox.team.TeamFolderUpdateSyncSettingsError

View In Hierarchy

Base error that all errors for existing team folders should extend. 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.

Class Method access_error Create an instance of this class set to the ``access_error`` tag with value ``val``.
Class Method status_error Create an instance of this class set to the ``status_error`` tag with value ``val``.
Class Method team_shared_dropbox_error Create an instance of this class set to the ``team_shared_dropbox_error`` tag with value ``val``.
Method get_access_error Only call this if :meth:`is_access_error` is true.
Method get_status_error Only call this if :meth:`is_status_error` is true.
Method get_team_shared_dropbox_error Only call this if :meth:`is_team_shared_dropbox_error` is true.
Method is_access_error Check if the union tag is ``access_error``.
Method is_other Check if the union tag is ``other``.
Method is_status_error Check if the union tag is ``status_error``.
Method is_team_shared_dropbox_error Check if the union tag is ``team_shared_dropbox_error``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def access_error(cls, val): (source)

Create an instance of this class set to the ``access_error`` tag with value ``val``. :param TeamFolderAccessError val: :rtype: BaseTeamFolderError

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

Create an instance of this class set to the ``status_error`` tag with value ``val``. :param TeamFolderInvalidStatusError val: :rtype: BaseTeamFolderError

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

Create an instance of this class set to the ``team_shared_dropbox_error`` tag with value ``val``. :param TeamFolderTeamSharedDropboxError val: :rtype: BaseTeamFolderError

def get_access_error(self): (source)

Only call this if :meth:`is_access_error` is true. :rtype: TeamFolderAccessError

def get_status_error(self): (source)

Only call this if :meth:`is_status_error` is true. :rtype: TeamFolderInvalidStatusError

def get_team_shared_dropbox_error(self): (source)

Only call this if :meth:`is_team_shared_dropbox_error` is true. :rtype: TeamFolderTeamSharedDropboxError

def is_access_error(self): (source)

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

def is_other(self): (source)

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

def is_status_error(self): (source)

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

def is_team_shared_dropbox_error(self): (source)

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

other = (source)

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)
overridden in dropbox.team.TeamFolderActivateError, dropbox.team.TeamFolderArchiveError, dropbox.team.TeamFolderPermanentlyDeleteError, dropbox.team.TeamFolderRenameError, dropbox.team.TeamFolderUpdateSyncSettingsError

Undocumented

_catch_all: str = (source)

Undocumented