People

public interface People

This interface was deprecated.
This API may return empty results, even if the user consented to SCOPE_PLUS_LOGIN. Please refer to Deprecation Notes for details. See below for suggested replacements.

On Android, consider using Contacts Provider.
If you are looking for cross-platform solutions, check out People API.
If you want to advocate your app to your existing users' social graph, check out Firebase Invites.

Methods and interfaces related to people in Google+.

Nested Class Summary

interface	People.LoadPeopleResult		Information about the set of people that was loaded.
interface	People.OrderBy		Constants to declare the order to return people in.

Public Method Summary

abstract Person	getCurrentPerson(GoogleApiClient googleApiClient) This method was deprecated. use `GoogleSignInApi` and `getSignInAccount()` instead.
abstract PendingResult<People.LoadPeopleResult>	load(GoogleApiClient googleApiClient, Collection<String> personIds) This method was deprecated. In the future, you can possibly get empty data back even if user consented to the required scopes. See `People` for details.
abstract PendingResult<People.LoadPeopleResult>	load(GoogleApiClient googleApiClient, String... personIds) This method was deprecated. In the future, you can possibly get empty data back even if user consented to the required scopes. See `People` for details.
abstract PendingResult<People.LoadPeopleResult>	loadConnected(GoogleApiClient googleApiClient) This method was deprecated. In the future, you can possibly get empty data back even if user consented to the required scopes. See `People` for details.
abstract PendingResult<People.LoadPeopleResult>	loadVisible(GoogleApiClient googleApiClient, int orderBy, String pageToken) This method was deprecated. In the future, you can possibly get empty data back even if user consented to the required scopes. See `People` for details.
abstract PendingResult<People.LoadPeopleResult>	loadVisible(GoogleApiClient googleApiClient, String pageToken) This method was deprecated. In the future, you can possibly get empty data back even if user consented to the required scopes. See `People` for details.

Public Methods

public abstract Person getCurrentPerson (GoogleApiClient googleApiClient)

This method was deprecated.
use GoogleSignInApi and getSignInAccount() instead.

Returns profile information for the current user. For more information, see: //developers.google.com/+/api/latest/people/get.

This method can return null if the required scopes weren't specified in the GoogleApiClient.Builder, or if there was a network error while connecting.

Required API: API
Required Scopes: SCOPE_PLUS_LOGIN or SCOPE_PLUS_PROFILE

Parameters

googleApiClient	The `GoogleApiClient` to service the call.

Returns

Profile information for the current user, if available, or null otherwise.

public abstract PendingResult<People.LoadPeopleResult> load (GoogleApiClient googleApiClient, Collection<String> personIds)

This method was deprecated.
In the future, you can possibly get empty data back even if user consented to the required scopes. See People for details.

Loads a list of specified people.

This call returns all information in Person, but only for the people specified and for data that is public in their profiles.

Required API: API
Required Scopes: SCOPE_PLUS_LOGIN

Parameters

googleApiClient	The `GoogleApiClient` to service the call.
personIds	The IDs of people to load. This should match the user id that would be sent to //developers.google.com/+/api/latest/people/get

Returns

the PendingResult for notification and access to the result when it's available.

public abstract PendingResult<People.LoadPeopleResult> load (GoogleApiClient googleApiClient, String... personIds)

This method was deprecated.
In the future, you can possibly get empty data back even if user consented to the required scopes. See People for details.

Loads a list of specified people.

This call returns all information in Person, but only for the people specified and for data that is public in their profiles.

Required API: API
Required Scopes: SCOPE_PLUS_LOGIN

Parameters

googleApiClient	The `GoogleApiClient` to service the call.
personIds	The ids of people to load. This should match the user id that would be sent to //developers.google.com/+/api/latest/people/get

Returns

the PendingResult for notification and access to the result when it's available.

public abstract PendingResult<People.LoadPeopleResult> loadConnected (GoogleApiClient googleApiClient)

This method was deprecated.
In the future, you can possibly get empty data back even if user consented to the required scopes. See People for details.

Loads a list of visible people in the authenticated user’s circles that are signed into the same app with Google+. For more information, see: //developers.google.com/+/api/latest/people/list.

Each Person will contain the id, displayName, image, objectType, and url fields populated. To retrieve additional profile data, use the load(GoogleApiClient, String...) method.

Required API: API
Required Scopes: SCOPE_PLUS_LOGIN

Parameters

googleApiClient	The `GoogleApiClient` to service the call.

public abstract PendingResult<People.LoadPeopleResult> loadVisible (GoogleApiClient googleApiClient, int orderBy, String pageToken)

This method was deprecated.
In the future, you can possibly get empty data back even if user consented to the required scopes. See People for details.

Loads the list of visible people in the user's circles. For more information, see: //developers.google.com/+/api/latest/people/list.

Each Person will contain the id, displayName, image, objectType, and url fields populated. To retrieve additional profile data, use the load(GoogleApiClient, String...) method.

Required API: API
Required Scopes: SCOPE_PLUS_LOGIN

Parameters

googleApiClient	The `GoogleApiClient` to service the call.
orderBy	The order to return people in. Valid values are: `ALPHABETICAL` - Order the people by their display name. `BEST` - Order people based on the relevance to the viewer.
pageToken	Result of `getNextPageToken()` to get the next page of data. Pass in `null` to get the first page.

Returns

the PendingResult for notification and access to the result when it's available.

public abstract PendingResult<People.LoadPeopleResult> loadVisible (GoogleApiClient googleApiClient, String pageToken)

This method was deprecated.
In the future, you can possibly get empty data back even if user consented to the required scopes. See People for details.

Loads the list of visible people in the user's circles. For more information, see: //developers.google.com/+/api/latest/people/list.

Each Person will contain the id, displayName, image, objectType, and url fields populated. To retrieve additional profile data, use the load(GoogleApiClient, String...) method.

Required API: API
Required Scopes: SCOPE_PLUS_LOGIN

Parameters

googleApiClient	The `GoogleApiClient` to service the call.
pageToken	Result of `getNextPageToken()` to get the next page of data. Pass in `null` to get the first page.

Returns

the PendingResult for notification and access to the result when it's available.