class documentation

class FileMemberRemoveActionResult(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 MemberAccessLevelResult FileMemberRemoveActionResult.success: Member was successfully removed from this file. :ivar FileMemberActionError FileMemberRemoveActionResult.member_error: User was not able to remove this member.

Class Method member_error Create an instance of this class set to the ``member_error`` tag with value ``val``.
Class Method success Create an instance of this class set to the ``success`` tag with value ``val``.
Method get_member_error User was not able to remove this member.
Method get_success Member was successfully removed from this file.
Method is_member_error Check if the union tag is ``member_error``.
Method is_other Check if the union tag is ``other``.
Method is_success Check if the union tag is ``success``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def member_error(cls, val): (source)

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

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

Create an instance of this class set to the ``success`` tag with value ``val``. :param MemberAccessLevelResult val: :rtype: FileMemberRemoveActionResult

def get_member_error(self): (source)

User was not able to remove this member. Only call this if :meth:`is_member_error` is true. :rtype: FileMemberActionError

def get_success(self): (source)

Member was successfully removed from this file. Only call this if :meth:`is_success` is true. :rtype: MemberAccessLevelResult

def is_member_error(self): (source)

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

def is_other(self): (source)

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

def is_success(self): (source)

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

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented