com.google.api.services.youtube

Class YouTube.CommentThreads.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.youtube.YouTubeRequest<CommentThreadListResponse>

com.google.api.services.youtube.YouTube.CommentThreads.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

YouTube.CommentThreads

public class YouTube.CommentThreads.List
extends YouTubeRequest<CommentThreadListResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YouTube.CommentThreads.List(java.lang.String part) Returns a list of comment threads that match the API request parameters.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getAllThreadsRelatedToChannelId() The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel.
java.lang.String	getChannelId() The channelId parameter instructs the API to return comment threads containing comments about the specified channel.
java.lang.String	getId() The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.
java.lang.Long	getMaxResults() The maxResults parameter specifies the maximum number of items that should be returned in the result set.
java.lang.String	getModerationStatus() Set this parameter to limit the returned comment threads to a particular moderation state.
java.lang.String	getOrder() The order parameter specifies the order in which the API response should list comment threads.
java.lang.String	getPageToken() The pageToken parameter identifies a specific page in the result set that should be returned.
java.lang.String	getPart() The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.
java.lang.String	getSearchTerms() The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms.
java.lang.String	getTextFormat() 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.
java.lang.String	getVideoId() The videoId parameter instructs the API to return comment threads associated with the specified video ID.
YouTube.CommentThreads.List	set(java.lang.String parameterName, java.lang.Object value)
YouTube.CommentThreads.List	setAllThreadsRelatedToChannelId(java.lang.String allThreadsRelatedToChannelId) The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel.
YouTube.CommentThreads.List	setAlt(java.lang.String alt) Data format for the response.
YouTube.CommentThreads.List	setChannelId(java.lang.String channelId) The channelId parameter instructs the API to return comment threads containing comments about the specified channel.
YouTube.CommentThreads.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
YouTube.CommentThreads.List	setId(java.lang.String id) The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.
YouTube.CommentThreads.List	setKey(java.lang.String key) API key.
YouTube.CommentThreads.List	setMaxResults(java.lang.Long maxResults) The maxResults parameter specifies the maximum number of items that should be returned in the result set.
YouTube.CommentThreads.List	setModerationStatus(java.lang.String moderationStatus) Set this parameter to limit the returned comment threads to a particular moderation state.
YouTube.CommentThreads.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
YouTube.CommentThreads.List	setOrder(java.lang.String order) The order parameter specifies the order in which the API response should list comment threads.
YouTube.CommentThreads.List	setPageToken(java.lang.String pageToken) The pageToken parameter identifies a specific page in the result set that should be returned.
YouTube.CommentThreads.List	setPart(java.lang.String part) The part parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.
YouTube.CommentThreads.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.CommentThreads.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.CommentThreads.List	setSearchTerms(java.lang.String searchTerms) The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms.
YouTube.CommentThreads.List	setTextFormat(java.lang.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.
YouTube.CommentThreads.List	setUserIp(java.lang.String userIp) IP address of the site where the request originates.
YouTube.CommentThreads.List	setVideoId(java.lang.String videoId) The videoId parameter instructs the API to return comment threads associated with the specified video ID.

Methods inherited from class com.google.api.services.youtube.YouTubeRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

YouTube.CommentThreads.List

protected YouTube.CommentThreads.List(java.lang.String part)

Returns a list of comment threads that match the API request parameters. Create a request for the method "commentThreads.list". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

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

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CommentThreadListResponse>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CommentThreadListResponse>

Throws:

java.io.IOException

setAlt

public YouTube.CommentThreads.List setAlt(java.lang.String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<CommentThreadListResponse>

setFields

public YouTube.CommentThreads.List setFields(java.lang.String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<CommentThreadListResponse>

setKey

public YouTube.CommentThreads.List setKey(java.lang.String key)

Description copied from class: YouTubeRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class YouTubeRequest<CommentThreadListResponse>

setOauthToken

public YouTube.CommentThreads.List setOauthToken(java.lang.String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<CommentThreadListResponse>

setPrettyPrint

public YouTube.CommentThreads.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<CommentThreadListResponse>

setQuotaUser

public YouTube.CommentThreads.List setQuotaUser(java.lang.String quotaUser)

Description copied from class: YouTubeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class YouTubeRequest<CommentThreadListResponse>

setUserIp

public YouTube.CommentThreads.List setUserIp(java.lang.String userIp)

Description copied from class: YouTubeRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class YouTubeRequest<CommentThreadListResponse>

getPart

public java.lang.String getPart()

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

setPart

public YouTube.CommentThreads.List setPart(java.lang.String part)

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

getSearchTerms

public java.lang.String getSearchTerms()

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.

setSearchTerms

public YouTube.CommentThreads.List setSearchTerms(java.lang.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.

getAllThreadsRelatedToChannelId

public java.lang.String getAllThreadsRelatedToChannelId()

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.

setAllThreadsRelatedToChannelId

public YouTube.CommentThreads.List setAllThreadsRelatedToChannelId(java.lang.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.

getChannelId

public java.lang.String getChannelId()

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

setChannelId

public YouTube.CommentThreads.List setChannelId(java.lang.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.)

getVideoId

public java.lang.String getVideoId()

The videoId parameter instructs the API to return comment threads associated with the specified video ID.

setVideoId

public YouTube.CommentThreads.List setVideoId(java.lang.String videoId)

The videoId parameter instructs the API to return comment threads associated with the specified video ID.

getMaxResults

public java.lang.Long getMaxResults()

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. [default: 20] [minimum: 1] [maximum: 100]

setMaxResults

public YouTube.CommentThreads.List setMaxResults(java.lang.Long 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.

getId

public java.lang.String getId()

The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.

setId

public YouTube.CommentThreads.List setId(java.lang.String id)

The id parameter specifies a comma-separated list of comment thread IDs for the resources that should be retrieved.

getPageToken

public java.lang.String getPageToken()

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.

setPageToken

public YouTube.CommentThreads.List setPageToken(java.lang.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.

getModerationStatus

public java.lang.String getModerationStatus()

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. [default: MODERATION_STATUS_PUBLISHED]

setModerationStatus

public YouTube.CommentThreads.List setModerationStatus(java.lang.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.

getTextFormat

public java.lang.String getTextFormat()

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. [default: FORMAT_HTML]

setTextFormat

public YouTube.CommentThreads.List setTextFormat(java.lang.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.

getOrder

public java.lang.String getOrder()

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. [default: true]

setOrder

public YouTube.CommentThreads.List setOrder(java.lang.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.

set

public YouTube.CommentThreads.List set(java.lang.String parameterName,
                              java.lang.Object value)

Overrides:

set in class YouTubeRequest<CommentThreadListResponse>