com.google.api.services.youtube

Class YouTube.Activities.List

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<ActivityListResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Activities

public class YouTube.Activities.List
extends YouTubeRequest<ActivityListResponse>

Nested Class Summary

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

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(String part) Returns a list of channel activity events that match the request criteria.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getChannelId() The channelId parameter specifies a unique YouTube channel ID.
Boolean	getHome() Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user.
Long	getMaxResults() The maxResults parameter specifies the maximum number of items that should be returned in the result set.
Boolean	getMine() Set this parameter's value to true to retrieve a feed of the authenticated user's activities.
String	getPageToken() The pageToken parameter identifies a specific page in the result set that should be returned.
String	getPart() The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.
DateTime	getPublishedAfter() The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response.
DateTime	getPublishedBefore() The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response.
String	getRegionCode() The regionCode parameter instructs the API to return results for the specified country.
YouTube.Activities.List	set(String parameterName, Object value)
YouTube.Activities.List	setAlt(String alt) Data format for the response.
YouTube.Activities.List	setChannelId(String channelId) The channelId parameter specifies a unique YouTube channel ID.
YouTube.Activities.List	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Activities.List	setHome(Boolean home) Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user.
YouTube.Activities.List	setKey(String key) API key.
YouTube.Activities.List	setMaxResults(Long maxResults) The maxResults parameter specifies the maximum number of items that should be returned in the result set.
YouTube.Activities.List	setMine(Boolean mine) Set this parameter's value to true to retrieve a feed of the authenticated user's activities.
YouTube.Activities.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Activities.List	setPageToken(String pageToken) The pageToken parameter identifies a specific page in the result set that should be returned.
YouTube.Activities.List	setPart(String part) The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.
YouTube.Activities.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Activities.List	setPublishedAfter(DateTime publishedAfter) The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response.
YouTube.Activities.List	setPublishedBefore(DateTime publishedBefore) The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response.
YouTube.Activities.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
YouTube.Activities.List	setRegionCode(String regionCode) The regionCode parameter instructs the API to return results for the specified country.
YouTube.Activities.List	setUserIp(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, 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

List

protected List(String part)

Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user. Create a request for the method "activities.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 activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ActivityListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ActivityListResponse>

Throws:

IOException

setAlt

public YouTube.Activities.List setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<ActivityListResponse>

setFields

public YouTube.Activities.List setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<ActivityListResponse>

setKey

public YouTube.Activities.List 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<ActivityListResponse>

setOauthToken

public YouTube.Activities.List setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<ActivityListResponse>

setPrettyPrint

public YouTube.Activities.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<ActivityListResponse>

setQuotaUser

public YouTube.Activities.List setQuotaUser(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<ActivityListResponse>

setUserIp

public YouTube.Activities.List setUserIp(String userIp)

Description copied from class: YouTubeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class YouTubeRequest<ActivityListResponse>

getPart

public String getPart()

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties.

setPart

public YouTube.Activities.List setPart(String part)

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those nested properties.

getChannelId

public String getChannelId()

The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.

setChannelId

public YouTube.Activities.List setChannelId(String channelId)

The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.

getHome

public Boolean getHome()

Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user.

setHome

public YouTube.Activities.List setHome(Boolean home)

Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user.

getMaxResults

public Long getMaxResults()

The maxResults parameter specifies the maximum number of items that should be returned in the result set. [default: 5] [minimum: 0] [maximum: 50]

setMaxResults

public YouTube.Activities.List setMaxResults(Long maxResults)

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

getMine

public Boolean getMine()

Set this parameter's value to true to retrieve a feed of the authenticated user's activities.

setMine

public YouTube.Activities.List setMine(Boolean mine)

Set this parameter's value to true to retrieve a feed of the authenticated user's activities.

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

setPageToken

public YouTube.Activities.List setPageToken(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.

getPublishedAfter

public DateTime getPublishedAfter()

The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

setPublishedAfter

public YouTube.Activities.List setPublishedAfter(DateTime publishedAfter)

The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

getPublishedBefore

public DateTime getPublishedBefore()

The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

setPublishedBefore

public YouTube.Activities.List setPublishedBefore(DateTime publishedBefore)

The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

getRegionCode

public String getRegionCode()

The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed.

setRegionCode

public YouTube.Activities.List setRegionCode(String regionCode)

The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed.

set

public YouTube.Activities.List set(String parameterName,
                                   Object value)

Overrides:

set in class YouTubeRequest<ActivityListResponse>