class documentation

class AddFileMemberError(bb.Union): (source)

View In Hierarchy

Errors for :meth:`dropbox.dropbox_client.Dropbox.sharing_add_file_member`. 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.AddFileMemberError.rate_limit: The user has reached the rate limit for invitations. :ivar sharing.AddFileMemberError.invalid_comment: The custom message did not pass comment permissions checks.

Class Method access_error Create an instance of this class set to the ``access_error`` tag with value ``val``.
Class Method user_error Create an instance of this class set to the ``user_error`` tag with value ``val``.
Method get_access_error Only call this if :meth:`is_access_error` is true.
Method get_user_error Only call this if :meth:`is_user_error` is true.
Method is_access_error Check if the union tag is ``access_error``.
Method is_invalid_comment Check if the union tag is ``invalid_comment``.
Method is_other Check if the union tag is ``other``.
Method is_rate_limit Check if the union tag is ``rate_limit``.
Method is_user_error Check if the union tag is ``user_error``.
Class Variable invalid_comment Undocumented
Class Variable other Undocumented
Class Variable rate_limit 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 SharingFileAccessError val: :rtype: AddFileMemberError

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

Create an instance of this class set to the ``user_error`` tag with value ``val``. :param SharingUserError val: :rtype: AddFileMemberError

def get_access_error(self): (source)

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

def get_user_error(self): (source)

Only call this if :meth:`is_user_error` is true. :rtype: SharingUserError

def is_access_error(self): (source)

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

def is_invalid_comment(self): (source)

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

def is_other(self): (source)

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

def is_rate_limit(self): (source)

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

def is_user_error(self): (source)

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

invalid_comment = (source)

Undocumented

Undocumented

rate_limit = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented