com.google.api.services.drive

Class Drive.Approvals

java.lang.Object

com.google.api.services.drive.Drive.Approvals

Enclosing class:

Drive

public class Drive.Approvals
extends Object

The "approvals" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Drive.Approvals.Approve
class	Drive.Approvals.Cancel
class	Drive.Approvals.Comment
class	Drive.Approvals.Decline
class	Drive.Approvals.Get
class	Drive.Approvals.List
class	Drive.Approvals.Reassign
class	Drive.Approvals.Start

Constructor Summary

Constructors

Constructor and Description
Approvals()

Method Summary

Modifier and Type	Method and Description
Drive.Approvals.Approve	approve(String fileId, String approvalId, ApproveApprovalRequest content) Approves an approval.
Drive.Approvals.Cancel	cancel(String fileId, String approvalId, CancelApprovalRequest content) Cancels an approval.
Drive.Approvals.Comment	comment(String fileId, String approvalId, CommentApprovalRequest content) Comments on an approval.
Drive.Approvals.Decline	decline(String fileId, String approvalId, DeclineApprovalRequest content) Declines an approval.
Drive.Approvals.Get	get(String fileId, String approvalId) Gets an approval by ID.
Drive.Approvals.List	list(String fileId) Lists the approvals on a file.
Drive.Approvals.Reassign	reassign(String fileId, String approvalId, ReassignApprovalRequest content) Reassigns the reviewers on an approval.
Drive.Approvals.Start	start(String fileId, StartApprovalRequest content) Starts an approval on a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

Approvals

public Approvals()

Method Detail

approve

public Drive.Approvals.Approve approve(String fileId,
                                       String approvalId,
                                       ApproveApprovalRequest content)
                                throws IOException

Approves an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `APPROVED`. If this is the last required reviewer response, this also completes the approval and sets the approval Status to `APPROVED`. Create a request for the method "approvals.approve". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - Required. The ID of the file that the approval is on.

approvalId - Required. The ID of the approval to approve.

content - the ApproveApprovalRequest

Returns:

the request

Throws:

IOException

cancel

public Drive.Approvals.Cancel cancel(String fileId,
                                     String approvalId,
                                     CancelApprovalRequest content)
                              throws IOException

Cancels an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Updates the approval Status to `CANCELLED`. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS`. Create a request for the method "approvals.cancel". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - Required. The ID of the file that the approval is on.

approvalId - Required. The ID of the approval to cancel.

content - the CancelApprovalRequest

Returns:

the request

Throws:

IOException

comment

public Drive.Approvals.Comment comment(String fileId,
                                       String approvalId,
                                       CommentApprovalRequest content)
                                throws IOException

Comments on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This sends a notification to both the initiator and the reviewers. Additionally, a message is also added to the approval activity log. Create a request for the method "approvals.comment". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - Required. The ID of the file that the approval is on.

approvalId - Required. The ID of the approval to comment on.

content - the CommentApprovalRequest

Returns:

the request

Throws:

IOException

decline

public Drive.Approvals.Decline decline(String fileId,
                                       String approvalId,
                                       DeclineApprovalRequest content)
                                throws IOException

Declines an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). This is used to update the ReviewerResponse of the requesting user with a Response of `DECLINED`. This also completes the approval and sets the approval Status to `DECLINED`. Create a request for the method "approvals.decline". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - Required. The ID of the file that the approval is on.

approvalId - Required. The ID of the approval to decline.

content - the DeclineApprovalRequest

Returns:

the request

Throws:

IOException

get

public Drive.Approvals.Get get(String fileId,
                               String approvalId)
                        throws IOException

Gets an approval by ID. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Create a request for the method "approvals.get". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - Required. The ID of the file that the approval is on.

approvalId - Required. The ID of the approval.

Returns:

the request

Throws:

IOException

list

public Drive.Approvals.List list(String fileId)
                          throws IOException

Lists the approvals on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Create a request for the method "approvals.list". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - Required. The ID of the file that the approval is on.

Returns:

the request

Throws:

IOException

reassign

public Drive.Approvals.Reassign reassign(String fileId,
                                         String approvalId,
                                         ReassignApprovalRequest content)
                                  throws IOException

Reassigns the reviewers on an approval. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Adds or replaces reviewers in the ReviewerResponse of the approval. This can be called by any user with the `writer` permission on the file while the approval Status is `IN_PROGRESS` and the Response for the reviewer being reassigned is `NO_RESPONSE`. A user with the `reader` permission can only reassign an approval that's assigned to themselves. Removing a reviewer isn't allowed. Create a request for the method "approvals.reassign". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - Required. The ID of the file that the approval is on.

approvalId - Required. The ID of the approval to reassign.

content - the ReassignApprovalRequest

Returns:

the request

Throws:

IOException

start

public Drive.Approvals.Start start(String fileId,
                                   StartApprovalRequest content)
                            throws IOException

Starts an approval on a file. For more information, see [Manage approvals](https://developers.google.com/workspace/drive/api/guides/approvals). Create a request for the method "approvals.start". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - Required. The ID of the file that the approval is created on.

content - the StartApprovalRequest

Returns:

the request

Throws:

IOException