class documentation

class FileMemberActionError(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 sharing.FileMemberActionError.invalid_member: Specified member was not found. :ivar sharing.FileMemberActionError.no_permission: User does not have permission to perform this action on this member. :ivar SharingFileAccessError FileMemberActionError.access_error: Specified file was invalid or user does not have access. :ivar MemberAccessLevelResult FileMemberActionError.no_explicit_access: The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.

Class Method access_error Create an instance of this class set to the ``access_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 Specified file was invalid or user does not have access.
Method get_no_explicit_access The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder.
Method is_access_error Check if the union tag is ``access_error``.
Method is_invalid_member Check if the union tag is ``invalid_member``.
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 invalid_member 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 SharingFileAccessError val: :rtype: FileMemberActionError

@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 MemberAccessLevelResult val: :rtype: FileMemberActionError

def get_access_error(self): (source)

Specified file was invalid or user does not have access. Only call this if :meth:`is_access_error` is true. :rtype: SharingFileAccessError

def get_no_explicit_access(self): (source)

The action cannot be completed because the target member does not have explicit access to the file. The return value is the access that the member has to the file from a parent folder. Only call this if :meth:`is_no_explicit_access` is true. :rtype: MemberAccessLevelResult

def is_access_error(self): (source)

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

def is_invalid_member(self): (source)

Check if the union tag is ``invalid_member``. :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

invalid_member = (source)

Undocumented

no_permission = (source)

Undocumented

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented