class documentation

class UpdateFolderMemberError(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 AddFolderMemberError UpdateFolderMemberError.no_explicit_access: If updating the access type required the member to be added to the shared folder and there was an error when adding the member. :ivar sharing.UpdateFolderMemberError.insufficient_plan: The current user's account doesn't support this action. An example of this is when downgrading a member from editor to viewer. This action can only be performed by users that have upgraded to a Pro or Business plan. :ivar sharing.UpdateFolderMemberError.no_permission: The current user does not have permission to perform this action.

Class Method access_error Create an instance of this class set to the ``access_error`` tag with value ``val``.
Class Method member_error Create an instance of this class set to the ``member_error`` tag with value ``val``.
Class Method no_explicit_access Create an instance of this class set to the ``no_explicit_access`` tag with value ``val``.
Method get_access_error Only call this if :meth:`is_access_error` is true.
Method get_member_error Only call this if :meth:`is_member_error` is true.
Method get_no_explicit_access If updating the access type required the member to be added to the shared folder and there was an error when adding the member.
Method is_access_error Check if the union tag is ``access_error``.
Method is_insufficient_plan Check if the union tag is ``insufficient_plan``.
Method is_member_error Check if the union tag is ``member_error``.
Method is_no_explicit_access Check if the union tag is ``no_explicit_access``.
Method is_no_permission Check if the union tag is ``no_permission``.
Method is_other Check if the union tag is ``other``.
Class Variable insufficient_plan Undocumented
Class Variable no_permission Undocumented
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 SharedFolderAccessError val: :rtype: UpdateFolderMemberError

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

Create an instance of this class set to the ``member_error`` tag with value ``val``. :param SharedFolderMemberError val: :rtype: UpdateFolderMemberError

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

Create an instance of this class set to the ``no_explicit_access`` tag with value ``val``. :param AddFolderMemberError val: :rtype: UpdateFolderMemberError

def get_access_error(self): (source)

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

def get_member_error(self): (source)

Only call this if :meth:`is_member_error` is true. :rtype: SharedFolderMemberError

def get_no_explicit_access(self): (source)

If updating the access type required the member to be added to the shared folder and there was an error when adding the member. Only call this if :meth:`is_no_explicit_access` is true. :rtype: AddFolderMemberError

def is_access_error(self): (source)

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

def is_insufficient_plan(self): (source)

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

def is_member_error(self): (source)

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

def is_no_explicit_access(self): (source)

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

def is_no_permission(self): (source)

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

def is_other(self): (source)

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

insufficient_plan = (source)

Undocumented

no_permission = (source)

Undocumented

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented