Google_PeopleServiceResource

The "people" collection of methods.

Defined (2)

The class is defined in the following location(s).

/src/contrib/Google_PlusDomainsService.php  
  1. class Google_PeopleServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Get a person's profile. (people.get) 
  5. * @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. 
  6. * @param array $optParams Optional parameters. 
  7. * @return Google_Person 
  8. */ 
  9. public function get($userId, $optParams = array()) { 
  10. $params = array('userId' => $userId); 
  11. $params = array_merge($params, $optParams); 
  12. $data = $this->__call('get', array($params)); 
  13. if ($this->useObjects()) { 
  14. return new Google_Person($data); 
  15. } else { 
  16. return $data; 
  17. /** 
  18. * List all of the people in the specified collection. (people.list) 
  19. * @param string $userId Get the collection of people for the person identified. Use "me" to indicate the authenticated user. 
  20. * @param string $collection The collection of people to list. 
  21. * @param array $optParams Optional parameters. 
  22. * @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. 
  23. * @opt_param string orderBy The order to return people in. 
  24. * @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. 
  25. * @return Google_PeopleFeed 
  26. */ 
  27. public function listPeople($userId, $collection, $optParams = array()) { 
  28. $params = array('userId' => $userId, 'collection' => $collection); 
  29. $params = array_merge($params, $optParams); 
  30. $data = $this->__call('list', array($params)); 
  31. if ($this->useObjects()) { 
  32. return new Google_PeopleFeed($data); 
  33. } else { 
  34. return $data; 
  35. /** 
  36. * List all of the people in the specified collection for a particular activity. 
  37. * (people.listByActivity) 
  38. * @param string $activityId The ID of the activity to get the list of people for. 
  39. * @param string $collection The collection of people to list. 
  40. * @param array $optParams Optional parameters. 
  41. * @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. 
  42. * @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. 
  43. * @return Google_PeopleFeed 
  44. */ 
  45. public function listByActivity($activityId, $collection, $optParams = array()) { 
  46. $params = array('activityId' => $activityId, 'collection' => $collection); 
  47. $params = array_merge($params, $optParams); 
  48. $data = $this->__call('listByActivity', array($params)); 
  49. if ($this->useObjects()) { 
  50. return new Google_PeopleFeed($data); 
  51. } else { 
  52. return $data; 
  53. /** 
  54. * List all of the people who are members of a circle. (people.listByCircle) 
  55. * @param string $circleId The ID of the circle to get the members of. 
  56. * @param array $optParams Optional parameters. 
  57. * @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. 
  58. * @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. 
  59. * @return Google_PeopleFeed 
  60. */ 
  61. public function listByCircle($circleId, $optParams = array()) { 
  62. $params = array('circleId' => $circleId); 
  63. $params = array_merge($params, $optParams); 
  64. $data = $this->__call('listByCircle', array($params)); 
  65. if ($this->useObjects()) { 
  66. return new Google_PeopleFeed($data); 
  67. } else { 
  68. return $data; 
/src/contrib/Google_PlusService.php  
  1. class Google_PeopleServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this 
  5. * method is guaranteed to return ageRange and language. (people.get) 
  6. * @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. 
  7. * @param array $optParams Optional parameters. 
  8. * @return Google_Person 
  9. */ 
  10. public function get($userId, $optParams = array()) { 
  11. $params = array('userId' => $userId); 
  12. $params = array_merge($params, $optParams); 
  13. $data = $this->__call('get', array($params)); 
  14. if ($this->useObjects()) { 
  15. return new Google_Person($data); 
  16. } else { 
  17. return $data; 
  18. /** 
  19. * List all of the people in the specified collection. (people.list) 
  20. * @param string $userId Get the collection of people for the person identified. Use "me" to indicate the authenticated user. 
  21. * @param string $collection The collection of people to list. 
  22. * @param array $optParams Optional parameters. 
  23. * @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. 
  24. * @opt_param string orderBy The order to return people in. 
  25. * @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. 
  26. * @return Google_PeopleFeed 
  27. */ 
  28. public function listPeople($userId, $collection, $optParams = array()) { 
  29. $params = array('userId' => $userId, 'collection' => $collection); 
  30. $params = array_merge($params, $optParams); 
  31. $data = $this->__call('list', array($params)); 
  32. if ($this->useObjects()) { 
  33. return new Google_PeopleFeed($data); 
  34. } else { 
  35. return $data; 
  36. /** 
  37. * List all of the people in the specified collection for a particular activity. 
  38. * (people.listByActivity) 
  39. * @param string $activityId The ID of the activity to get the list of people for. 
  40. * @param string $collection The collection of people to list. 
  41. * @param array $optParams Optional parameters. 
  42. * @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. 
  43. * @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. 
  44. * @return Google_PeopleFeed 
  45. */ 
  46. public function listByActivity($activityId, $collection, $optParams = array()) { 
  47. $params = array('activityId' => $activityId, 'collection' => $collection); 
  48. $params = array_merge($params, $optParams); 
  49. $data = $this->__call('listByActivity', array($params)); 
  50. if ($this->useObjects()) { 
  51. return new Google_PeopleFeed($data); 
  52. } else { 
  53. return $data; 
  54. /** 
  55. * Search all public profiles. (people.search) 
  56. * @param string $query Specify a query string for full text search of public text in all profiles. 
  57. * @param array $optParams Optional parameters. 
  58. * @opt_param string language Specify the preferred language to search with. See search language codes for available values. 
  59. * @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. 
  60. * @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. 
  61. * @return Google_PeopleFeed 
  62. */ 
  63. public function search($query, $optParams = array()) { 
  64. $params = array('query' => $query); 
  65. $params = array_merge($params, $optParams); 
  66. $data = $this->__call('search', array($params)); 
  67. if ($this->useObjects()) { 
  68. return new Google_PeopleFeed($data); 
  69. } else { 
  70. return $data;