Documentation

Google_Service_Drive_Resource_Drives extends Google_Service_Resource
in package

Application

The "drives" collection of methods.

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

$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.
create() : Google_Service_Drive_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() : Google_Service_Drive_Drive: Gets a shared drive's metadata by ID. (drives.get)
hide() : Google_Service_Drive_Drive: Hides a shared drive from the default view. (drives.hide)
listDrives() : Google_Service_Drive_DriveList: Lists the user's shared drives. (drives.listDrives)
unhide() : Google_Service_Drive_Drive: Restores a shared drive to the default view. (drives.unhide)
update() : Google_Service_Drive_Drive: Updates the metadate for a shared drive. (drives.update)
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 —

create()

Creates a new shared drive. (drives.create)


    public
                create(string $requestId, Google_Service_Drive_Drive $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Drive_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 : Google_Service_Drive_Drive
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_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>

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 = array() ]) : mixed

Parameters

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

Return values

mixed —

get()

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


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

Parameters

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

Return values

Google_Service_Drive_Drive —

hide()

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


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

Parameters

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

Return values

Google_Service_Drive_Drive —

listDrives()

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


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

Parameters

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

Return values

Google_Service_Drive_DriveList —

unhide()

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


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

Parameters

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

Return values

Google_Service_Drive_Drive —

update()

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


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

Parameters

$driveId : string: The ID of the shared drive.
$postBody : Google_Service_Drive_Drive
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Drive_Drive —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —