class documentation

class FileAction(bb.Union): (source)

View In Hierarchy

Sharing actions that may be taken on files. 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.FileAction.disable_viewer_info: Disable viewer information on the file. :ivar sharing.FileAction.edit_contents: Change or edit contents of the file. :ivar sharing.FileAction.enable_viewer_info: Enable viewer information on the file. :ivar sharing.FileAction.invite_viewer: Add a member with view permissions. :ivar sharing.FileAction.invite_viewer_no_comment: Add a member with view permissions but no comment permissions. :ivar sharing.FileAction.invite_editor: Add a member with edit permissions. :ivar sharing.FileAction.unshare: Stop sharing this file. :ivar sharing.FileAction.relinquish_membership: Relinquish one's own membership to the file. :ivar sharing.FileAction.share_link: Use create_view_link and create_edit_link instead. :ivar sharing.FileAction.create_link: Use create_view_link and create_edit_link instead. :ivar sharing.FileAction.create_view_link: Create a shared link to a file that only allows users to view the content. :ivar sharing.FileAction.create_edit_link: Create a shared link to a file that allows users to edit the content.

Method is_create_edit_link Check if the union tag is ``create_edit_link``.
Method is_create_link Check if the union tag is ``create_link``.
Method is_create_view_link Check if the union tag is ``create_view_link``.
Method is_disable_viewer_info Check if the union tag is ``disable_viewer_info``.
Method is_edit_contents Check if the union tag is ``edit_contents``.
Method is_enable_viewer_info Check if the union tag is ``enable_viewer_info``.
Method is_invite_editor Check if the union tag is ``invite_editor``.
Method is_invite_viewer Check if the union tag is ``invite_viewer``.
Method is_invite_viewer_no_comment Check if the union tag is ``invite_viewer_no_comment``.
Method is_other Check if the union tag is ``other``.
Method is_relinquish_membership Check if the union tag is ``relinquish_membership``.
Method is_share_link Check if the union tag is ``share_link``.
Method is_unshare Check if the union tag is ``unshare``.
Class Variable create_edit_link Undocumented
Class Variable create_link Undocumented
Class Variable create_view_link Undocumented
Class Variable disable_viewer_info Undocumented
Class Variable edit_contents Undocumented
Class Variable enable_viewer_info Undocumented
Class Variable invite_editor Undocumented
Class Variable invite_viewer Undocumented
Class Variable invite_viewer_no_comment Undocumented
Class Variable other Undocumented
Class Variable relinquish_membership Undocumented
Class Variable share_link Undocumented
Class Variable unshare Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_create_edit_link(self): (source)

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

def is_create_link(self): (source)

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

def is_create_view_link(self): (source)

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

def is_disable_viewer_info(self): (source)

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

def is_edit_contents(self): (source)

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

def is_enable_viewer_info(self): (source)

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

def is_invite_editor(self): (source)

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

def is_invite_viewer(self): (source)

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

def is_invite_viewer_no_comment(self): (source)

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

def is_other(self): (source)

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

def is_relinquish_membership(self): (source)

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

def is_share_link(self): (source)

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

def is_unshare(self): (source)

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

create_edit_link = (source)

Undocumented

create_link = (source)

Undocumented

create_view_link = (source)

Undocumented

disable_viewer_info = (source)

Undocumented

edit_contents = (source)

Undocumented

enable_viewer_info = (source)

Undocumented

invite_editor = (source)

Undocumented

invite_viewer = (source)

Undocumented

invite_viewer_no_comment = (source)

Undocumented

Undocumented

relinquish_membership = (source)

Undocumented

share_link = (source)

Undocumented

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented