public class WorkspacesApi extends Object
| Modifier and Type | Class and Description |
|---|---|
class |
WorkspacesApi.GetWorkspaceFileOptions |
class |
WorkspacesApi.ListWorkspaceFilePagesOptions |
class |
WorkspacesApi.ListWorkspaceFolderItemsOptions |
| Constructor and Description |
|---|
WorkspacesApi() |
WorkspacesApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
Workspace |
createWorkspace(String accountId,
Workspace workspace)
Create a Workspace
Creates a new workspace.
|
WorkspaceItem |
createWorkspaceFile(String accountId,
String workspaceId,
String folderId)
Creates a workspace file.
|
Workspace |
deleteWorkspace(String accountId,
String workspaceId)
Delete Workspace
Deletes an existing workspace (logically).
|
void |
deleteWorkspaceFolderItems(String accountId,
String workspaceId,
String folderId,
WorkspaceItemList workspaceItemList)
Deletes workspace one or more specific files/folders from the given folder or root.
|
ApiClient |
getApiClient() |
Workspace |
getWorkspace(String accountId,
String workspaceId)
Get Workspace
Retrives properties about a workspace given a unique workspaceId.
|
void |
getWorkspaceFile(String accountId,
String workspaceId,
String folderId,
String fileId)
Get Workspace File
Retrieves a workspace file (the binary).
|
void |
getWorkspaceFile(String accountId,
String workspaceId,
String folderId,
String fileId,
WorkspacesApi.GetWorkspaceFileOptions options)
Get Workspace File
Retrieves a workspace file (the binary).
|
PageImages |
listWorkspaceFilePages(String accountId,
String workspaceId,
String folderId,
String fileId)
List File Pages
Retrieves a workspace file as rasterized pages.
|
PageImages |
listWorkspaceFilePages(String accountId,
String workspaceId,
String folderId,
String fileId,
WorkspacesApi.ListWorkspaceFilePagesOptions options)
List File Pages
Retrieves a workspace file as rasterized pages.
|
WorkspaceFolderContents |
listWorkspaceFolderItems(String accountId,
String workspaceId,
String folderId)
List Workspace Folder Contents
Retrieves workspace folder contents, which can include sub folders and files.
|
WorkspaceFolderContents |
listWorkspaceFolderItems(String accountId,
String workspaceId,
String folderId,
WorkspacesApi.ListWorkspaceFolderItemsOptions options)
List Workspace Folder Contents
Retrieves workspace folder contents, which can include sub folders and files.
|
WorkspaceList |
listWorkspaces(String accountId)
List Workspaces
Gets information about the Workspaces that have been created.
|
void |
setApiClient(ApiClient apiClient) |
Workspace |
updateWorkspace(String accountId,
String workspaceId,
Workspace workspace)
Update Workspace
Updates information about a specific workspace.
|
WorkspaceItem |
updateWorkspaceFile(String accountId,
String workspaceId,
String folderId,
String fileId)
Update Workspace File Metadata
Updates workspace item metadata for one or more specific files/folders.
|
public WorkspacesApi()
public WorkspacesApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public WorkspaceList listWorkspaces(String accountId) throws ApiException
accountId - The external account number (int) or account ID Guid.WorkspacesApi.ListWorkspacesOptions - Options for modifying the method behavior.ApiExceptionpublic Workspace createWorkspace(String accountId, Workspace workspace) throws ApiException
accountId - The external account number (int) or account ID Guid.WorkspacesApi.CreateWorkspaceOptions - Options for modifying the method behavior.ApiExceptionpublic Workspace getWorkspace(String accountId, String workspaceId) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.WorkspacesApi.GetWorkspaceOptions - Options for modifying the method behavior.ApiExceptionpublic Workspace updateWorkspace(String accountId, String workspaceId, Workspace workspace) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.WorkspacesApi.UpdateWorkspaceOptions - Options for modifying the method behavior.ApiExceptionpublic Workspace deleteWorkspace(String accountId, String workspaceId) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.WorkspacesApi.DeleteWorkspaceOptions - Options for modifying the method behavior.ApiExceptionpublic WorkspaceFolderContents listWorkspaceFolderItems(String accountId, String workspaceId, String folderId) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.folderId - The ID of the folder being accessed.ApiExceptionpublic WorkspaceFolderContents listWorkspaceFolderItems(String accountId, String workspaceId, String folderId, WorkspacesApi.ListWorkspaceFolderItemsOptions options) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.folderId - The ID of the folder being accessed.WorkspacesApi.ListWorkspaceFolderItemsOptions - Options for modifying the method behavior.ApiExceptionpublic void deleteWorkspaceFolderItems(String accountId, String workspaceId, String folderId, WorkspaceItemList workspaceItemList) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.folderId - The ID of the folder being accessed.WorkspacesApi.DeleteWorkspaceFolderItemsOptions - Options for modifying the method behavior.ApiExceptionpublic WorkspaceItem createWorkspaceFile(String accountId, String workspaceId, String folderId) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.folderId - The ID of the folder being accessed.WorkspacesApi.CreateWorkspaceFileOptions - Options for modifying the method behavior.ApiExceptionpublic void getWorkspaceFile(String accountId, String workspaceId, String folderId, String fileId) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.folderId - The ID of the folder being accessed.fileId - Specifies the room file ID GUID.ApiExceptionpublic void getWorkspaceFile(String accountId, String workspaceId, String folderId, String fileId, WorkspacesApi.GetWorkspaceFileOptions options) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.folderId - The ID of the folder being accessed.fileId - Specifies the room file ID GUID.WorkspacesApi.GetWorkspaceFileOptions - Options for modifying the method behavior.ApiExceptionpublic WorkspaceItem updateWorkspaceFile(String accountId, String workspaceId, String folderId, String fileId) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.folderId - The ID of the folder being accessed.fileId - Specifies the room file ID GUID.WorkspacesApi.UpdateWorkspaceFileOptions - Options for modifying the method behavior.ApiExceptionpublic PageImages listWorkspaceFilePages(String accountId, String workspaceId, String folderId, String fileId) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.folderId - The ID of the folder being accessed.fileId - Specifies the room file ID GUID.ApiExceptionpublic PageImages listWorkspaceFilePages(String accountId, String workspaceId, String folderId, String fileId, WorkspacesApi.ListWorkspaceFilePagesOptions options) throws ApiException
accountId - The external account number (int) or account ID Guid.workspaceId - Specifies the workspace ID GUID.folderId - The ID of the folder being accessed.fileId - Specifies the room file ID GUID.WorkspacesApi.ListWorkspaceFilePagesOptions - Options for modifying the method behavior.ApiExceptionCopyright © 2017. All rights reserved.