Documentation

Drives extends Resource
in package

The "drives" collection of methods.

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

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.
create()  : Drive
Creates a new shared drive. (drives.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. (drives.delete)
get()  : Drive
Gets a shared drive's metadata by ID. (drives.get)
hide()  : Drive
Hides a shared drive from the default view. (drives.hide)
listDrives()  : DriveList
Lists the user's shared drives. (drives.listDrives)
unhide()  : Drive
Restores a shared drive to the default view. (drives.unhide)
update()  : Drive
Updates the metadate for a shared drive. (drives.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

create()

Creates a new shared drive. (drives.create)

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

An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.

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

Optional parameters.

Return values
Drive

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 shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. (drives.delete)

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

The ID of the shared drive.

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

Optional parameters.

get()

Gets a shared drive's metadata by ID. (drives.get)

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

The ID of the shared drive.

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

Optional parameters.

Tags
opt_param

bool useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.

Return values
Drive

hide()

Hides a shared drive from the default view. (drives.hide)

public hide(string $driveId[, array<string|int, mixed> $optParams = [] ]) : Drive
Parameters
$driveId : string

The ID of the shared drive.

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

Optional parameters.

Return values
Drive

listDrives()

Lists the user's shared drives. (drives.listDrives)

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

Optional parameters.

Tags
opt_param

int pageSize Maximum number of shared drives to return per page.

opt_param

string pageToken Page token for shared drives.

opt_param

string q Query string for searching shared drives.

opt_param

bool useDomainAdminAccess Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.

Return values
DriveList

unhide()

Restores a shared drive to the default view. (drives.unhide)

public unhide(string $driveId[, array<string|int, mixed> $optParams = [] ]) : Drive
Parameters
$driveId : string

The ID of the shared drive.

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

Optional parameters.

Return values
Drive

update()

Updates the metadate for a shared drive. (drives.update)

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

The ID of the shared drive.

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

Optional parameters.

Tags
opt_param

bool useDomainAdminAccess Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.

Return values
Drive

convertToArrayAndStripNulls()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results