Google_PeopleServiceResource

The "people" collection of methods.

Defined (1)

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

/inc/google-api-php-client/src/contrib/Google_PlusService.php  
  1. class Google_PeopleServiceResource extends Google_ServiceResource { 
  2.  
  3.  
  4. /** 
  5. * List all of the people in the specified collection for a particular activity. 
  6. * (people.listByActivity) 
  7. * @param string $activityId The ID of the activity to get the list of people for. 
  8. * @param string $collection The collection of people to list. 
  9. * @param array $optParams Optional parameters. 
  10. * @opt_param string pageToken The continuation token, 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. 
  11. * @opt_param string maxResults The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults. 
  12. * @return Google_PeopleFeed 
  13. */ 
  14. public function listByActivity($activityId, $collection, $optParams = array()) { 
  15. $params = array('activityId' => $activityId, 'collection' => $collection); 
  16. $params = array_merge($params, $optParams); 
  17. $data = $this->__call('listByActivity', array($params)); 
  18. if ($this->useObjects()) { 
  19. return new Google_PeopleFeed($data); 
  20. } else { 
  21. return $data; 
  22. /** 
  23. * Search all public profiles. (people.search) 
  24. * @param string $query Specify a query string for full text search of public text in all profiles. 
  25. * @param array $optParams Optional parameters. 
  26. * @opt_param string pageToken The continuation token, 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 may be of any length. 
  27. * @opt_param string maxResults The maximum number of people to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults. 
  28. * @opt_param string language Specify the preferred language to search with. See search language codes for available values. 
  29. * @return Google_PeopleFeed 
  30. */ 
  31. public function search($query, $optParams = array()) { 
  32. $params = array('query' => $query); 
  33. $params = array_merge($params, $optParams); 
  34. $data = $this->__call('search', array($params)); 
  35. if ($this->useObjects()) { 
  36. return new Google_PeopleFeed($data); 
  37. } else { 
  38. return $data; 
  39. /** 
  40. * Get a person's profile. (people.get) 
  41. * @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. 
  42. * @param array $optParams Optional parameters. 
  43. * @return Google_Person 
  44. */ 
  45. public function get($userId, $optParams = array()) { 
  46. $params = array('userId' => $userId); 
  47. $params = array_merge($params, $optParams); 
  48. $data = $this->__call('get', array($params)); 
  49. if ($this->useObjects()) { 
  50. return new Google_Person($data); 
  51. } else { 
  52. return $data;