Documentation

Google_Service_YouTube_Resource_LiveChatMessages extends Google_Service_Resource
in package

The "liveChatMessages" collection of methods.

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

Table of Contents

$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 chat message. (liveChatMessages.delete)
insert()  : Google_Service_YouTube_LiveChatMessage
Inserts a new resource into this collection. (liveChatMessages.insert)
listLiveChatMessages()  : Google_Service_YouTube_LiveChatMessageListResponse
Retrieves a list of resources, possibly filtered.
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
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
Tags
throws
Google_Exception
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>
Tags
static
Return values
string —

$requestUrl

delete()

Deletes a chat message. (liveChatMessages.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. (liveChatMessages.insert)

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

The part parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet.

$postBody : Google_Service_YouTube_LiveChatMessage
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_YouTube_LiveChatMessage —

listLiveChatMessages()

Retrieves a list of resources, possibly filtered.

public listLiveChatMessages(string $liveChatId, string|array<string|int, mixed> $part[, array<string|int, mixed> $optParams = array() ]) : Google_Service_YouTube_LiveChatMessageListResponse

(liveChatMessages.listLiveChatMessages)

Parameters
$liveChatId : string

The id of the live chat for which comments should be returned.

$part : string|array<string|int, mixed>

The part parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet.

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

Optional parameters.

Tags
opt_param

string maxResults The maxResults parameter specifies the maximum number of items that should be returned in the result set.

opt_param

string pageToken The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.

opt_param

string profileImageSize Specifies the size of the profile image that should be returned for each user.

opt_param

string hl Specifies the localization language in which the system messages should be returned.

Return values
Google_Service_YouTube_LiveChatMessageListResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results