class documentation

class AddPaperDocUserResult(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 paper.AddPaperDocUserResult.success: User was successfully added to the Paper doc. :ivar paper.AddPaperDocUserResult.unknown_error: Something unexpected happened when trying to add the user to the Paper doc. :ivar paper.AddPaperDocUserResult.sharing_outside_team_disabled: The Paper doc can be shared only with team members. :ivar paper.AddPaperDocUserResult.daily_limit_reached: The daily limit of how many users can be added to the Paper doc was reached. :ivar paper.AddPaperDocUserResult.user_is_owner: Owner's permissions cannot be changed. :ivar paper.AddPaperDocUserResult.failed_user_data_retrieval: User data could not be retrieved. Clients should retry. :ivar paper.AddPaperDocUserResult.permission_already_granted: This user already has the correct permission to the Paper doc.

Method is_daily_limit_reached Check if the union tag is ``daily_limit_reached``.
Method is_failed_user_data_retrieval Check if the union tag is ``failed_user_data_retrieval``.
Method is_other Check if the union tag is ``other``.
Method is_permission_already_granted Check if the union tag is ``permission_already_granted``.
Method is_sharing_outside_team_disabled Check if the union tag is ``sharing_outside_team_disabled``.
Method is_success Check if the union tag is ``success``.
Method is_unknown_error Check if the union tag is ``unknown_error``.
Method is_user_is_owner Check if the union tag is ``user_is_owner``.
Class Variable daily_limit_reached Undocumented
Class Variable failed_user_data_retrieval Undocumented
Class Variable other Undocumented
Class Variable permission_already_granted Undocumented
Class Variable sharing_outside_team_disabled Undocumented
Class Variable success Undocumented
Class Variable unknown_error Undocumented
Class Variable user_is_owner Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_daily_limit_reached(self): (source)

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

def is_failed_user_data_retrieval(self): (source)

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

def is_other(self): (source)

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

def is_permission_already_granted(self): (source)

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

def is_sharing_outside_team_disabled(self): (source)

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

def is_success(self): (source)

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

def is_unknown_error(self): (source)

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

def is_user_is_owner(self): (source)

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

daily_limit_reached = (source)

Undocumented

failed_user_data_retrieval = (source)

Undocumented

Undocumented

permission_already_granted = (source)

Undocumented

sharing_outside_team_disabled = (source)

Undocumented

Undocumented

unknown_error = (source)

Undocumented

user_is_owner = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented