YouTube.LiveChatMessages.List (YouTube Data API v3 (Rev. 222) 1.25.0)

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<LiveChatMessageListResponse>
        
        com.google.api.services.youtube.YouTube.LiveChatMessages.List

All Implemented Interfaces:

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

Enclosing class:

YouTube.LiveChatMessages
```
public class YouTube.LiveChatMessages.List
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
  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 List(java.lang.String liveChatId, java.lang.String part)
Lists live chat messages for a specific chat.

Constructors
Modifier	Constructor and Description
`protected`	`List(java.lang.String liveChatId, java.lang.String part)` Lists live chat messages for a specific chat.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getHl()` The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports.
`java.lang.String`	`getLiveChatId()` The liveChatId parameter specifies the ID of the chat whose messages will be returned.
`java.lang.Long`	`getMaxResults()` The maxResults parameter specifies the maximum number of messages that should be returned in the result set.
`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 the liveChatComment resource parts that the API response will include.
`java.lang.Long`	`getProfileImageSize()` The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set.
`YouTube.LiveChatMessages.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`YouTube.LiveChatMessages.List`	`setAlt(java.lang.String alt)` Data format for the response.
`YouTube.LiveChatMessages.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`YouTube.LiveChatMessages.List`	`setHl(java.lang.String hl)` The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports.
`YouTube.LiveChatMessages.List`	`setKey(java.lang.String key)` API key.
`YouTube.LiveChatMessages.List`	`setLiveChatId(java.lang.String liveChatId)` The liveChatId parameter specifies the ID of the chat whose messages will be returned.
`YouTube.LiveChatMessages.List`	`setMaxResults(java.lang.Long maxResults)` The maxResults parameter specifies the maximum number of messages that should be returned in the result set.
`YouTube.LiveChatMessages.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`YouTube.LiveChatMessages.List`	`setPageToken(java.lang.String pageToken)` The pageToken parameter identifies a specific page in the result set that should be returned.
`YouTube.LiveChatMessages.List`	`setPart(java.lang.String part)` The part parameter specifies the liveChatComment resource parts that the API response will include.
`YouTube.LiveChatMessages.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`YouTube.LiveChatMessages.List`	`setProfileImageSize(java.lang.Long profileImageSize)` The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set.
`YouTube.LiveChatMessages.List`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`YouTube.LiveChatMessages.List`	`setUserIp(java.lang.String userIp)` Deprecated.

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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(java.lang.String liveChatId,
               java.lang.String part)
```
    Lists live chat messages for a specific chat. Create a request for the method "liveChatMessages.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:
    
    liveChatId - The liveChatId parameter specifies the ID of the chat whose messages will be returned.
    
    part - The part parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet.
    
    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<LiveChatMessageListResponse>
    
    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<LiveChatMessageListResponse>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public YouTube.LiveChatMessages.List setAlt(java.lang.String alt)
```
    Description copied from class: YouTubeRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class YouTubeRequest<LiveChatMessageListResponse>
  - setFields
```
public YouTube.LiveChatMessages.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<LiveChatMessageListResponse>
  - setKey
```
public YouTube.LiveChatMessages.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<LiveChatMessageListResponse>
  - setOauthToken
```
public YouTube.LiveChatMessages.List setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: YouTubeRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class YouTubeRequest<LiveChatMessageListResponse>
  - setPrettyPrint
```
public YouTube.LiveChatMessages.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: YouTubeRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class YouTubeRequest<LiveChatMessageListResponse>
  - setQuotaUser
```
public YouTube.LiveChatMessages.List setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: YouTubeRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class YouTubeRequest<LiveChatMessageListResponse>
  - setUserIp
```
public YouTube.LiveChatMessages.List setUserIp(java.lang.String userIp)
```
    Description copied from class: YouTubeRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class YouTubeRequest<LiveChatMessageListResponse>
  - getLiveChatId
```
public java.lang.String getLiveChatId()
```
    The liveChatId parameter specifies the ID of the chat whose messages will be returned.
  - setLiveChatId
```
public YouTube.LiveChatMessages.List setLiveChatId(java.lang.String liveChatId)
```
    The liveChatId parameter specifies the ID of the chat whose messages will be returned.
  - getPart
```
public java.lang.String getPart()
```
    The part parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet.
  - setPart
```
public YouTube.LiveChatMessages.List setPart(java.lang.String part)
```
    The part parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet.
  - getHl
```
public java.lang.String getHl()
```
    The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.
  - setHl
```
public YouTube.LiveChatMessages.List setHl(java.lang.String hl)
```
    The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language.
  - getMaxResults
```
public java.lang.Long getMaxResults()
```
    The maxResults parameter specifies the maximum number of messages that should be returned in the result set. [default: 500] [minimum: 200] [maximum: 2000]
  - setMaxResults
```
public YouTube.LiveChatMessages.List setMaxResults(java.lang.Long maxResults)
```
    The maxResults parameter specifies the maximum number of messages that should be returned in the result set.
  - 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 identify other pages that could be retrieved.
  - setPageToken
```
public YouTube.LiveChatMessages.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 identify other pages that could be retrieved.
  - getProfileImageSize
```
public java.lang.Long getProfileImageSize()
```
    The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set. Default: 88. [minimum: 16] [maximum: 720]
  - setProfileImageSize
```
public YouTube.LiveChatMessages.List setProfileImageSize(java.lang.Long profileImageSize)
```
    The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set. Default: 88.
  - set
```
public YouTube.LiveChatMessages.List set(java.lang.String parameterName,
                                         java.lang.Object value)
```
    Overrides:
    
    set in class YouTubeRequest<LiveChatMessageListResponse>

YouTube Data API v3 (revision 222)

Class YouTube.LiveChatMessages.List

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getLiveChatId

setLiveChatId

getPart

setPart

getHl

setHl

getMaxResults

setMaxResults

getPageToken

setPageToken

getProfileImageSize

setProfileImageSize

set