com.google.api.services.youtube

Class YouTube.Youtube.V3.LiveChat.Messages.Stream

java.lang.Object

java.util.AbstractMap<String,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<LiveChatMessageListResponse>

com.google.api.services.youtube.YouTube.Youtube.V3.LiveChat.Messages.Stream

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Youtube.V3.LiveChat.Messages

public class YouTube.Youtube.V3.LiveChat.Messages.Stream
extends YouTubeRequest<LiveChatMessageListResponse>

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

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

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

Map.Entry<K,V>

Field Summary

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Stream() Allows a user to load live chat through a server-streamed RPC.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getHl() Specifies the localization language in which the system messages should be returned.
String	getLiveChatId() The id of the live chat for which comments should be returned.
Long	getMaxResults() The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
String	getPageToken() The *pageToken* parameter identifies a specific page in the result set that should be returned.
List<String>	getPart() The *part* parameter specifies the liveChatComment resource parts that the API response will include.
Long	getProfileImageSize() Specifies the size of the profile image that should be returned for each user.
YouTube.Youtube.V3.LiveChat.Messages.Stream	set(String parameterName, Object value)
YouTube.Youtube.V3.LiveChat.Messages.Stream	set$Xgafv(String $Xgafv) V1 error format.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setAccessToken(String accessToken) OAuth access token.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setAlt(String alt) Data format for response.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setCallback(String callback) JSONP
YouTube.Youtube.V3.LiveChat.Messages.Stream	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setHl(String hl) Specifies the localization language in which the system messages should be returned.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setKey(String key) API key.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setLiveChatId(String liveChatId) The id of the live chat for which comments should be returned.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setMaxResults(Long maxResults) The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setPageToken(String pageToken) The *pageToken* parameter identifies a specific page in the result set that should be returned.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setPart(List<String> part) The *part* parameter specifies the liveChatComment resource parts that the API response will include.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setProfileImageSize(Long profileImageSize) Specifies the size of the profile image that should be returned for each user.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
YouTube.Youtube.V3.LiveChat.Messages.Stream	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

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

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Stream

protected Stream()

Allows a user to load live chat through a server-streamed RPC. Create a request for the method "messages.stream". 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.

Since:

1.13

Method Detail

executeUsingHead

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

Overrides:

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public YouTube.Youtube.V3.LiveChat.Messages.Stream set$Xgafv(String $Xgafv)

Description copied from class: YouTubeRequest

V1 error format.

Overrides:

set$Xgafv in class YouTubeRequest<LiveChatMessageListResponse>

setAccessToken

public YouTube.Youtube.V3.LiveChat.Messages.Stream setAccessToken(String accessToken)

Description copied from class: YouTubeRequest

OAuth access token.

Overrides:

setAccessToken in class YouTubeRequest<LiveChatMessageListResponse>

setAlt

public YouTube.Youtube.V3.LiveChat.Messages.Stream setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for response.

Overrides:

setAlt in class YouTubeRequest<LiveChatMessageListResponse>

setCallback

public YouTube.Youtube.V3.LiveChat.Messages.Stream setCallback(String callback)

Description copied from class: YouTubeRequest

JSONP

Overrides:

setCallback in class YouTubeRequest<LiveChatMessageListResponse>

setFields

public YouTube.Youtube.V3.LiveChat.Messages.Stream setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<LiveChatMessageListResponse>

setKey

public YouTube.Youtube.V3.LiveChat.Messages.Stream setKey(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<LiveChatMessageListResponse>

setOauthToken

public YouTube.Youtube.V3.LiveChat.Messages.Stream setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<LiveChatMessageListResponse>

setPrettyPrint

public YouTube.Youtube.V3.LiveChat.Messages.Stream setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<LiveChatMessageListResponse>

setQuotaUser

public YouTube.Youtube.V3.LiveChat.Messages.Stream setQuotaUser(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:

setQuotaUser in class YouTubeRequest<LiveChatMessageListResponse>

setUploadType

public YouTube.Youtube.V3.LiveChat.Messages.Stream setUploadType(String uploadType)

Description copied from class: YouTubeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class YouTubeRequest<LiveChatMessageListResponse>

setUploadProtocol

public YouTube.Youtube.V3.LiveChat.Messages.Stream setUploadProtocol(String uploadProtocol)

Description copied from class: YouTubeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class YouTubeRequest<LiveChatMessageListResponse>

getHl

public String getHl()

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

setHl

public YouTube.Youtube.V3.LiveChat.Messages.Stream setHl(String hl)

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

getLiveChatId

public String getLiveChatId()

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

setLiveChatId

public YouTube.Youtube.V3.LiveChat.Messages.Stream setLiveChatId(String liveChatId)

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

getMaxResults

public Long getMaxResults()

The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC. [default: 500] [minimum: 200] [maximum: 2000]

setMaxResults

public YouTube.Youtube.V3.LiveChat.Messages.Stream setMaxResults(Long maxResults)

The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.

getPageToken

public String getPageToken()

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.

setPageToken

public YouTube.Youtube.V3.LiveChat.Messages.Stream setPageToken(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.

getPart

public List<String> getPart()

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

setPart

public YouTube.Youtube.V3.LiveChat.Messages.Stream setPart(List<String> part)

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

getProfileImageSize

public Long getProfileImageSize()

Specifies the size of the profile image that should be returned for each user. [minimum: 16] [maximum: 720]

setProfileImageSize

public YouTube.Youtube.V3.LiveChat.Messages.Stream setProfileImageSize(Long profileImageSize)

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

set

public YouTube.Youtube.V3.LiveChat.Messages.Stream set(String parameterName,
                                                       Object value)

Overrides:

set in class YouTubeRequest<LiveChatMessageListResponse>