Documentation

Changes extends Resource
in package

The "changes" collection of methods.

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

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.
getStartPageToken()  : StartPageToken
Gets the starting pageToken for listing future changes.
listChanges()  : ChangeList
Lists the changes for a user or shared drive. (changes.listChanges)
watch()  : Channel
Subscribes to changes for a user. (changes.watch)
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

getStartPageToken()

Gets the starting pageToken for listing future changes.

public getStartPageToken([array<string|int, mixed> $optParams = [] ]) : StartPageToken

(changes.getStartPageToken)

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

Optional parameters.

Tags
opt_param

string driveId The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned.

opt_param

bool supportsAllDrives Whether the requesting application supports both My Drives and shared drives.

opt_param

bool supportsTeamDrives Deprecated use supportsAllDrives instead.

opt_param

string teamDriveId Deprecated use driveId instead.

Return values
StartPageToken

listChanges()

Lists the changes for a user or shared drive. (changes.listChanges)

public listChanges(string $pageToken[, array<string|int, mixed> $optParams = [] ]) : ChangeList
Parameters
$pageToken : string

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 or to the response from the getStartPageToken method.

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

Optional parameters.

Tags
opt_param

string driveId The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.

opt_param

bool includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.

opt_param

bool includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results.

opt_param

string includePermissionsForView Specifies which additional view's permissions to include in the response. Only 'published' is supported.

opt_param

bool includeRemoved Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

opt_param

bool includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead.

opt_param

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

opt_param

bool restrictToMyDrive Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.

opt_param

string spaces A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.

opt_param

bool supportsAllDrives Whether the requesting application supports both My Drives and shared drives.

opt_param

bool supportsTeamDrives Deprecated use supportsAllDrives instead.

opt_param

string teamDriveId Deprecated use driveId instead.

Return values
ChangeList

watch()

Subscribes to changes for a user. (changes.watch)

public watch(string $pageToken, Channel $postBody[, array<string|int, mixed> $optParams = [] ]) : Channel
Parameters
$pageToken : string

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 or to the response from the getStartPageToken method.

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

Optional parameters.

Tags
opt_param

string driveId The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.

opt_param

bool includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.

opt_param

bool includeItemsFromAllDrives Whether both My Drive and shared drive items should be included in results.

opt_param

string includePermissionsForView Specifies which additional view's permissions to include in the response. Only 'published' is supported.

opt_param

bool includeRemoved Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

opt_param

bool includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead.

opt_param

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

opt_param

bool restrictToMyDrive Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.

opt_param

string spaces A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.

opt_param

bool supportsAllDrives Whether the requesting application supports both My Drives and shared drives.

opt_param

bool supportsTeamDrives Deprecated use supportsAllDrives instead.

opt_param

string teamDriveId Deprecated use driveId instead.

Return values
Channel

convertToArrayAndStripNulls()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results