com.dropbox.core.v2.paper

Class DbxUserPaperRequests

java.lang.Object

com.dropbox.core.v2.paper.DbxUserPaperRequests

public class DbxUserPaperRequests
extends java.lang.Object

Routes in namespace "paper".

Constructor Summary

Constructors

Constructor and Description
DbxUserPaperRequests(DbxRawClientV2 client)

Method Summary

Modifier and Type	Method and Description
void	docsArchive(java.lang.String docId) Marks the given Paper doc as archived.
DocsCreateUploader	docsCreate(ImportFormat importFormat) Creates a new Paper doc with the provided content.
DocsCreateUploader	docsCreate(ImportFormat importFormat, java.lang.String parentFolderId) Creates a new Paper doc with the provided content.
DbxDownloader<PaperDocExportResult>	docsDownload(java.lang.String docId, ExportFormat exportFormat) Exports and downloads Paper doc either as HTML or markdown.
DocsDownloadBuilder	docsDownloadBuilder(java.lang.String docId, ExportFormat exportFormat) Exports and downloads Paper doc either as HTML or markdown.
ListUsersOnFolderResponse	docsFolderUsersList(java.lang.String docId) Lists the users who are explicitly invited to the Paper folder in which the Paper doc is contained.
ListUsersOnFolderResponse	docsFolderUsersList(java.lang.String docId, int limit) Lists the users who are explicitly invited to the Paper folder in which the Paper doc is contained.
ListUsersOnFolderResponse	docsFolderUsersListContinue(java.lang.String docId, java.lang.String cursor) Once a cursor has been retrieved from docsFolderUsersList(String,int), use this to paginate through all users on the Paper folder.
FoldersContainingPaperDoc	docsGetFolderInfo(java.lang.String docId) Retrieves folder information for the given Paper doc.
ListPaperDocsResponse	docsList() Return the list of all Paper docs according to the argument specifications.
DocsListBuilder	docsListBuilder() Return the list of all Paper docs according to the argument specifications.
ListPaperDocsResponse	docsListContinue(java.lang.String cursor) Once a cursor has been retrieved from docsList(com.dropbox.core.v2.paper.ListPaperDocsArgs), use this to paginate through all Paper doc.
void	docsPermanentlyDelete(java.lang.String docId) Permanently deletes the given Paper doc.
SharingPolicy	docsSharingPolicyGet(java.lang.String docId) Gets the default sharing policy for the given Paper doc.
void	docsSharingPolicySet(java.lang.String docId, SharingPolicy sharingPolicy) Sets the default sharing policy for the given Paper doc.
DocsUpdateUploader	docsUpdate(java.lang.String docId, PaperDocUpdatePolicy docUpdatePolicy, long revision, ImportFormat importFormat) Updates an existing Paper doc with the provided content.
java.util.List<AddPaperDocUserMemberResult>	docsUsersAdd(java.lang.String docId, java.util.List<AddMember> members) Allows an owner or editor to add users to a Paper doc or change their permissions using their email address or Dropbox account ID.
DocsUsersAddBuilder	docsUsersAddBuilder(java.lang.String docId, java.util.List<AddMember> members) Allows an owner or editor to add users to a Paper doc or change their permissions using their email address or Dropbox account ID.
ListUsersOnPaperDocResponse	docsUsersList(java.lang.String docId) Lists all users who visited the Paper doc or users with explicit access.
DocsUsersListBuilder	docsUsersListBuilder(java.lang.String docId) Lists all users who visited the Paper doc or users with explicit access.
ListUsersOnPaperDocResponse	docsUsersListContinue(java.lang.String docId, java.lang.String cursor) Once a cursor has been retrieved from docsUsersList(String), use this to paginate through all users on the Paper doc.
void	docsUsersRemove(java.lang.String docId, MemberSelector member) Allows an owner or editor to remove users from a Paper doc using their email address or Dropbox account ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbxUserPaperRequests

public DbxUserPaperRequests(DbxRawClientV2 client)

Method Detail

docsArchive

public void docsArchive(java.lang.String docId)
                 throws DocLookupErrorException,
                        DbxException

Marks the given Paper doc as archived. Note: This action can be performed or undone by anyone with edit permissions to the doc.

Parameters:

docId - The Paper doc ID. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException

docsCreate

public DocsCreateUploader docsCreate(ImportFormat importFormat)
                              throws DbxException

Creates a new Paper doc with the provided content.

Parameters:

importFormat - The format of provided data. Must not be null.

Returns:

Uploader used to upload the request body and finish request.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DbxException

docsCreate

public DocsCreateUploader docsCreate(ImportFormat importFormat,
                                     java.lang.String parentFolderId)
                              throws DbxException

Creates a new Paper doc with the provided content.

Parameters:

importFormat - The format of provided data. Must not be null.

parentFolderId - The Paper folder ID where the Paper document should be created. The API user has to have write access to this folder or error is thrown.

Returns:

Uploader used to upload the request body and finish request.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DbxException

docsDownload

public DbxDownloader<PaperDocExportResult> docsDownload(java.lang.String docId,
                                                        ExportFormat exportFormat)
                                                 throws DocLookupErrorException,
                                                        DbxException

Exports and downloads Paper doc either as HTML or markdown.

Parameters:

docId - The Paper doc ID. Must not be null.

exportFormat - Must not be null.

Returns:

Downloader used to download the response body and view the server response.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException

docsDownloadBuilder

public DocsDownloadBuilder docsDownloadBuilder(java.lang.String docId,
                                               ExportFormat exportFormat)

Exports and downloads Paper doc either as HTML or markdown.

Parameters:

docId - The Paper doc ID. Must not be null.

exportFormat - Must not be null.

Returns:

Downloader builder for configuring the request parameters and instantiating a downloader.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

docsFolderUsersList

public ListUsersOnFolderResponse docsFolderUsersList(java.lang.String docId)
                                              throws DocLookupErrorException,
                                                     DbxException

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.

The limit request parameter will default to 1000 (see docsFolderUsersList(String,int)).

Parameters:

docId - The Paper doc ID. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException

docsFolderUsersList

public ListUsersOnFolderResponse docsFolderUsersList(java.lang.String docId,
                                                     int limit)
                                              throws DocLookupErrorException,
                                                     DbxException

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.

Parameters:

docId - The Paper doc ID. Must not be null.

limit - Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error. Must be greater than or equal to 1 and be less than or equal to 1000.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException

docsFolderUsersListContinue

public ListUsersOnFolderResponse docsFolderUsersListContinue(java.lang.String docId,
                                                             java.lang.String cursor)
                                                      throws ListUsersCursorErrorException,
                                                             DbxException

Once a cursor has been retrieved from docsFolderUsersList(String,int), use this to paginate through all users on the Paper folder.

Parameters:

docId - The Paper doc ID. Must not be null.

cursor - The cursor obtained from docsFolderUsersList(String,int) or docsFolderUsersListContinue(String,String). Allows for pagination. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

ListUsersCursorErrorException

DbxException

docsGetFolderInfo

public FoldersContainingPaperDoc docsGetFolderInfo(java.lang.String docId)
                                            throws DocLookupErrorException,
                                                   DbxException

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.

Note: If the Paper doc is not in any folder (aka unfiled) the response will be empty.

Parameters:

docId - The Paper doc ID. Must not be null.

Returns:

Metadata about Paper folders containing the specififed Paper doc.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException

docsList

public ListPaperDocsResponse docsList()
                               throws DbxApiException,
                                      DbxException

Return the list of all Paper docs according to the argument specifications. To iterate over through the full pagination, pass the cursor to docsListContinue(String).

The default values for the optional request parameters will be used. See DocsListBuilder for more details.

Throws:

DbxApiException

DbxException

docsListBuilder

public DocsListBuilder docsListBuilder()

Return the list of all Paper docs according to the argument specifications. To iterate over through the full pagination, pass the cursor to docsListContinue(String).

Returns:

Request builder for configuring request parameters and completing the request.

docsListContinue

public ListPaperDocsResponse docsListContinue(java.lang.String cursor)
                                       throws ListDocsCursorErrorException,
                                              DbxException

Once a cursor has been retrieved from docsList(com.dropbox.core.v2.paper.ListPaperDocsArgs), use this to paginate through all Paper doc.

Parameters:

cursor - The cursor obtained from docsList(com.dropbox.core.v2.paper.ListPaperDocsArgs) or docsListContinue(String). Allows for pagination. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

ListDocsCursorErrorException

DbxException

docsPermanentlyDelete

public void docsPermanentlyDelete(java.lang.String docId)
                           throws DocLookupErrorException,
                                  DbxException

Permanently deletes the given Paper doc. This operation is final as the doc cannot be recovered.

Note: This action can be performed only by the doc owner.

Parameters:

docId - The Paper doc ID. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException

docsSharingPolicyGet

public SharingPolicy docsSharingPolicyGet(java.lang.String docId)
                                   throws DocLookupErrorException,
                                          DbxException

Gets the default sharing policy for the given Paper doc.

Parameters:

docId - The Paper doc ID. Must not be null.

Returns:

Sharing policy of Paper doc.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException

docsSharingPolicySet

public void docsSharingPolicySet(java.lang.String docId,
                                 SharingPolicy sharingPolicy)
                          throws DocLookupErrorException,
                                 DbxException

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.

Note: 'public_sharing_policy' cannot be set to the value 'disabled' because this setting can be changed only via the team admin console.

Parameters:

docId - The Paper doc ID. Must not be null.

sharingPolicy - The default sharing policy to be set for the Paper doc. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException

docsUpdate

public DocsUpdateUploader docsUpdate(java.lang.String docId,
                                     PaperDocUpdatePolicy docUpdatePolicy,
                                     long revision,
                                     ImportFormat importFormat)
                              throws DbxException

Updates an existing Paper doc with the provided content.

Parameters:

docId - The Paper doc ID. Must not be null.

docUpdatePolicy - The policy used for the current update call. Must not be null.

revision - The latest doc revision. This value must match the head revision or an error code will be returned. This is to prevent colliding writes.

importFormat - The format of provided data. Must not be null.

Returns:

Uploader used to upload the request body and finish request.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DbxException

docsUsersAdd

public java.util.List<AddPaperDocUserMemberResult> docsUsersAdd(java.lang.String docId,
                                                                java.util.List<AddMember> members)
                                                         throws DocLookupErrorException,
                                                                DbxException

Allows an owner or editor to add users to a Paper doc or change their permissions using their email address or Dropbox account ID.

Note: The Doc owner's permissions cannot be changed.

The default values for the optional request parameters will be used. See DocsUsersAddBuilder for more details.

Parameters:

docId - The Paper doc ID. Must not be null.

members - User which should be added to the Paper doc. Specify only email address or Dropbox account ID. Must contain at most 20 items, not contain a null item, and not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException

docsUsersAddBuilder

public DocsUsersAddBuilder docsUsersAddBuilder(java.lang.String docId,
                                               java.util.List<AddMember> members)

Allows an owner or editor to add users to a Paper doc or change their permissions using their email address or Dropbox account ID.

Note: The Doc owner's permissions cannot be changed.

Parameters:

docId - The Paper doc ID. Must not be null.

members - User which should be added to the Paper doc. Specify only email address or Dropbox account ID. Must contain at most 20 items, not contain a null item, and not be null.

Returns:

Request builder for configuring request parameters and completing the request.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

docsUsersList

public ListUsersOnPaperDocResponse docsUsersList(java.lang.String docId)
                                          throws DocLookupErrorException,
                                                 DbxException

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.

The default values for the optional request parameters will be used. See DocsUsersListBuilder for more details.

Parameters:

docId - The Paper doc ID. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException

docsUsersListBuilder

public DocsUsersListBuilder docsUsersListBuilder(java.lang.String docId)

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.

Parameters:

docId - The Paper doc ID. Must not be null.

Returns:

Request builder for configuring request parameters and completing the request.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

docsUsersListContinue

public ListUsersOnPaperDocResponse docsUsersListContinue(java.lang.String docId,
                                                         java.lang.String cursor)
                                                  throws ListUsersCursorErrorException,
                                                         DbxException

Once a cursor has been retrieved from docsUsersList(String), use this to paginate through all users on the Paper doc.

Parameters:

docId - The Paper doc ID. Must not be null.

cursor - The cursor obtained from docsUsersList(String) or docsUsersListContinue(String,String). Allows for pagination. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

ListUsersCursorErrorException

DbxException

docsUsersRemove

public void docsUsersRemove(java.lang.String docId,
                            MemberSelector member)
                     throws DocLookupErrorException,
                            DbxException

Allows an owner or editor to remove users from a Paper doc using their email address or Dropbox account ID.

Note: Doc owner cannot be removed.

Parameters:

docId - The Paper doc ID. Must not be null.

member - User which should be removed from the Paper doc. Specify only email address or Dropbox account ID. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

DocLookupErrorException

DbxException