WorkDocsClient Class

Member Function Documentation

WorkDocsClient::WorkDocsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a WorkDocsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

WorkDocsClient::WorkDocsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads WorkDocsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AbortDocumentVersionUploadResponse *WorkDocsClient::abortDocumentVersionUpload(const AbortDocumentVersionUploadRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an AbortDocumentVersionUploadResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Aborts the upload of the specified document version that was previously initiated by <a>InitiateDocumentVersionUpload</a>. The client should make this call only when it no longer intends to upload the document version, or fails to do

[slot] ActivateUserResponse *WorkDocsClient::activateUser(const ActivateUserRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an ActivateUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Activates the specified user. Only active users can access Amazon

[slot] AddResourcePermissionsResponse *WorkDocsClient::addResourcePermissions(const AddResourcePermissionsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an AddResourcePermissionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different

[slot] CreateCommentResponse *WorkDocsClient::createComment(const CreateCommentRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an CreateCommentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds a new comment to the specified document

[slot] CreateCustomMetadataResponse *WorkDocsClient::createCustomMetadata(const CreateCustomMetadataRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an CreateCustomMetadataResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds one or more custom properties to the specified resource (a folder, document, or

[slot] CreateFolderResponse *WorkDocsClient::createFolder(const CreateFolderRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an CreateFolderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a folder with the specified name and parent

[slot] CreateLabelsResponse *WorkDocsClient::createLabels(const CreateLabelsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an CreateLabelsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds the specified list of labels to the given resource (a document or

[slot] CreateNotificationSubscriptionResponse *WorkDocsClient::createNotificationSubscription(const CreateNotificationSubscriptionRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an CreateNotificationSubscriptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Configure WorkDocs to use Amazon SNS

notifications>

The endpoint receives a confirmation message, and must confirm the subscription. For more information, see <a href="http://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.html#SendMessageToHttp.confirm">Confirm the Subscription</a> in the <i>Amazon Simple Notification Service Developer

[slot] CreateUserResponse *WorkDocsClient::createUser(const CreateUserRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an CreateUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon

[slot] DeactivateUserResponse *WorkDocsClient::deactivateUser(const DeactivateUserRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DeactivateUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deactivates the specified user, which revokes the user's access to Amazon

[slot] DeleteCommentResponse *WorkDocsClient::deleteComment(const DeleteCommentRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DeleteCommentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified comment from the document

[slot] DeleteCustomMetadataResponse *WorkDocsClient::deleteCustomMetadata(const DeleteCustomMetadataRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DeleteCustomMetadataResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes custom metadata from the specified

[slot] DeleteDocumentResponse *WorkDocsClient::deleteDocument(const DeleteDocumentRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DeleteDocumentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Permanently deletes the specified document and its associated

[slot] DeleteFolderResponse *WorkDocsClient::deleteFolder(const DeleteFolderRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DeleteFolderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Permanently deletes the specified folder and its

[slot] DeleteFolderContentsResponse *WorkDocsClient::deleteFolderContents(const DeleteFolderContentsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DeleteFolderContentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the contents of the specified

[slot] DeleteLabelsResponse *WorkDocsClient::deleteLabels(const DeleteLabelsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DeleteLabelsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified list of labels from a

[slot] DeleteNotificationSubscriptionResponse *WorkDocsClient::deleteNotificationSubscription(const DeleteNotificationSubscriptionRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DeleteNotificationSubscriptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified subscription from the specified

[slot] DeleteUserResponse *WorkDocsClient::deleteUser(const DeleteUserRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DeleteUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified user from a Simple AD or Microsoft AD

[slot] DescribeActivitiesResponse *WorkDocsClient::describeActivities(const DescribeActivitiesRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DescribeActivitiesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the user activities in a specified time

[slot] DescribeCommentsResponse *WorkDocsClient::describeComments(const DescribeCommentsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DescribeCommentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

List all the comments for the specified document

[slot] DescribeDocumentVersionsResponse *WorkDocsClient::describeDocumentVersions(const DescribeDocumentVersionsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DescribeDocumentVersionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the document versions for the specified

document>

By default, only active versions are

[slot] DescribeFolderContentsResponse *WorkDocsClient::describeFolderContents(const DescribeFolderContentsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DescribeFolderContentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the contents of the specified folder, including its documents and

subfolders>

By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized

[slot] DescribeGroupsResponse *WorkDocsClient::describeGroups(const DescribeGroupsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DescribeGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the groups specified by

[slot] DescribeNotificationSubscriptionsResponse *WorkDocsClient::describeNotificationSubscriptions(const DescribeNotificationSubscriptionsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DescribeNotificationSubscriptionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the specified notification

[slot] DescribeResourcePermissionsResponse *WorkDocsClient::describeResourcePermissions(const DescribeResourcePermissionsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DescribeResourcePermissionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the permissions of a specified

[slot] DescribeRootFoldersResponse *WorkDocsClient::describeRootFolders(const DescribeRootFoldersRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DescribeRootFoldersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the current user's special folders; the <code>RootFolder</code> and the <code>RecycleBin</code>. <code>RootFolder</code> is the root of user's files and folders and <code>RecycleBin</code> is the root of recycled items. This is not a valid action for SigV4 (administrative API)

[slot] DescribeUsersResponse *WorkDocsClient::describeUsers(const DescribeUsersRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an DescribeUsersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the specified users. You can describe all users or filter the results (for example, by status or

organization)>

By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of

[slot] GetCurrentUserResponse *WorkDocsClient::getCurrentUser(const GetCurrentUserRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an GetCurrentUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API)

[slot] GetDocumentResponse *WorkDocsClient::getDocument(const GetDocumentRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an GetDocumentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves details of a

[slot] GetDocumentPathResponse *WorkDocsClient::getDocumentPath(const GetDocumentPathRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an GetDocumentPathResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the path information (the hierarchy from the root folder) for the requested

document>

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent

[slot] GetDocumentVersionResponse *WorkDocsClient::getDocumentVersion(const GetDocumentVersionRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an GetDocumentVersionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves version metadata for the specified

[slot] GetFolderResponse *WorkDocsClient::getFolder(const GetFolderRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an GetFolderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the metadata of the specified

[slot] GetFolderPathResponse *WorkDocsClient::getFolderPath(const GetFolderPathRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an GetFolderPathResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the path information (the hierarchy from the root folder) for the specified

folder>

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder

[slot] InitiateDocumentVersionUploadResponse *WorkDocsClient::initiateDocumentVersionUpload(const InitiateDocumentVersionUploadRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an InitiateDocumentVersionUploadResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new document object and version

object>

The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call

<a>UpdateDocumentVersion</a>>

To cancel the document upload, call

[slot] RemoveAllResourcePermissionsResponse *WorkDocsClient::removeAllResourcePermissions(const RemoveAllResourcePermissionsRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an RemoveAllResourcePermissionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes all the permissions from the specified

[slot] RemoveResourcePermissionResponse *WorkDocsClient::removeResourcePermission(const RemoveResourcePermissionRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an RemoveResourcePermissionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes the permission for the specified principal from the specified

[slot] UpdateDocumentResponse *WorkDocsClient::updateDocument(const UpdateDocumentRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an UpdateDocumentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if

[slot] UpdateDocumentVersionResponse *WorkDocsClient::updateDocumentVersion(const UpdateDocumentVersionRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an UpdateDocumentVersionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Changes the status of the document version to ACTIVE.

</p

Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by <a>InitiateDocumentVersionUpload</a>.

[slot] UpdateFolderResponse *WorkDocsClient::updateFolder(const UpdateFolderRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an UpdateFolderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if

[slot] UpdateUserResponse *WorkDocsClient::updateUser(const UpdateUserRequest &request)

Sends request to the WorkDocsClient service, and returns a pointer to an UpdateUserResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs