Documentation

Google_Service_YouTube_Resource_CommentThreads extends Google_Service_Resource
in package

The "commentThreads" collection of methods.

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

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.
insert()  : Google_Service_YouTube_CommentThread
Inserts a new resource into this collection. (commentThreads.insert)
listCommentThreads()  : Google_Service_YouTube_CommentThreadListResponse
Retrieves a list of resources, possibly filtered.
update()  : Google_Service_YouTube_CommentThread
Updates an existing resource. (commentThreads.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
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

insert()

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

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

The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units.

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

Optional parameters.

Return values
Google_Service_YouTube_CommentThread —

listCommentThreads()

Retrieves a list of resources, possibly filtered.

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

(commentThreads.listCommentThreads)

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

The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.

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

Optional parameters.

Tags
opt_param

string videoId Returns the comment threads of the specified video.

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 and prevPageToken properties identify other pages that could be retrieved.

opt_param

string id Returns the comment threads with the given IDs for Stubby or Apiary.

opt_param

string searchTerms Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.

opt_param

string textFormat The requested text format for the returned comments.

opt_param

string allThreadsRelatedToChannelId Returns the comment threads of all videos of the channel and the channel comments as well.

opt_param

string order

opt_param

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

opt_param

string moderationStatus Limits the returned comment threads to those with the specified moderation status. Not compatible with the 'id' filter. Valid values: published, heldForReview, likelySpam.

opt_param

string channelId Returns the comment threads for all the channel comments (ie does not include comments left on videos).

Return values
Google_Service_YouTube_CommentThreadListResponse —

update()

Updates an existing resource. (commentThreads.update)

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

The part parameter specifies a comma-separated list of commentThread resource properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update.

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

Optional parameters.

Return values
Google_Service_YouTube_CommentThread —

convertToArrayAndStripNulls()

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

Search results