Show / Hide Table of Contents

Class ApprovalsResource

The "approvals" collection of methods.

Inheritance
object
ApprovalsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Drive.v3
Assembly: Google.Apis.Drive.v3.dll
Syntax
public class ApprovalsResource

Constructors

ApprovalsResource(IClientService)

Constructs a new resource.

Declaration
public ApprovalsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Approve(ApproveApprovalRequest, string, string)

Approves an approval. For more information, see Manage 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.

Declaration
public virtual ApprovalsResource.ApproveRequest Approve(ApproveApprovalRequest body, string fileId, string approvalId)
Parameters
Type Name Description
ApproveApprovalRequest body

The body of the request.

string fileId

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

string approvalId

Required. The ID of the approval to approve.

Returns
Type Description
ApprovalsResource.ApproveRequest

Cancel(CancelApprovalRequest, string, string)

Cancels an approval. For more information, see Manage 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.

Declaration
public virtual ApprovalsResource.CancelRequest Cancel(CancelApprovalRequest body, string fileId, string approvalId)
Parameters
Type Name Description
CancelApprovalRequest body

The body of the request.

string fileId

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

string approvalId

Required. The ID of the approval to cancel.

Returns
Type Description
ApprovalsResource.CancelRequest

Comment(CommentApprovalRequest, string, string)

Comments on an approval. For more information, see Manage approvals. This sends a notification to both the initiator and the reviewers. Additionally, a message is also added to the approval activity log.

Declaration
public virtual ApprovalsResource.CommentRequest Comment(CommentApprovalRequest body, string fileId, string approvalId)
Parameters
Type Name Description
CommentApprovalRequest body

The body of the request.

string fileId

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

string approvalId

Required. The ID of the approval to comment on.

Returns
Type Description
ApprovalsResource.CommentRequest

Decline(DeclineApprovalRequest, string, string)

Declines an approval. For more information, see Manage 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.

Declaration
public virtual ApprovalsResource.DeclineRequest Decline(DeclineApprovalRequest body, string fileId, string approvalId)
Parameters
Type Name Description
DeclineApprovalRequest body

The body of the request.

string fileId

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

string approvalId

Required. The ID of the approval to decline.

Returns
Type Description
ApprovalsResource.DeclineRequest

Get(string, string)

Gets an approval by ID. For more information, see Manage approvals.

Declaration
public virtual ApprovalsResource.GetRequest Get(string fileId, string approvalId)
Parameters
Type Name Description
string fileId

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

string approvalId

Required. The ID of the approval.

Returns
Type Description
ApprovalsResource.GetRequest

List(string)

Lists the approvals on a file. For more information, see Manage approvals.

Declaration
public virtual ApprovalsResource.ListRequest List(string fileId)
Parameters
Type Name Description
string fileId

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

Returns
Type Description
ApprovalsResource.ListRequest

Reassign(ReassignApprovalRequest, string, string)

Reassigns the reviewers on an approval. For more information, see Manage 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.

Declaration
public virtual ApprovalsResource.ReassignRequest Reassign(ReassignApprovalRequest body, string fileId, string approvalId)
Parameters
Type Name Description
ReassignApprovalRequest body

The body of the request.

string fileId

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

string approvalId

Required. The ID of the approval to reassign.

Returns
Type Description
ApprovalsResource.ReassignRequest

Start(StartApprovalRequest, string)

Starts an approval on a file. For more information, see Manage approvals.

Declaration
public virtual ApprovalsResource.StartRequest Start(StartApprovalRequest body, string fileId)
Parameters
Type Name Description
StartApprovalRequest body

The body of the request.

string fileId

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

Returns
Type Description
ApprovalsResource.StartRequest
In this article
Back to top Generated by DocFX