Documentation

Google_Service_Plus_Resource_People extends Google_Service_Resource
in package

The "people" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Plus_Person
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)
listByActivity()  : Google_Service_Plus_PeopleFeed
Shut down. See https://developers.google.com/+/api-shutdown for more details.
listPeople()  : Google_Service_Plus_PeopleFeed
List all of the people in the specified collection. (people.listPeople)
search()  : Google_Service_Plus_PeopleFeed
Shut down. See https://developers.google.com/+/api-shutdown for more details.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

get()

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)

public get(string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Plus_Person
Parameters
$userId : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Plus_Person

listByActivity()

Shut down. See https://developers.google.com/+/api-shutdown for more details.

public listByActivity(string $activityId, string $collection[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Plus_PeopleFeed

(people.listByActivity)

Parameters
$activityId : string

The ID of the activity to get the list of people for.

$collection : string

The collection of people to list.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 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.

Return values
Google_Service_Plus_PeopleFeed

listPeople()

List all of the people in the specified collection. (people.listPeople)

public listPeople(string $userId, string $collection[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Plus_PeopleFeed
Parameters
$userId : string

Get the collection of people for the person identified. Use "me" to indicate the authenticated user.

$collection : string

The collection of people to list.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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 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.

Return values
Google_Service_Plus_PeopleFeed

Shut down. See https://developers.google.com/+/api-shutdown for more details.

public search(string $query[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Plus_PeopleFeed

(people.search)

Parameters
$query : string

Specify a query string for full text search of public text in all profiles.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string language Specify the preferred language to search with. See search language codes for available values.

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

Return values
Google_Service_Plus_PeopleFeed

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results