Google_Service_Plus_People_Resource Class Reference

The "people" collection of methods. More...

Inheritance diagram for Google_Service_Plus_People_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	get ($userId, $optParams=array())
	Get a person's profile.
	listByActivity ($activityId, $collection, $optParams=array())
	List all of the people in the specified collection for a particular activity.
	listPeople ($userId, $collection, $optParams=array())
	List all of the people in the specified collection.
	search ($query, $optParams=array())
	Search all public profiles.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "people" collection of methods.

Typical usage is: $plusService = new Google_Service_Plus(...); $people = $plusService->people;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

get()

Google_Service_Plus_People_Resource::get	(		$userId,
			$optParams = array() )

Get a person's profile.

If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language. (people.get)

Parameters

string	$userId	The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user.
array	$optParams	Optional parameters.

Return values

Google_Service_Plus_Person

listByActivity()

Google_Service_Plus_People_Resource::listByActivity	(		$activityId,
			$collection,
			$optParams = array() )

List all of the people in the specified collection for a particular activity.

(people.listByActivity)

Parameters

string	$activityId	The ID of the activity to get the list of people for.
string	$collection	The collection of people to list.
array	$optParams	Optional parameters.

@opt_param 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. @opt_param string maxResults The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

Return values

Google_Service_Plus_PeopleFeed

listPeople()

Google_Service_Plus_People_Resource::listPeople	(		$userId,
			$collection,
			$optParams = array() )

List all of the people in the specified collection.

(people.listPeople)

Parameters

string	$userId	Get the collection of people for the person identified. Use "me" to indicate the authenticated user.
string	$collection	The collection of people to list.
array	$optParams	Optional parameters.

@opt_param string orderBy The order to return people in. @opt_param 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. @opt_param string maxResults The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

Return values

Google_Service_Plus_PeopleFeed

search()

Google_Service_Plus_People_Resource::search	(		$query,
			$optParams = array() )

Search all public profiles.

(people.search)

Parameters

string	$query	Specify a query string for full text search of public text in all profiles.
array	$optParams	Optional parameters.

@opt_param 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. This token can be of any length. @opt_param string maxResults The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. @opt_param string language Specify the preferred language to search with. See search language codes for available values.

Return values

Google_Service_Plus_PeopleFeed

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Plus.php