Documentation

Google_Service_Drive_Resource_Files extends Google_Service_Resource
in package

Application

The "files" collection of methods.

Typical usage is: $driveService = new Google_Service_Drive(...); $files = $driveService->files;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
copy() : Google_Service_Drive_DriveFile: Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied. (files.copy)
create() : Google_Service_Drive_DriveFile: Creates a new file. (files.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Permanently deletes a file owned by the user without moving it to the trash.
emptyTrash() : mixed: Permanently deletes all of the user's trashed files. (files.emptyTrash)
export() : mixed: Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.
generateIds() : Google_Service_Drive_GeneratedIds: Generates a set of file IDs which can be provided in create or copy requests.
get() : Google_Service_Drive_DriveFile: Gets a file's metadata or content by ID. (files.get)
listFiles() : Google_Service_Drive_FileList: Lists or searches files. (files.listFiles)
update() : Google_Service_Drive_DriveFile: Updates a file's metadata and/or content. This method supports patch semantics. (files.update)
watch() : Google_Service_Drive_Channel: Subscribes to changes to a file (files.watch)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

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

Return values

Google_Http_Request|expectedClass —

copy()

Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied. (files.copy)


    public
                copy(string $fileId, Google_Service_Drive_DriveFile $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Drive_DriveFile

Parameters

$fileId : string: The ID of the file.
$postBody : Google_Service_Drive_DriveFile
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_DriveFile —

create()

Creates a new file. (files.create)


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

Parameters

$postBody : Google_Service_Drive_DriveFile
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_DriveFile —

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>

Return values

string —

$requestUrl

delete()

Permanently deletes a file owned by the user without moving it to the trash.


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

If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted. (files.delete)

Parameters

$fileId : string: The ID of the file.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

emptyTrash()

Permanently deletes all of the user's trashed files. (files.emptyTrash)


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

Parameters

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

Return values

mixed —

export()

Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.


    public
                export(string $fileId, string $mimeType[, array<string|int, mixed> $optParams = array() ]) : mixed

(files.export)

Parameters

$fileId : string: The ID of the file.
$mimeType : string: The MIME type of the format requested for this export.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

generateIds()

Generates a set of file IDs which can be provided in create or copy requests.


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

(files.generateIds)

Parameters

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

Return values

Google_Service_Drive_GeneratedIds —

get()

Gets a file's metadata or content by ID. (files.get)


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

Parameters

$fileId : string: The ID of the file.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_DriveFile —

listFiles()

Lists or searches files. (files.listFiles)


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

Parameters

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

Return values

Google_Service_Drive_FileList —

update()

Updates a file's metadata and/or content. This method supports patch semantics. (files.update)


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

Parameters

$fileId : string: The ID of the file.
$postBody : Google_Service_Drive_DriveFile
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_DriveFile —

watch()

Subscribes to changes to a file (files.watch)


    public
                watch(string $fileId, Google_Service_Drive_Channel $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Drive_Channel

Parameters

$fileId : string: The ID of the file.
$postBody : Google_Service_Drive_Channel
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_Channel —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —