com.google.api.services.plus

Class Plus.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.plus.PlusRequest<ActivityFeed>

com.google.api.services.plus.Plus.Activities.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Plus.Activities

public class Plus.Activities.List
extends PlusRequest<ActivityFeed>

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>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Plus.Activities.List(String userId, String collection) List all of the activities in the specified collection for a particular user.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getCollection() The collection of activities to list.
Long	getMaxResults() The maximum number of activities to include in the response, which is used for paging.
String	getPageToken() The continuation token, which is used to page through large result sets.
String	getUserId() The ID of the user to get activities for.
Plus.Activities.List	set(String parameterName, Object value)
Plus.Activities.List	setAlt(String alt) Data format for the response.
Plus.Activities.List	setCollection(String collection) The collection of activities to list.
Plus.Activities.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Plus.Activities.List	setKey(String key) API key.
Plus.Activities.List	setMaxResults(Long maxResults) The maximum number of activities to include in the response, which is used for paging.
Plus.Activities.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Plus.Activities.List	setPageToken(String pageToken) The continuation token, which is used to page through large result sets.
Plus.Activities.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Plus.Activities.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Plus.Activities.List	setUserId(String userId) The ID of the user to get activities for.
Plus.Activities.List	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.plus.PlusRequest

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

Plus.Activities.List

protected Plus.Activities.List(String userId,
                    String collection)

List all of the activities in the specified collection for a particular user. Create a request for the method "activities.list". This request holds the parameters needed by the the plus server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

userId - The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.

collection - The collection of activities to list.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ActivityFeed>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ActivityFeed>

Throws:

IOException

setAlt

public Plus.Activities.List setAlt(String alt)

Description copied from class: PlusRequest

Data format for the response.

Overrides:

setAlt in class PlusRequest<ActivityFeed>

setFields

public Plus.Activities.List setFields(String fields)

Description copied from class: PlusRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PlusRequest<ActivityFeed>

setKey

public Plus.Activities.List setKey(String key)

Description copied from class: PlusRequest

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 PlusRequest<ActivityFeed>

setOauthToken

public Plus.Activities.List setOauthToken(String oauthToken)

Description copied from class: PlusRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PlusRequest<ActivityFeed>

setPrettyPrint

public Plus.Activities.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: PlusRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PlusRequest<ActivityFeed>

setQuotaUser

public Plus.Activities.List setQuotaUser(String quotaUser)

Description copied from class: PlusRequest

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 PlusRequest<ActivityFeed>

setUserIp

public Plus.Activities.List setUserIp(String userIp)

Description copied from class: PlusRequest

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

Overrides:

setUserIp in class PlusRequest<ActivityFeed>

getUserId

public String getUserId()

The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.

setUserId

public Plus.Activities.List setUserId(String userId)

The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user.

getCollection

public String getCollection()

The collection of activities to list.

setCollection

public Plus.Activities.List setCollection(String collection)

The collection of activities to list.

getPageToken

public String getPageToken()

The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

setPageToken

public Plus.Activities.List setPageToken(String pageToken)

The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

getMaxResults

public Long getMaxResults()

The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. [default: 20] [minimum: 1] [maximum: 100]

setMaxResults

public Plus.Activities.List setMaxResults(Long maxResults)

The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

set

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

Overrides:

set in class PlusRequest<ActivityFeed>