Module dropbox_sdk::paper
source · [−]dbx_paper only.Expand description
This namespace contains endpoints and data types for managing docs and folders in Dropbox Paper. New Paper users will see docs they create in their filesystem as ‘.paper’ files alongside their other Dropbox content. The /paper endpoints are being deprecated and you’ll need to use /files and /sharing endpoints to interact with their Paper content. Read more in the Paper Migration Guide.
Structs
Per-member result for docs_users_add().
Data structure representing a Paper folder.
Metadata about Paper folders containing the specififed Paper doc.
Sharing policy of Paper doc.
Enums
The subscription level of a Paper doc.
The desired export format of the Paper doc.
The sharing policy of a Paper folder. The sharing policy of subfolders is inherited from the root folder.
The subscription level of a Paper folder.
The import format of the incoming data.
The sharing policy type of the Paper doc.
Functions
Marks the given Paper doc as archived. This action can be performed or undone by anyone with edit permissions to the doc. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. This endpoint will be retired in September 2020. Refer to the Paper Migration Guide for more information.
Creates a new Paper doc with the provided content. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. This endpoint will be retired in September 2020. Refer to the Paper Migration Guide for more information.
Exports and downloads Paper doc either as HTML or markdown. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.
Lists the users who are explicitly invited to the Paper folder in which the Paper doc is contained. For private folders all users (including owner) shared on the folder are listed and for team folders all non-team users shared on the folder are returned. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.
Once a cursor has been retrieved from docs_folder_users_list(), use
this to paginate through all users on the Paper folder. Note that this endpoint will continue to
work for content created by users on the older version of Paper. To check which version of Paper
a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the
user is running the new version of Paper. Refer to the Paper Migration
Guide for migration
information.
Retrieves folder information for the given Paper doc. This includes: - folder sharing policy; permissions for subfolders are set by the top-level folder. - full ‘filepath’, i.e. the list of folders (both folderId and folderName) from the root folder to the folder directly containing the Paper doc.
Return the list of all Paper docs according to the argument specifications. To iterate over
through the full pagination, pass the cursor to docs_list_continue().
Note that this endpoint will continue to work for content created by users on the older version
of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the
paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to
the Paper Migration
Guide for migration
information.
Once a cursor has been retrieved from docs_list(), use this to paginate through
all Paper doc. Note that this endpoint will continue to work for content created by users on the
older version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then the user is running
the new version of Paper. Refer to the Paper Migration
Guide for migration
information.
Permanently deletes the given Paper doc. This operation is final as the doc cannot be recovered. This action can be performed only by the doc owner. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.
Gets the default sharing policy for the given Paper doc. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.
Sets the default sharing policy for the given Paper doc. The default ‘team_sharing_policy’ can be changed only by teams, omit this field for personal accounts. The ‘public_sharing_policy’ policy can’t be set to the value ‘disabled’ because this setting can be changed only via the team admin console. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.
Updates an existing Paper doc with the provided content. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. This endpoint will be retired in September 2020. Refer to the Paper Migration Guide for more information.
Allows an owner or editor to add users to a Paper doc or change their permissions using their email address or Dropbox account ID. The doc owner’s permissions cannot be changed. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.
Lists all users who visited the Paper doc or users with explicit access. This call excludes users who have been removed. The list is sorted by the date of the visit or the share date. The list will include both users, the explicitly shared ones as well as those who came in using the Paper url link. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.
Once a cursor has been retrieved from docs_users_list(), use this to
paginate through all users on the Paper doc. Note that this endpoint will continue to work for
content created by users on the older version of Paper. To check which version of Paper a user
is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user
is running the new version of Paper. Refer to the Paper Migration
Guide for migration
information.
Allows an owner or editor to remove users from a Paper doc using their email address or Dropbox account ID. The doc owner cannot be removed. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.
Create a new Paper folder with the provided info. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.