Documentation

Google_Service_PeopleService_Resource_PeopleConnections extends Google_Service_Resource
in package

The "connections" collection of methods.

Typical usage is: $peopleService = new Google_Service_PeopleService(...); $connections = $peopleService->connections;

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.
listPeopleConnections()  : Google_Service_PeopleService_ListConnectionsResponse
Provides a list of the authenticated user's contacts. The request throws a 400 error if 'personFields' is not specified.
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

listPeopleConnections()

Provides a list of the authenticated user's contacts. The request throws a 400 error if 'personFields' is not specified.

public listPeopleConnections(string $resourceName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PeopleService_ListConnectionsResponse

(connections.listPeopleConnections)

Parameters
$resourceName : string

Required. The resource name to return connections for. Only people/me is valid.

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

Optional parameters.

Tags
opt_param

string sortOrder Optional. The order in which the connections should be sorted. Defaults to LAST_MODIFIED_ASCENDING.

opt_param

string sources Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set.

opt_param

string requestMask.includeField Required. Comma-separated list of person fields to be included in the response. Each path should start with person.: for example, person.names or person.photos.

opt_param

string syncToken Optional. A sync token, received from a previous ListConnections call. Provide this to retrieve only the resources changed since the last request. Sync requests that specify sync_token have an additional rate limit. When syncing, all other parameters provided to ListConnections must match the call that provided the sync token.

opt_param

bool requestSyncToken Optional. Whether the response should include next_sync_token, which can be used to get all changes since the last request. For subsequent sync requests use the sync_token param instead. Initial sync requests that specify request_sync_token have an additional rate limit.

opt_param

int pageSize Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.

opt_param

string personFields Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined

opt_param

string pageToken Optional. A page token, received from a previous ListConnections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListConnections must match the call that provided the page token.

Return values
Google_Service_PeopleService_ListConnectionsResponse —

convertToArrayAndStripNulls()

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

Search results