Show / Hide Table of Contents

Class DocumentsResource.BatchUpdateRequest

Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<BatchUpdateDocumentResponse>
DocsBaseServiceRequest<BatchUpdateDocumentResponse>
DocumentsResource.BatchUpdateRequest
Implements
IClientServiceRequest<BatchUpdateDocumentResponse>
IClientServiceRequest
Inherited Members
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.Xgafv
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.AccessToken
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.Alt
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.Callback
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.Fields
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.Key
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.OauthToken
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.PrettyPrint
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.QuotaUser
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.UploadType
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.UploadProtocol
ClientServiceRequest<BatchUpdateDocumentResponse>.Execute()
ClientServiceRequest<BatchUpdateDocumentResponse>.ExecuteAsStream()
ClientServiceRequest<BatchUpdateDocumentResponse>.ExecuteAsync()
ClientServiceRequest<BatchUpdateDocumentResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<BatchUpdateDocumentResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<BatchUpdateDocumentResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<BatchUpdateDocumentResponse>.CreateRequest(bool?)
ClientServiceRequest<BatchUpdateDocumentResponse>.GenerateRequestUri()
ClientServiceRequest<BatchUpdateDocumentResponse>.GetDefaultETagAction(string)
ClientServiceRequest<BatchUpdateDocumentResponse>.ETagAction
ClientServiceRequest<BatchUpdateDocumentResponse>.ModifyRequest
ClientServiceRequest<BatchUpdateDocumentResponse>.ValidateParameters
ClientServiceRequest<BatchUpdateDocumentResponse>.ApiVersion
ClientServiceRequest<BatchUpdateDocumentResponse>.RequestParameters
ClientServiceRequest<BatchUpdateDocumentResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Docs.v1
Assembly: Google.Apis.Docs.v1.dll
Syntax
public class DocumentsResource.BatchUpdateRequest : DocsBaseServiceRequest<BatchUpdateDocumentResponse>, IClientServiceRequest<BatchUpdateDocumentResponse>, IClientServiceRequest

Constructors

BatchUpdateRequest(IClientService, BatchUpdateDocumentRequest, string)

Constructs a new BatchUpdate request.

Declaration
public BatchUpdateRequest(IClientService service, BatchUpdateDocumentRequest body, string documentId)
Parameters
Type Name Description
IClientService service
BatchUpdateDocumentRequest body
string documentId

Properties

DocumentId

The ID of the document to update.

Declaration
[RequestParameter("documentId", RequestParameterType.Path)]
public virtual string DocumentId { get; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<BatchUpdateDocumentResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<BatchUpdateDocumentResponse>.MethodName

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<BatchUpdateDocumentResponse>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides
ClientServiceRequest<BatchUpdateDocumentResponse>.GetBody()

InitParameters()

Initializes BatchUpdate parameter list.

Declaration
protected override void InitParameters()
Overrides
DocsBaseServiceRequest<BatchUpdateDocumentResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX