Documentation

Google_Service_YouTube_Resource_Playlists extends Google_Service_Resource
in package

Application

The "playlists" collection of methods.

Typical usage is: $youtubeService = new Google_Service_YouTube(...); $playlists = $youtubeService->playlists;

$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.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deletes a resource. (playlists.delete)
insert() : Google_Service_YouTube_Playlist: Inserts a new resource into this collection. (playlists.insert)
listPlaylists() : Google_Service_YouTube_PlaylistListResponse: Retrieves a list of resources, possibly filtered. (playlists.listPlaylists)
update() : Google_Service_YouTube_Playlist: Updates an existing resource. (playlists.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 —

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()

Deletes a resource. (playlists.delete)


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

Parameters

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

Return values

mixed —

insert()

Inserts a new resource into this collection. (playlists.insert)


    public
                insert(string|array<string|int, mixed> $part, Google_Service_YouTube_Playlist $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_Playlist

Parameters

$part : string|array<string|int, mixed>: The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
$postBody : Google_Service_YouTube_Playlist
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_Playlist —

listPlaylists()

Retrieves a list of resources, possibly filtered. (playlists.listPlaylists)


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

Parameters

$part : string|array<string|int, mixed>: The part parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a playlist resource, the snippet property contains properties like author, title, description, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_PlaylistListResponse —

update()

Updates an existing resource. (playlists.update)


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

Parameters

$part : string|array<string|int, mixed>: The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for mutable properties that are contained in any parts that the request body specifies. For example, a playlist's description is contained in the snippet part, which must be included in the request body. If the request does not specify a value for the snippet.description property, the playlist's existing description will be deleted.
$postBody : Google_Service_YouTube_Playlist
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_YouTube_Playlist —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —