dropbox.sharing.FileMemberActionIndividualResult

class documentation

class FileMemberActionIndividualResult(bb.Union): (source)

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 Optional[AccessLevel] sharing.FileMemberActionIndividualResult.success: Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder. :ivar FileMemberActionError FileMemberActionIndividualResult.member_error: User was not able to perform this action.

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 perform this action.
Method	`get_success`	Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file...
Method	`is_member_error`	Check if the union tag is ``member_error``.
Method	`is_success`	Check if the union tag is ``success``.
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: FileMemberActionIndividualResult

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

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

def get_member_error(self): (source) ¶

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

def get_success(self): (source) ¶

Part of the response for both add_file_member and remove_file_member_v1 (deprecated). For add_file_member, indicates giving access was successful and at what AccessLevel. For remove_file_member_v1, indicates member was successfully removed from the file. If AccessLevel is given, the member still has access via a parent shared folder. Only call this if :meth:`is_success` is true. :rtype: AccessLevel

def is_member_error(self): (source) ¶

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

def is_success(self): (source) ¶

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

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

Undocumented

_catch_all = (source) ¶

Undocumented