Documentation

Revisions extends Resource
in package

The "revisions" collection of methods.

Typical usage is: $driveService = new Google\Service\Drive(...); $revisions = $driveService->revisions;

Table of Contents

Properties

$client  : Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed

Methods

__construct()  : mixed
call()  : mixed
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. (revisions.delete)
get()  : Revision
Gets a revision's metadata or content by ID. (revisions.get)
listRevisions()  : RevisionList
Lists a file's revisions. (revisions.listRevisions)
update()  : Revision
Updates a revision with patch semantics. (revisions.update)
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

call()

TODO: This function needs simplifying.

public call(mixed $name, mixed $arguments[, mixed $expectedClass = null ]) : mixed
Parameters
$name : mixed
$arguments : mixed
$expectedClass : mixed = null
  • optional, the expected class name
Tags
@return

Request|$expectedClass

throws
Exception

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

delete()

Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. (revisions.delete)

public delete(string $fileId, string $revisionId[, array<string|int, mixed> $optParams = [] ]) : mixed
Parameters
$fileId : string

The ID of the file.

$revisionId : string

The ID of the revision.

$optParams : array<string|int, mixed> = []

Optional parameters.

get()

Gets a revision's metadata or content by ID. (revisions.get)

public get(string $fileId, string $revisionId[, array<string|int, mixed> $optParams = [] ]) : Revision
Parameters
$fileId : string

The ID of the file.

$revisionId : string

The ID of the revision.

$optParams : array<string|int, mixed> = []

Optional parameters.

Tags
opt_param

bool acknowledgeAbuse Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

Return values
Revision

listRevisions()

Lists a file's revisions. (revisions.listRevisions)

public listRevisions(string $fileId[, array<string|int, mixed> $optParams = [] ]) : RevisionList
Parameters
$fileId : string

The ID of the file.

$optParams : array<string|int, mixed> = []

Optional parameters.

Tags
opt_param

int pageSize The maximum number of revisions to return per page.

opt_param

string pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

Return values
RevisionList

update()

Updates a revision with patch semantics. (revisions.update)

public update(string $fileId, string $revisionId, Revision $postBody[, array<string|int, mixed> $optParams = [] ]) : Revision
Parameters
$fileId : string

The ID of the file.

$revisionId : string

The ID of the revision.

$postBody : Revision
$optParams : array<string|int, mixed> = []

Optional parameters.

Return values
Revision

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results