Package org.springframework.social.google.api.plus.impl

Class PlusTemplate

java.lang.Object

org.springframework.social.google.api.impl.AbstractGoogleApiOperations

org.springframework.social.google.api.plus.impl.PlusTemplate

All Implemented Interfaces:

PlusOperations

public class PlusTemplate
extends AbstractGoogleApiOperations
implements PlusOperations

PlusOperations implementation.

Author:

Gabriel Axel

Field Summary

Fields inherited from class org.springframework.social.google.api.impl.AbstractGoogleApiOperations

isAuthorized, restTemplate

Constructor Summary

Constructors

Constructor	Description
PlusTemplate(org.springframework.web.client.RestTemplate restTemplate, boolean isAuthorized)

Method Summary

Modifier and Type	Method	Description
ActivityQueryBuilder	activityQuery()	Creates an ActivityQueryBuilder.
void	deleteMoment(String id)	Deletes a moment (app activity) created by this application
ActivitiesPage	getActivities(String userId)	Retrieves a user's first page of activities
ActivitiesPage	getActivities(String userId, String pageToken)	Retrieves a user's activities.
Activity	getActivity(String id)	Retrieves an activity by its ID.
PeoplePage	getActivityPlusOners(String activityId, String pageToken)	Retrieves people who have +1'd an activity.
PeoplePage	getActivityResharers(String activityId, String pageToken)	Retrieves people who have reshared an activity.
ActivityComment	getComment(String id)	Retrieves a comment by its ID.
ActivityCommentsPage	getComments(String activityId, String pageToken)	Retrieves the comments of an activity.
Person	getGoogleProfile()	Retrieves the authenticated user's Google profile.
MomentsPage	getMoments(String pageToken)	Retrieves moments (app activities) created by this application
PeoplePage	getPeopleInCircles(String id, String pageToken)	Retrieves people in a user's circles
Person	getPerson(String id)	Retrieves a user's Google profile.
Moment	insertMoment(Moment moment)	Inserts a new moment (app activity)
MomentQueryBuilder	momentQuery()	Creates a new MomentQueryBuilder
PersonQueryBuilder	personQuery()	Creates a PersonQueryBuilder.
PeoplePage	searchPeople(String query, String pageToken)	Retrieves people that match the query text.
ActivitiesPage	searchPublicActivities(String query, String pageToken)	Searches for public activities matching a text query

Methods inherited from class org.springframework.social.google.api.impl.AbstractGoogleApiOperations

deleteEntity, deleteEntity, getEntity, patch, requireAuthorization, saveEntity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlusTemplate

public PlusTemplate(org.springframework.web.client.RestTemplate restTemplate,
                    boolean isAuthorized)

Method Detail

getActivity

public Activity getActivity(String id)

Description copied from interface: PlusOperations

Retrieves an activity by its ID.

Specified by:

getActivity in interface PlusOperations

Parameters:

id - activity ID

Returns:

the retrieved Activity

getActivities

public ActivitiesPage getActivities(String userId,
                                    String pageToken)

Description copied from interface: PlusOperations

Retrieves a user's activities.

Specified by:

getActivities in interface PlusOperations

Parameters:

userId - user ID or "me"

pageToken - page token, or null for first page

Returns:

Activity page.

getActivities

public ActivitiesPage getActivities(String userId)

Description copied from interface: PlusOperations

Retrieves a user's first page of activities

Specified by:

getActivities in interface PlusOperations

Parameters:

userId - user ID or "me"

Returns:

Activity page

searchPublicActivities

public ActivitiesPage searchPublicActivities(String query,
                                             String pageToken)

Description copied from interface: PlusOperations

Searches for public activities matching a text query

Specified by:

searchPublicActivities in interface PlusOperations

Parameters:

query - text to search by

pageToken - page token, or null for first page

Returns:

Activity page

activityQuery

public ActivityQueryBuilder activityQuery()

Description copied from interface: PlusOperations

Creates an ActivityQueryBuilder.

Specified by:

activityQuery in interface PlusOperations

Returns:

a new ActivityQueryBuilder

getComment

public ActivityComment getComment(String id)

Description copied from interface: PlusOperations

Retrieves a comment by its ID.

Specified by:

getComment in interface PlusOperations

Parameters:

id - comment ID

Returns:

the retrieved ActivityComment

getComments

public ActivityCommentsPage getComments(String activityId,
                                        String pageToken)

Description copied from interface: PlusOperations

Retrieves the comments of an activity.

Specified by:

getComments in interface PlusOperations

Parameters:

activityId - activity ID

pageToken - page to retrieve or null for first page

Returns:

page of ActivityComment

getPerson

public Person getPerson(String id)

Description copied from interface: PlusOperations

Retrieves a user's Google profile.

Specified by:

getPerson in interface PlusOperations

Parameters:

id - user ID or "me"

Returns:

the retrieved Person

getGoogleProfile

public Person getGoogleProfile()

Description copied from interface: PlusOperations

Retrieves the authenticated user's Google profile.

Specified by:

getGoogleProfile in interface PlusOperations

Returns:

the retrieved Person

personQuery

public PersonQueryBuilder personQuery()

Description copied from interface: PlusOperations

Creates a PersonQueryBuilder.

Specified by:

personQuery in interface PlusOperations

Returns:

a new PersonQueryBuilder

getPeopleInCircles

public PeoplePage getPeopleInCircles(String id,
                                     String pageToken)

Description copied from interface: PlusOperations

Retrieves people in a user's circles

Specified by:

getPeopleInCircles in interface PlusOperations

Parameters:

id - userId or "me"

pageToken - page to retrieve or null for the first page

Returns:

PeoplePage of visible people to the authenticated user

searchPeople

public PeoplePage searchPeople(String query,
                               String pageToken)

Description copied from interface: PlusOperations

Retrieves people that match the query text.

Specified by:

searchPeople in interface PlusOperations

Parameters:

query - text to search by

pageToken - page to retrieve or null for the first page

Returns:

PeoplePage with the matching results

getActivityPlusOners

public PeoplePage getActivityPlusOners(String activityId,
                                       String pageToken)

Description copied from interface: PlusOperations

Retrieves people who have +1'd an activity.

Specified by:

getActivityPlusOners in interface PlusOperations

Parameters:

activityId - activity ID

pageToken - page to retrieve or null for the first page

Returns:

PeoplePage of +1'ers

getActivityResharers

public PeoplePage getActivityResharers(String activityId,
                                       String pageToken)

Description copied from interface: PlusOperations

Retrieves people who have reshared an activity.

Specified by:

getActivityResharers in interface PlusOperations

Parameters:

activityId - activity ID

pageToken - page to retrieve or null for the first page

Returns:

PeoplePage of resharers

insertMoment

public Moment insertMoment(Moment moment)

Description copied from interface: PlusOperations

Inserts a new moment (app activity)

Specified by:

insertMoment in interface PlusOperations

Parameters:

moment - Moment to insert

Returns:

the inserted moment

momentQuery

public MomentQueryBuilder momentQuery()

Description copied from interface: PlusOperations

Creates a new MomentQueryBuilder

Specified by:

momentQuery in interface PlusOperations

Returns:

a new MomentQueryBuilder

getMoments

public MomentsPage getMoments(String pageToken)

Description copied from interface: PlusOperations

Retrieves moments (app activities) created by this application

Specified by:

getMoments in interface PlusOperations

Parameters:

pageToken - page to retrieve or null for first page

Returns:

MomentsPage with moments created by this application

deleteMoment

public void deleteMoment(String id)

Description copied from interface: PlusOperations

Deletes a moment (app activity) created by this application

Specified by:

deleteMoment in interface PlusOperations

Parameters:

id - the moment ID