dropbox.sharing.FolderAction

class documentation

class FolderAction(bb.Union): (source)

View In Hierarchy

Actions that may be taken on shared folders. 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.FolderAction.change_options: Change folder options, such as who can be invited to join the folder. :ivar sharing.FolderAction.disable_viewer_info: Disable viewer information for this folder. :ivar sharing.FolderAction.edit_contents: Change or edit contents of the folder. :ivar sharing.FolderAction.enable_viewer_info: Enable viewer information on the folder. :ivar sharing.FolderAction.invite_editor: Invite a user or group to join the folder with read and write permission. :ivar sharing.FolderAction.invite_viewer: Invite a user or group to join the folder with read permission. :ivar sharing.FolderAction.invite_viewer_no_comment: Invite a user or group to join the folder with read permission but no comment permissions. :ivar sharing.FolderAction.relinquish_membership: Relinquish one's own membership in the folder. :ivar sharing.FolderAction.unmount: Unmount the folder. :ivar sharing.FolderAction.unshare: Stop sharing this folder. :ivar sharing.FolderAction.leave_a_copy: Keep a copy of the contents upon leaving or being kicked from the folder. :ivar sharing.FolderAction.share_link: Use create_link instead. :ivar sharing.FolderAction.create_link: Create a shared link for folder. :ivar sharing.FolderAction.set_access_inheritance: Set whether the folder inherits permissions from its parent.

Method is_change_options Check if the union tag is ``change_options``.
Method is_create_link Check if the union tag is ``create_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_leave_a_copy Check if the union tag is ``leave_a_copy``.
Method is_other Check if the union tag is ``other``.
Method is_relinquish_membership Check if the union tag is ``relinquish_membership``.
Method is_set_access_inheritance Check if the union tag is ``set_access_inheritance``.
Method is_share_link Check if the union tag is ``share_link``.
Method is_unmount Check if the union tag is ``unmount``.
Method is_unshare Check if the union tag is ``unshare``.
Class Variable change_options Undocumented
Class Variable create_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 leave_a_copy Undocumented
Class Variable other Undocumented
Class Variable relinquish_membership Undocumented
Class Variable set_access_inheritance Undocumented
Class Variable share_link Undocumented
Class Variable unmount Undocumented
Class Variable unshare Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_change_options(self): (source)

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

def is_create_link(self): (source)

Check if the union tag is ``create_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_leave_a_copy(self): (source)

Check if the union tag is ``leave_a_copy``. :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_set_access_inheritance(self): (source)

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

def is_share_link(self): (source)

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

def is_unmount(self): (source)

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

def is_unshare(self): (source)

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

change_options = (source)

Undocumented

create_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

leave_a_copy = (source)

Undocumented

other = (source)

Undocumented

relinquish_membership = (source)

Undocumented

set_access_inheritance = (source)

Undocumented

share_link = (source)

Undocumented

unmount = (source)

Undocumented

unshare = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented