class documentation

class TeamFolderRenameError(BaseTeamFolderError): (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 team.TeamFolderRenameError.invalid_folder_name: The provided folder name cannot be used. :ivar team.TeamFolderRenameError.folder_name_already_used: There is already a team folder with the same name. :ivar team.TeamFolderRenameError.folder_name_reserved: The provided name cannot be used because it is reserved.

Method is_folder_name_already_used Check if the union tag is ``folder_name_already_used``.
Method is_folder_name_reserved Check if the union tag is ``folder_name_reserved``.
Method is_invalid_folder_name Check if the union tag is ``invalid_folder_name``.
Class Variable folder_name_already_used Undocumented
Class Variable folder_name_reserved Undocumented
Class Variable invalid_folder_name Undocumented
Method _process_custom_annotations Undocumented

Inherited from BaseTeamFolderError:

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
Class Variable _catch_all Undocumented
def is_folder_name_already_used(self): (source)

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

def is_folder_name_reserved(self): (source)

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

def is_invalid_folder_name(self): (source)

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

folder_name_already_used = (source)

Undocumented

folder_name_reserved = (source)

Undocumented

invalid_folder_name = (source)

Undocumented

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