Show / Hide Table of Contents

Class DocumentsResource

The "documents" collection of methods.

Inheritance
object
DocumentsResource
Inherited Members
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

Constructors

DocumentsResource(IClientService)

Constructs a new resource.

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

Methods

BatchUpdate(BatchUpdateDocumentRequest, string)

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.

Declaration
public virtual DocumentsResource.BatchUpdateRequest BatchUpdate(BatchUpdateDocumentRequest body, string documentId)
Parameters
Type Name Description
BatchUpdateDocumentRequest body

The body of the request.

string documentId

The ID of the document to update.

Returns
Type Description
DocumentsResource.BatchUpdateRequest

Create(Document)

Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document.

Declaration
public virtual DocumentsResource.CreateRequest Create(Document body)
Parameters
Type Name Description
Document body

The body of the request.

Returns
Type Description
DocumentsResource.CreateRequest

Get(string)

Gets the latest version of the specified document.

Declaration
public virtual DocumentsResource.GetRequest Get(string documentId)
Parameters
Type Name Description
string documentId

The ID of the document to retrieve.

Returns
Type Description
DocumentsResource.GetRequest
In this article
Back to top Generated by DocFX