class Documents extends Resource (View source)

The "documents" collection of methods.

Typical usage is:

 $docsService = new Google\Service\Docs(...);
 $documents = $docsService->documents;

Methods

batchUpdate(string $documentId, BatchUpdateDocumentRequest $postBody, array $optParams = [])

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. (documents.batchUpdate)

create(Document $postBody, array $optParams = [])

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. (documents.create)

get(string $documentId, array $optParams = [])

Gets the latest version of the specified document. (documents.get)

Details

BatchUpdateDocumentResponse batchUpdate(string $documentId, BatchUpdateDocumentRequest $postBody, array $optParams = [])

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. (documents.batchUpdate)

Parameters

string $documentId

The ID of the document to update.

BatchUpdateDocumentRequest $postBody
array $optParams

Optional parameters.

Return Value

BatchUpdateDocumentResponse

Exceptions

Exception

Document create(Document $postBody, array $optParams = [])

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. (documents.create)

Parameters

Document $postBody
array $optParams

Optional parameters.

Return Value

Document

Exceptions

Exception

Document get(string $documentId, array $optParams = [])

Gets the latest version of the specified document. (documents.get)

Parameters

string $documentId

The ID of the document to retrieve.

array $optParams

Optional parameters.

Return Value

Document

Exceptions

Exception