DBPAPERUserAuthRoutes Class Reference


                    
                    
                    client

An instance of the networking client that each route will use to submit a request.

Declaration

Objective-C

@property (nonatomic, readonly) id<DBTransportClient> _Nonnull client;


                    
                    
                    -init:

Initializes the DBPAPERUserAuthRoutes namespace container object with a networking client.

Declaration

Objective-C

- (nonnull instancetype)init:(nonnull id<DBTransportClient>)client;


                    
                    
                    -docsArchive:

Deprecated

docsArchive is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for more information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBPAPERDocLookupError *> *)docsArchive:
    (nonnull NSString *)docId;

Swift

func docsArchive(_ docId: String) -> DBRpcTask<DBNilObject, DBPAPERDocLookupError>

Parameters


                                docId

The Paper doc ID.

Return Value

Through the response callback, the caller will receive a void object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsCreateUrl:inputUrl:

Deprecated

docsCreate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for more information.

Declaration

Objective-C

- (nonnull DBUploadTask<DBPAPERPaperDocCreateUpdateResult *,
                        DBPAPERPaperDocCreateError *> *)
    docsCreateUrl:(nonnull DBPAPERImportFormat *)importFormat
         inputUrl:(nonnull NSString *)inputUrl;

Swift

func docsCreateUrl(_ importFormat: DBPAPERImportFormat, inputUrl: String) -> DBUploadTask<DBPAPERPaperDocCreateUpdateResult, DBPAPERPaperDocCreateError>

Parameters

`importFormat`	The format of provided data.
`inputUrl`	The file to upload, as an NSString * object.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocCreateUpdateResult object on success or a DBPAPERPaperDocCreateError object on failure.


                    
                    
                    -docsCreateUrl:parentFolderId:inputUrl:

Deprecated

docsCreate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for more information.

Declaration

Objective-C

- (nonnull DBUploadTask<DBPAPERPaperDocCreateUpdateResult *,
                        DBPAPERPaperDocCreateError *> *)
     docsCreateUrl:(nonnull DBPAPERImportFormat *)importFormat
    parentFolderId:(nullable NSString *)parentFolderId
          inputUrl:(nonnull NSString *)inputUrl;

Swift

func docsCreateUrl(_ importFormat: DBPAPERImportFormat, parentFolderId: String?, inputUrl: String) -> DBUploadTask<DBPAPERPaperDocCreateUpdateResult, DBPAPERPaperDocCreateError>

Parameters

`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.
`importFormat`	The format of provided data.
`inputUrl`	The file to upload, as an NSString * object.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocCreateUpdateResult object on success or a DBPAPERPaperDocCreateError object on failure.


                    
                    
                    -docsCreateData:inputData:

Deprecated

docsCreate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for more information.

Declaration

Objective-C

- (nonnull DBUploadTask<DBPAPERPaperDocCreateUpdateResult *,
                        DBPAPERPaperDocCreateError *> *)
    docsCreateData:(nonnull DBPAPERImportFormat *)importFormat
         inputData:(nonnull NSData *)inputData;

Swift

func docsCreateData(_ importFormat: DBPAPERImportFormat, inputData: Data) -> DBUploadTask<DBPAPERPaperDocCreateUpdateResult, DBPAPERPaperDocCreateError>

Parameters

`importFormat`	The format of provided data.
`inputData`	The file to upload, as an NSData * object.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocCreateUpdateResult object on success or a DBPAPERPaperDocCreateError object on failure.


                    
                    
                    -docsCreateData:parentFolderId:inputData:

Deprecated

docsCreate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for more information.

Declaration

Objective-C

- (nonnull DBUploadTask<DBPAPERPaperDocCreateUpdateResult *,
                        DBPAPERPaperDocCreateError *> *)
    docsCreateData:(nonnull DBPAPERImportFormat *)importFormat
    parentFolderId:(nullable NSString *)parentFolderId
         inputData:(nonnull NSData *)inputData;

Swift

func docsCreateData(_ importFormat: DBPAPERImportFormat, parentFolderId: String?, inputData: Data) -> DBUploadTask<DBPAPERPaperDocCreateUpdateResult, DBPAPERPaperDocCreateError>

Parameters

`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.
`importFormat`	The format of provided data.
`inputData`	The file to upload, as an NSData * object.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocCreateUpdateResult object on success or a DBPAPERPaperDocCreateError object on failure.


                    
                    
                    -docsCreateStream:inputStream:

Deprecated

docsCreate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for more information.

Declaration

Objective-C

- (nonnull DBUploadTask<DBPAPERPaperDocCreateUpdateResult *,
                        DBPAPERPaperDocCreateError *> *)
    docsCreateStream:(nonnull DBPAPERImportFormat *)importFormat
         inputStream:(nonnull NSInputStream *)inputStream;

Swift

func docsCreateStream(_ importFormat: DBPAPERImportFormat, inputStream: InputStream) -> DBUploadTask<DBPAPERPaperDocCreateUpdateResult, DBPAPERPaperDocCreateError>

Parameters

`importFormat`	The format of provided data.
`inputStream`	The file to upload, as an NSInputStream * object.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocCreateUpdateResult object on success or a DBPAPERPaperDocCreateError object on failure.


                    
                    
                    -docsCreateStream:parentFolderId:inputStream:

Deprecated

docsCreate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for more information.

Declaration

Objective-C

- (nonnull DBUploadTask<DBPAPERPaperDocCreateUpdateResult *,
                        DBPAPERPaperDocCreateError *> *)
    docsCreateStream:(nonnull DBPAPERImportFormat *)importFormat
      parentFolderId:(nullable NSString *)parentFolderId
         inputStream:(nonnull NSInputStream *)inputStream;

Swift

func docsCreateStream(_ importFormat: DBPAPERImportFormat, parentFolderId: String?, inputStream: InputStream) -> DBUploadTask<DBPAPERPaperDocCreateUpdateResult, DBPAPERPaperDocCreateError>

Parameters

`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.
`importFormat`	The format of provided data.
`inputStream`	The file to upload, as an NSInputStream * object.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocCreateUpdateResult object on success or a DBPAPERPaperDocCreateError object on failure.


                    
                    
                    -docsDownloadUrl:exportFormat:overwrite:destination:

Deprecated

docsDownload is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBDownloadUrlTask<DBPAPERPaperDocExportResult *,
                             DBPAPERDocLookupError *> *)
    docsDownloadUrl:(nonnull NSString *)docId
       exportFormat:(nonnull DBPAPERExportFormat *)exportFormat
          overwrite:(BOOL)overwrite
        destination:(nonnull NSURL *)destination;

Swift

func docsDownloadUrl(_ docId: String, exportFormat: DBPAPERExportFormat, overwrite: Bool, destination: URL) -> DBDownloadUrlTask<DBPAPERPaperDocExportResult, DBPAPERDocLookupError>

Parameters

`overwrite`	A boolean to set behavior in the event of a naming conflict. `YES` will overwrite conflicting file at destination. `NO` will take no action, resulting in an `NSError` returned to the response handler in the event of a file conflict.
`destination`	The file url of the desired download output location.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocExportResult object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsDownloadUrl:exportFormat:overwrite:destination:byteOffsetStart:byteOffsetEnd:

Deprecated

docsDownload is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBDownloadUrlTask<DBPAPERPaperDocExportResult *,
                             DBPAPERDocLookupError *> *)
    docsDownloadUrl:(nonnull NSString *)docId
       exportFormat:(nonnull DBPAPERExportFormat *)exportFormat
          overwrite:(BOOL)overwrite
        destination:(nonnull NSURL *)destination
    byteOffsetStart:(nonnull NSNumber *)byteOffsetStart
      byteOffsetEnd:(nonnull NSNumber *)byteOffsetEnd;

Swift

func docsDownloadUrl(_ docId: String, exportFormat: DBPAPERExportFormat, overwrite: Bool, destination: URL, byteOffsetStart: NSNumber, byteOffsetEnd: NSNumber) -> DBDownloadUrlTask<DBPAPERPaperDocExportResult, DBPAPERDocLookupError>

Parameters

`overwrite`	A boolean to set behavior in the event of a naming conflict. `YES` will overwrite conflicting file at destination. `NO` will take no action, resulting in an `NSError` returned to the response handler in the event of a file conflict.
`destination`	The file url of the desired download output location.
`byteOffsetStart`	For partial file download. Download file beginning from this starting byte position. Must include valid end range value.
`byteOffsetEnd`	For partial file download. Download file up until this ending byte position. Must include valid start range value.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocExportResult object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsDownloadData:exportFormat:

Deprecated

docsDownload is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBDownloadDataTask<DBPAPERPaperDocExportResult *,
                              DBPAPERDocLookupError *> *)
    docsDownloadData:(nonnull NSString *)docId
        exportFormat:(nonnull DBPAPERExportFormat *)exportFormat;

Swift

func docsDownloadData(_ docId: String, exportFormat: DBPAPERExportFormat) -> DBDownloadDataTask<DBPAPERPaperDocExportResult, DBPAPERDocLookupError>

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocExportResult object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsDownloadData:exportFormat:byteOffsetStart:byteOffsetEnd:

Deprecated

docsDownload is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBDownloadDataTask<DBPAPERPaperDocExportResult *,
                              DBPAPERDocLookupError *> *)
    docsDownloadData:(nonnull NSString *)docId
        exportFormat:(nonnull DBPAPERExportFormat *)exportFormat
     byteOffsetStart:(nonnull NSNumber *)byteOffsetStart
       byteOffsetEnd:(nonnull NSNumber *)byteOffsetEnd;

Swift

func docsDownloadData(_ docId: String, exportFormat: DBPAPERExportFormat, byteOffsetStart: NSNumber, byteOffsetEnd: NSNumber) -> DBDownloadDataTask<DBPAPERPaperDocExportResult, DBPAPERDocLookupError>

Parameters

`byteOffsetStart`	For partial file download. Download file beginning from this starting byte position. Must include valid end range value.
`byteOffsetEnd`	For partial file download. Download file up until this ending byte position. Must include valid start range value.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocExportResult object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsFolderUsersList:

Deprecated

docsFolderUsersList is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERListUsersOnFolderResponse *,
                     DBPAPERDocLookupError *> *)docsFolderUsersList:
    (nonnull NSString *)docId;

Swift

func docsFolderUsersList(_ docId: String) -> DBRpcTask<DBPAPERListUsersOnFolderResponse, DBPAPERDocLookupError>

Return Value

Through the response callback, the caller will receive a DBPAPERListUsersOnFolderResponse object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsFolderUsersList:limit:

Deprecated

docsFolderUsersList is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull
       DBRpcTask<DBPAPERListUsersOnFolderResponse *, DBPAPERDocLookupError *> *)
    docsFolderUsersList:(nonnull NSString *)docId
                  limit:(nullable NSNumber *)limit;

Swift

func docsFolderUsersList(_ docId: String, limit: NSNumber?) -> DBRpcTask<DBPAPERListUsersOnFolderResponse, DBPAPERDocLookupError>

Parameters


                                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.

Return Value

Through the response callback, the caller will receive a DBPAPERListUsersOnFolderResponse object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsFolderUsersListContinue:cursor:

Deprecated

docsFolderUsersListContinue is deprecated.

DEPRECATED: Once a cursor has been retrieved from docsFolderUsersList, 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERListUsersOnFolderResponse *,
                     DBPAPERListUsersCursorError *> *)
    docsFolderUsersListContinue:(nonnull NSString *)docId
                         cursor:(nonnull NSString *)cursor;

Swift

func docsFolderUsersListContinue(_ docId: String, cursor: String) -> DBRpcTask<DBPAPERListUsersOnFolderResponse, DBPAPERListUsersCursorError>

Parameters


                                cursor

The cursor obtained from docsFolderUsersList or docsFolderUsersListContinue. Allows for pagination.

Return Value

Through the response callback, the caller will receive a DBPAPERListUsersOnFolderResponse object on success or a DBPAPERListUsersCursorError object on failure.


                    
                    
                    -docsGetFolderInfo:

Deprecated

docsGetFolderInfo is deprecated.

DEPRECATED: 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. If the Paper doc is not in any folder (aka unfiled) the response will be empty. 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERFoldersContainingPaperDoc *,
                     DBPAPERDocLookupError *> *)docsGetFolderInfo:
    (nonnull NSString *)docId;

Swift

func docsGetFolderInfo(_ docId: String) -> DBRpcTask<DBPAPERFoldersContainingPaperDoc, DBPAPERDocLookupError>

Parameters


                                docId

The Paper doc ID.

Return Value

Through the response callback, the caller will receive a DBPAPERFoldersContainingPaperDoc object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsList

Deprecated

docsList is deprecated.

DEPRECATED: Return the list of all Paper docs according to the argument specifications. To iterate over through the full pagination, pass the cursor to docsListContinue. 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERListPaperDocsResponse *, DBNilObject *> *)docsList;

Swift

func docsList() -> DBRpcTask<DBPAPERListPaperDocsResponse, DBNilObject>

Return Value

Through the response callback, the caller will receive a DBPAPERListPaperDocsResponse object on success or a void object on failure.


                    
                    
                    -docsList:sortBy:sortOrder:limit:

Deprecated

docsList is deprecated.

DEPRECATED: Return the list of all Paper docs according to the argument specifications. To iterate over through the full pagination, pass the cursor to docsListContinue. 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERListPaperDocsResponse *, DBNilObject *> *)
     docsList:(nullable DBPAPERListPaperDocsFilterBy *)filterBy
       sortBy:(nullable DBPAPERListPaperDocsSortBy *)sortBy
    sortOrder:(nullable DBPAPERListPaperDocsSortOrder *)sortOrder
        limit:(nullable NSNumber *)limit;

Swift

func docsList(_ filterBy: DBPAPERListPaperDocsFilterBy?, sortBy: DBPAPERListPaperDocsSortBy?, sortOrder: DBPAPERListPaperDocsSortOrder?, limit: NSNumber?) -> DBRpcTask<DBPAPERListPaperDocsResponse, DBNilObject>

Parameters

`filterBy`	Allows user to specify how the Paper docs should be filtered.
`sortBy`	Allows user to specify how the Paper docs should be sorted.
`sortOrder`	Allows user to specify the sort order of the result.
`limit`	Size limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error.

Return Value

Through the response callback, the caller will receive a DBPAPERListPaperDocsResponse object on success or a void object on failure.


                    
                    
                    -docsListContinue:

Deprecated

docsListContinue is deprecated.

DEPRECATED: Once a cursor has been retrieved from docsList, 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERListPaperDocsResponse *,
                     DBPAPERListDocsCursorError *> *)docsListContinue:
    (nonnull NSString *)cursor;

Swift

func docsListContinue(_ cursor: String) -> DBRpcTask<DBPAPERListPaperDocsResponse, DBPAPERListDocsCursorError>

Parameters


                                cursor

The cursor obtained from docsList or docsListContinue. Allows for pagination.

Return Value

Through the response callback, the caller will receive a DBPAPERListPaperDocsResponse object on success or a DBPAPERListDocsCursorError object on failure.


                    
                    
                    -docsPermanentlyDelete:

Deprecated

docsPermanentlyDelete is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBPAPERDocLookupError *> *)
    docsPermanentlyDelete:(nonnull NSString *)docId;

Swift

func docsPermanentlyDelete(_ docId: String) -> DBRpcTask<DBNilObject, DBPAPERDocLookupError>

Parameters


                                docId

The Paper doc ID.

Return Value

Through the response callback, the caller will receive a void object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsSharingPolicyGet:

Deprecated

docsSharingPolicyGet is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERSharingPolicy *, DBPAPERDocLookupError *> *)
    docsSharingPolicyGet:(nonnull NSString *)docId;

Swift

func docsSharingPolicyGet(_ docId: String) -> DBRpcTask<DBPAPERSharingPolicy, DBPAPERDocLookupError>

Parameters


                                docId

The Paper doc ID.

Return Value

Through the response callback, the caller will receive a DBPAPERSharingPolicy object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsSharingPolicySet:sharingPolicy:

Deprecated

docsSharingPolicySet is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBPAPERDocLookupError *> *)
    docsSharingPolicySet:(nonnull NSString *)docId
           sharingPolicy:(nonnull DBPAPERSharingPolicy *)sharingPolicy;

Swift

func docsSharingPolicySet(_ docId: String, sharingPolicy: DBPAPERSharingPolicy) -> DBRpcTask<DBNilObject, DBPAPERDocLookupError>

Parameters


                                sharingPolicy

The default sharing policy to be set for the Paper doc.

Return Value

Through the response callback, the caller will receive a void object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsUpdateUrl:docUpdatePolicy:revision:importFormat:inputUrl:

Deprecated

docsUpdate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for more information.

Declaration

Objective-C

- (nonnull DBUploadTask<DBPAPERPaperDocCreateUpdateResult *,
                        DBPAPERPaperDocUpdateError *> *)
      docsUpdateUrl:(nonnull NSString *)docId
    docUpdatePolicy:(nonnull DBPAPERPaperDocUpdatePolicy *)docUpdatePolicy
           revision:(nonnull NSNumber *)revision
       importFormat:(nonnull DBPAPERImportFormat *)importFormat
           inputUrl:(nonnull NSString *)inputUrl;

Swift

func docsUpdateUrl(_ docId: String, docUpdatePolicy: DBPAPERPaperDocUpdatePolicy, revision: NSNumber, importFormat: DBPAPERImportFormat, inputUrl: String) -> DBUploadTask<DBPAPERPaperDocCreateUpdateResult, DBPAPERPaperDocUpdateError>

Parameters

`docUpdatePolicy`	The policy used for the current update call.
`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.
`inputUrl`	The file to upload, as an NSString * object.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocCreateUpdateResult object on success or a DBPAPERPaperDocUpdateError object on failure.


                    
                    
                    -docsUpdateData:docUpdatePolicy:revision:importFormat:inputData:

Deprecated

docsUpdate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for more information.

Declaration

Objective-C

- (nonnull DBUploadTask<DBPAPERPaperDocCreateUpdateResult *,
                        DBPAPERPaperDocUpdateError *> *)
     docsUpdateData:(nonnull NSString *)docId
    docUpdatePolicy:(nonnull DBPAPERPaperDocUpdatePolicy *)docUpdatePolicy
           revision:(nonnull NSNumber *)revision
       importFormat:(nonnull DBPAPERImportFormat *)importFormat
          inputData:(nonnull NSData *)inputData;

Swift

func docsUpdateData(_ docId: String, docUpdatePolicy: DBPAPERPaperDocUpdatePolicy, revision: NSNumber, importFormat: DBPAPERImportFormat, inputData: Data) -> DBUploadTask<DBPAPERPaperDocCreateUpdateResult, DBPAPERPaperDocUpdateError>

Parameters

`docUpdatePolicy`	The policy used for the current update call.
`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.
`inputData`	The file to upload, as an NSData * object.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocCreateUpdateResult object on success or a DBPAPERPaperDocUpdateError object on failure.


                    
                    
                    -docsUpdateStream:docUpdatePolicy:revision:importFormat:inputStream:

Deprecated

docsUpdate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for more information.

Declaration

Objective-C

- (nonnull DBUploadTask<DBPAPERPaperDocCreateUpdateResult *,
                        DBPAPERPaperDocUpdateError *> *)
    docsUpdateStream:(nonnull NSString *)docId
     docUpdatePolicy:(nonnull DBPAPERPaperDocUpdatePolicy *)docUpdatePolicy
            revision:(nonnull NSNumber *)revision
        importFormat:(nonnull DBPAPERImportFormat *)importFormat
         inputStream:(nonnull NSInputStream *)inputStream;

Swift

func docsUpdateStream(_ docId: String, docUpdatePolicy: DBPAPERPaperDocUpdatePolicy, revision: NSNumber, importFormat: DBPAPERImportFormat, inputStream: InputStream) -> DBUploadTask<DBPAPERPaperDocCreateUpdateResult, DBPAPERPaperDocUpdateError>

Parameters

`docUpdatePolicy`	The policy used for the current update call.
`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.
`inputStream`	The file to upload, as an NSInputStream * object.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperDocCreateUpdateResult object on success or a DBPAPERPaperDocUpdateError object on failure.


                    
                    
                    -docsUsersAdd:members:

Deprecated

docsUsersAdd is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBPAPERAddPaperDocUserMemberResult *> *,
                     DBPAPERDocLookupError *> *)
    docsUsersAdd:(nonnull NSString *)docId
         members:(nonnull NSArray<DBPAPERAddMember *> *)members;

Swift

func docsUsersAdd(_ docId: String, members: [DBPAPERAddMember]) -> DBRpcTask<NSArray, DBPAPERDocLookupError>

Parameters


                                members

User which should be added to the Paper doc. Specify only email address or Dropbox account ID.

Return Value

Through the response callback, the caller will receive a NSArray<DBPAPERAddPaperDocUserMemberResult *> object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsUsersAdd:members:customMessage:quiet:

Deprecated

docsUsersAdd is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBPAPERAddPaperDocUserMemberResult *> *,
                     DBPAPERDocLookupError *> *)
     docsUsersAdd:(nonnull NSString *)docId
          members:(nonnull NSArray<DBPAPERAddMember *> *)members
    customMessage:(nullable NSString *)customMessage
            quiet:(nullable NSNumber *)quiet;

Swift

func docsUsersAdd(_ docId: String, members: [DBPAPERAddMember], customMessage: String?, quiet: NSNumber?) -> DBRpcTask<NSArray, DBPAPERDocLookupError>

Parameters

`members`	User which should be added to the Paper doc. Specify only email address or Dropbox account ID.
`customMessage`	A personal message that will be emailed to each successfully added member.
`quiet`	Clients should set this to true if no email message shall be sent to added users.

Return Value

Through the response callback, the caller will receive a NSArray<DBPAPERAddPaperDocUserMemberResult *> object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsUsersList:

Deprecated

docsUsersList is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERListUsersOnPaperDocResponse *,
                     DBPAPERDocLookupError *> *)docsUsersList:
    (nonnull NSString *)docId;

Swift

func docsUsersList(_ docId: String) -> DBRpcTask<DBPAPERListUsersOnPaperDocResponse, DBPAPERDocLookupError>

Return Value

Through the response callback, the caller will receive a DBPAPERListUsersOnPaperDocResponse object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsUsersList:limit:filterBy:

Deprecated

docsUsersList is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERListUsersOnPaperDocResponse *,
                     DBPAPERDocLookupError *> *)
    docsUsersList:(nonnull NSString *)docId
            limit:(nullable NSNumber *)limit
         filterBy:(nullable DBPAPERUserOnPaperDocFilter *)filterBy;

Swift

func docsUsersList(_ docId: String, limit: NSNumber?, filterBy: DBPAPERUserOnPaperDocFilter?) -> DBRpcTask<DBPAPERListUsersOnPaperDocResponse, DBPAPERDocLookupError>

Parameters

`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.
`filterBy`	Specify this attribute if you want to obtain users that have already accessed the Paper doc.

Return Value

Through the response callback, the caller will receive a DBPAPERListUsersOnPaperDocResponse object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -docsUsersListContinue:cursor:

Deprecated

docsUsersListContinue is deprecated.

DEPRECATED: Once a cursor has been retrieved from docsUsersList, 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERListUsersOnPaperDocResponse *,
                     DBPAPERListUsersCursorError *> *)
    docsUsersListContinue:(nonnull NSString *)docId
                   cursor:(nonnull NSString *)cursor;

Swift

func docsUsersListContinue(_ docId: String, cursor: String) -> DBRpcTask<DBPAPERListUsersOnPaperDocResponse, DBPAPERListUsersCursorError>

Parameters


                                cursor

The cursor obtained from docsUsersList or docsUsersListContinue. Allows for pagination.

Return Value

Through the response callback, the caller will receive a DBPAPERListUsersOnPaperDocResponse object on success or a DBPAPERListUsersCursorError object on failure.


                    
                    
                    -docsUsersRemove:member:

Deprecated

docsUsersRemove is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBPAPERDocLookupError *> *)
    docsUsersRemove:(nonnull NSString *)docId
             member:(nonnull DBSHARINGMemberSelector *)member;

Swift

func docsUsersRemove(_ docId: String, member: DBSHARINGMemberSelector) -> DBRpcTask<DBNilObject, DBPAPERDocLookupError>

Parameters


                                member

User which should be removed from the Paper doc. Specify only email address or Dropbox account ID.

Return Value

Through the response callback, the caller will receive a void object on success or a DBPAPERDocLookupError object on failure.


                    
                    
                    -foldersCreate:

Deprecated

foldersCreate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERPaperFolderCreateResult *,
                     DBPAPERPaperFolderCreateError *> *)foldersCreate:
    (nonnull NSString *)name;

Swift

func foldersCreate(_ name: String) -> DBRpcTask<DBPAPERPaperFolderCreateResult, DBPAPERPaperFolderCreateError>

Parameters


                                name

The name of the new Paper folder.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperFolderCreateResult object on success or a DBPAPERPaperFolderCreateError object on failure.


                    
                    
                    -foldersCreate:parentFolderId:isTeamFolder:

Deprecated

foldersCreate is deprecated.

DEPRECATED: 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 https://www.dropbox.com/lp/developers/reference/paper-migration-guide for migration information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBPAPERPaperFolderCreateResult *,
                     DBPAPERPaperFolderCreateError *> *)
     foldersCreate:(nonnull NSString *)name
    parentFolderId:(nullable NSString *)parentFolderId
      isTeamFolder:(nullable NSNumber *)isTeamFolder;

Swift

func foldersCreate(_ name: String, parentFolderId: String?, isTeamFolder: NSNumber?) -> DBRpcTask<DBPAPERPaperFolderCreateResult, DBPAPERPaperFolderCreateError>

Parameters

`name`	The name of the new Paper folder.
`parentFolderId`	The encrypted Paper folder Id where the new Paper folder should be created. The API user has to have write access to this folder or error is thrown. If not supplied, the new folder will be created at top level.
`isTeamFolder`	Whether the folder to be created should be a team folder. This value will be ignored if parent_folder_id is supplied, as the new folder will inherit the type (private or team folder) from its parent. We will by default create a top-level private folder if both parent_folder_id and is_team_folder are not supplied.

Return Value

Through the response callback, the caller will receive a DBPAPERPaperFolderCreateResult object on success or a DBPAPERPaperFolderCreateError object on failure.