Viewing file:  People.php (4.89 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
/**
* The "people" collection of methods.
* Typical usage is:
* <code>
* $plusService = new Google_Service_Plus(...);
* $people = $plusService->people;
* </code>
*/
class Google_Service_Plus_Resource_People extends Google_Service_Resource
{
/**
* 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)
*
* @param string $userId The ID of the person to get the profile for. The
* special value "me" can be used to indicate the authenticated user.
* @param array $optParams Optional parameters.
* @return Google_Service_Plus_Person
*/
public function get($userId, $optParams = array())
{
$params = array('userId' => $userId);
$params = array_merge($params, $optParams);
return $this->call('get', array($params), "Google_Service_Plus_Person");
}
/**
* List all of the people in the specified collection. (people.listPeople)
*
* @param string $userId Get the collection of people for the person identified.
* Use "me" to indicate the authenticated user.
* @param string $collection The collection of people to list.
* @param array $optParams Optional parameters.
*
* @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 Google_Service_Plus_PeopleFeed
*/
public function listPeople($userId, $collection, $optParams = array())
{
$params = array('userId' => $userId, 'collection' => $collection);
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_Plus_PeopleFeed");
}
/**
* Shut down. See https://developers.google.com/+/api-shutdown for more details.
* (people.listByActivity)
*
* @param string $activityId The ID of the activity to get the list of people
* for.
* @param string $collection The collection of people to list.
* @param array $optParams Optional parameters.
*
* @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 Google_Service_Plus_PeopleFeed
*/
public function listByActivity($activityId, $collection, $optParams = array())
{
$params = array('activityId' => $activityId, 'collection' => $collection);
$params = array_merge($params, $optParams);
return $this->call('listByActivity', array($params), "Google_Service_Plus_PeopleFeed");
}
/**
* Shut down. See https://developers.google.com/+/api-shutdown for more details.
* (people.search)
*
* @param string $query Specify a query string for full text search of public
* text in all profiles.
* @param array $optParams Optional parameters.
*
* @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 Google_Service_Plus_PeopleFeed
*/
public function search($query, $optParams = array())
{
$params = array('query' => $query);
$params = array_merge($params, $optParams);
return $this->call('search', array($params), "Google_Service_Plus_PeopleFeed");
}
}
|