module:api/WorkspacesApi

module:api/WorkspacesApi

new module:api/WorkspacesApi(apiClient)

Source:

Constructs a new WorkspacesApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use,
default to module:ApiClient#instance if unspecified.

Methods

createWorkspace(accountId, optsOrCallback, callback)

Source:

Create a Workspace
Creates a new workspace.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
workspace module:model/Workspace
callback module:api/WorkspacesApi~createWorkspaceCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Workspace

createWorkspaceFile(accountId, workspaceId, folderId, callback)

Source:

Creates a workspace file.
This method adds a file to a workspace.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
workspaceId String

Specifies the workspace ID GUID.
folderId String

The ID of the folder being accessed.
callback module:api/WorkspacesApi~createWorkspaceFileCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/WorkspaceItem

deleteWorkspace(accountId, workspaceId, callback)

Source:

Delete Workspace
Deletes an existing workspace (logically).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
workspaceId String

Specifies the workspace ID GUID.
callback module:api/WorkspacesApi~deleteWorkspaceCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Workspace

deleteWorkspaceFolderItems(accountId, workspaceId, folderId, optsOrCallback, callback)

Source:

Deletes workspace one or more specific files/folders from the given folder or root.
This method deletes one or more files or sub-folders from a workspace folder or root.

Note: To delete items from a workspace, the status of the workspace must be active.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
workspaceId String

Specifies the workspace ID GUID.
folderId String

The ID of the folder being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
workspaceItemList module:model/WorkspaceItemList
callback module:api/WorkspacesApi~deleteWorkspaceFolderItemsCallback

The callback function, accepting three arguments: error, data, response

getWorkspace(accountId, workspaceId, callback)

Source:

Get Workspace
Retrives properties about a workspace given a unique workspaceId.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
workspaceId String

Specifies the workspace ID GUID.
callback module:api/WorkspacesApi~getWorkspaceCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Workspace

getWorkspaceFile(accountId, workspaceId, folderId, fileId, optsOrCallback, callback)

Source:

Get Workspace File
Retrieves a workspace file (the binary).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
workspaceId String

Specifies the workspace ID GUID.
folderId String

The ID of the folder being accessed.
fileId String

Specifies the room file ID GUID.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
isDownload String

When set to true, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. Default is false.
pdfVersion String

When set to true the file returned as a PDF.
callback module:api/WorkspacesApi~getWorkspaceFileCallback

The callback function, accepting three arguments: error, data, response

listWorkspaceFilePages(accountId, workspaceId, folderId, fileId, optsOrCallback, callback)

Source:

List File Pages
Retrieves a workspace file as rasterized pages.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
workspaceId String

Specifies the workspace ID GUID.
folderId String

The ID of the folder being accessed.
fileId String

Specifies the room file ID GUID.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
count String

The maximum number of results to be returned by this request.
dpi String

Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.
maxHeight String

Sets the maximum height (in pixels) of the returned image.
maxWidth String

Sets the maximum width (in pixels) of the returned image.
startPosition String

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
callback module:api/WorkspacesApi~listWorkspaceFilePagesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PageImages

listWorkspaceFolderItems(accountId, workspaceId, folderId, optsOrCallback, callback)

Source:

List Workspace Folder Contents
Retrieves workspace folder contents, which can include sub folders and files.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
workspaceId String

Specifies the workspace ID GUID.
folderId String

The ID of the folder being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
count String

The maximum number of results to be returned by this request.
includeFiles String

When set to true, file information is returned in the response along with folder information. The default is false.
includeSubFolders String

When set to true, information about the sub-folders of the current folder is returned. The default is false.
includeThumbnails String

When set to true, thumbnails are returned as part of the response. The default is false.
includeUserDetail String

Set to true to return extended details about the user. The default is false.
startPosition String

The position within the total result set from which to start returning values.
workspaceUserId String

If set, then the results are filtered to those associated with the specified userId.
callback module:api/WorkspacesApi~listWorkspaceFolderItemsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/WorkspaceFolderContents

listWorkspaces(accountId, callback)

Source:

List Workspaces
Gets information about the Workspaces that have been created.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/WorkspacesApi~listWorkspacesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/WorkspaceList

updateWorkspace(accountId, workspaceId, optsOrCallback, callback)

Source:

Update Workspace
Updates information about a specific workspace.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
workspaceId String

Specifies the workspace ID GUID.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
workspace module:model/Workspace
callback module:api/WorkspacesApi~updateWorkspaceCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Workspace

updateWorkspaceFile(accountId, workspaceId, folderId, fileId, callback)

Source:

Update Workspace File Metadata
Updates workspace item metadata for one or more specific files/folders.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
workspaceId String

Specifies the workspace ID GUID.
folderId String

The ID of the folder being accessed.
fileId String

Specifies the room file ID GUID.
callback module:api/WorkspacesApi~updateWorkspaceFileCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/WorkspaceItem

Type Definitions

createWorkspaceCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createWorkspace operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Workspace

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createWorkspaceFileCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createWorkspaceFile operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/WorkspaceItem

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteWorkspaceCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteWorkspace operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Workspace

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteWorkspaceFolderItemsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteWorkspaceFolderItems operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getWorkspaceCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getWorkspace operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Workspace

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getWorkspaceFileCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getWorkspaceFile operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listWorkspaceFilePagesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listWorkspaceFilePages operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/PageImages

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listWorkspaceFolderItemsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listWorkspaceFolderItems operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/WorkspaceFolderContents

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listWorkspacesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listWorkspaces operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/WorkspaceList

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateWorkspaceCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateWorkspace operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Workspace

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateWorkspaceFileCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateWorkspaceFile operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/WorkspaceItem

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.