Documentation

Google_Service_Docs_Resource_Documents extends Google_Service_Resource
in package

The "documents" collection of methods.

Typical usage is: $docsService = new Google_Service_Docs(...); $documents = $docsService->documents;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
batchUpdate()  : Google_Service_Docs_BatchUpdateDocumentResponse
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)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Docs_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. (documents.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Docs_Document
Gets the latest version of the specified document. (documents.get)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

batchUpdate()

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)

public batchUpdate(string $documentId, Google_Service_Docs_BatchUpdateDocumentRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Docs_BatchUpdateDocumentResponse
Parameters
$documentId : string

The ID of the document to update.

$postBody : Google_Service_Docs_BatchUpdateDocumentRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Docs_BatchUpdateDocumentResponse —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

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)

public create(Google_Service_Docs_Document $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Docs_Document
Parameters
$postBody : Google_Service_Docs_Document
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Docs_Document —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

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

public get(string $documentId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Docs_Document
Parameters
$documentId : string

The ID of the document to retrieve.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string suggestionsViewMode The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.

Return values
Google_Service_Docs_Document —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results