dropbox.auth.AuthError

class documentation

class AuthError(bb.Union): (source)

View In Hierarchy

Errors occurred during authentication. 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 auth.AuthError.invalid_access_token: The access token is invalid. :ivar auth.AuthError.invalid_select_user: The user specified in 'Dropbox-API-Select-User' is no longer on the team. :ivar auth.AuthError.invalid_select_admin: The user specified in 'Dropbox-API-Select-Admin' is not a Dropbox Business team admin. :ivar auth.AuthError.user_suspended: The user has been suspended. :ivar auth.AuthError.expired_access_token: The access token has expired. :ivar TokenScopeError AuthError.missing_scope: The access token does not have the required scope to access the route. :ivar auth.AuthError.route_access_denied: The route is not available to public.

Class Method missing_scope Create an instance of this class set to the ``missing_scope`` tag with value ``val``.
Method get_missing_scope The access token does not have the required scope to access the route.
Method is_expired_access_token Check if the union tag is ``expired_access_token``.
Method is_invalid_access_token Check if the union tag is ``invalid_access_token``.
Method is_invalid_select_admin Check if the union tag is ``invalid_select_admin``.
Method is_invalid_select_user Check if the union tag is ``invalid_select_user``.
Method is_missing_scope Check if the union tag is ``missing_scope``.
Method is_other Check if the union tag is ``other``.
Method is_route_access_denied Check if the union tag is ``route_access_denied``.
Method is_user_suspended Check if the union tag is ``user_suspended``.
Class Variable expired_access_token Undocumented
Class Variable invalid_access_token Undocumented
Class Variable invalid_select_admin Undocumented
Class Variable invalid_select_user Undocumented
Class Variable other Undocumented
Class Variable route_access_denied Undocumented
Class Variable user_suspended Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def missing_scope(cls, val): (source)

Create an instance of this class set to the ``missing_scope`` tag with value ``val``. :param TokenScopeError val: :rtype: AuthError

def get_missing_scope(self): (source)

The access token does not have the required scope to access the route. Only call this if :meth:`is_missing_scope` is true. :rtype: TokenScopeError

def is_expired_access_token(self): (source)

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

def is_invalid_access_token(self): (source)

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

def is_invalid_select_admin(self): (source)

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

def is_invalid_select_user(self): (source)

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

def is_missing_scope(self): (source)

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

def is_other(self): (source)

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

def is_route_access_denied(self): (source)

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

def is_user_suspended(self): (source)

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

expired_access_token = (source)

Undocumented

invalid_access_token = (source)

Undocumented

invalid_select_admin = (source)

Undocumented

invalid_select_user = (source)

Undocumented

other = (source)

Undocumented

route_access_denied = (source)

Undocumented

user_suspended = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented