Google_Service_YouTube_CommentThreads_Resource Class Reference

The "commentThreads" collection of methods. More...

Inheritance diagram for Google_Service_YouTube_CommentThreads_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	insert ($part, Google_Service_YouTube_CommentThread $postBody, $optParams=array())
	Creates a new top-level comment.
	listCommentThreads ($part, $optParams=array())
	Returns a list of comment threads that match the API request parameters.
	update ($part, Google_Service_YouTube_CommentThread $postBody, $optParams=array())
	Modifies the top-level comment in a comment thread.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "commentThreads" collection of methods.

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

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

insert()

Google_Service_YouTube_CommentThreads_Resource::insert	(		$part,
		Google_Service_YouTube_CommentThread	$postBody,
			$optParams = array() )

Creates a new top-level comment.

To add a reply to an existing comment, use the comments.insert method instead. (commentThreads.insert)

Parameters

string	$part	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.
Google_CommentThread	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_YouTube_CommentThread

listCommentThreads()

Google_Service_YouTube_CommentThreads_Resource::listCommentThreads	(		$part,
			$optParams = array() )

Returns a list of comment threads that match the API request parameters.

(commentThreads.listCommentThreads)

Parameters

string	$part	The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.
array	$optParams	Optional parameters.

@opt_param string searchTerms The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms.

Note: This parameter is not supported for use in conjunction with the id parameter. @opt_param string allThreadsRelatedToChannelId The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel. The response can include comments about the channel or about the channel's videos. @opt_param string channelId The channelId parameter instructs the API to return comment threads containing comments about the specified channel. (The response will not include comments left on videos that the channel uploaded.) @opt_param string videoId The videoId parameter instructs the API to return comment threads associated with the specified video ID. @opt_param string maxResults The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Note: This parameter is not supported for use in conjunction with the id parameter. @opt_param string id The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved. @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 identifies the next page of the result that can be retrieved.

Note: This parameter is not supported for use in conjunction with the id parameter. @opt_param string moderationStatus Set this parameter to limit the returned comment threads to a particular moderation state.

Note: This parameter is not supported for use in conjunction with the id parameter. @opt_param string textFormat Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text. @opt_param string order The order parameter specifies the order in which the API response should list comment threads. Valid values are: - time - Comment threads are ordered by time. This is the default behavior. - relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.

Return values

Google_Service_YouTube_CommentThreadListResponse

update()

Google_Service_YouTube_CommentThreads_Resource::update	(		$part,
		Google_Service_YouTube_CommentThread	$postBody,
			$optParams = array() )

Modifies the top-level comment in a comment thread.

(commentThreads.update)

Parameters

string	$part	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.
Google_CommentThread	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_YouTube_CommentThread

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/YouTube.php