Google_Service_PlusDomains_People_Resource

The "people" collection of methods.

Defined (1)

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

/includes/api-libs/Google/Service/PlusDomains.php  
  1. class Google_Service_PlusDomains_People_Resource extends Google_Service_Resource 
  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 
  6. * special value "me" can be used to indicate the authenticated user. 
  7. * @param array $optParams Optional parameters. 
  8. * @return Google_Service_PlusDomains_Person 
  9. */ 
  10. public function get($userId, $optParams = array()) 
  11. $params = array('userId' => $userId); 
  12. $params = array_merge($params, $optParams); 
  13. return $this->call('get', array($params), "Google_Service_PlusDomains_Person"); 
  14.  
  15. /** 
  16. * List all of the people in the specified collection. (people.listPeople) 
  17. * @param string $userId Get the collection of people for the person identified. 
  18. * Use "me" to indicate the authenticated user. 
  19. * @param string $collection The collection of people to list. 
  20. * @param array $optParams Optional parameters. 
  21. * @opt_param string orderBy The order to return people in. 
  22. * @opt_param string pageToken The continuation token, which is used to page 
  23. * through large result sets. To get the next page of results, set this 
  24. * parameter to the value of "nextPageToken" from the previous response. 
  25. * @opt_param string maxResults The maximum number of people to include in the 
  26. * response, which is used for paging. For any response, the actual number 
  27. * returned might be less than the specified maxResults. 
  28. * @return Google_Service_PlusDomains_PeopleFeed 
  29. */ 
  30. public function listPeople($userId, $collection, $optParams = array()) 
  31. $params = array('userId' => $userId, 'collection' => $collection); 
  32. $params = array_merge($params, $optParams); 
  33. return $this->call('list', array($params), "Google_Service_PlusDomains_PeopleFeed"); 
  34.  
  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 
  39. * for. 
  40. * @param string $collection The collection of people to list. 
  41. * @param array $optParams Optional parameters. 
  42. * @opt_param string pageToken The continuation token, which is used to page 
  43. * through large result sets. To get the next page of results, set this 
  44. * parameter to the value of "nextPageToken" from the previous response. 
  45. * @opt_param string maxResults The maximum number of people to include in the 
  46. * response, which is used for paging. For any response, the actual number 
  47. * returned might be less than the specified maxResults. 
  48. * @return Google_Service_PlusDomains_PeopleFeed 
  49. */ 
  50. public function listByActivity($activityId, $collection, $optParams = array()) 
  51. $params = array('activityId' => $activityId, 'collection' => $collection); 
  52. $params = array_merge($params, $optParams); 
  53. return $this->call('listByActivity', array($params), "Google_Service_PlusDomains_PeopleFeed"); 
  54.  
  55. /** 
  56. * List all of the people who are members of a circle. (people.listByCircle) 
  57. * @param string $circleId The ID of the circle to get the members of. 
  58. * @param array $optParams Optional parameters. 
  59. * @opt_param string pageToken The continuation token, which is used to page 
  60. * through large result sets. To get the next page of results, set this 
  61. * parameter to the value of "nextPageToken" from the previous response. 
  62. * @opt_param string maxResults The maximum number of people to include in the 
  63. * response, which is used for paging. For any response, the actual number 
  64. * returned might be less than the specified maxResults. 
  65. * @return Google_Service_PlusDomains_PeopleFeed 
  66. */ 
  67. public function listByCircle($circleId, $optParams = array()) 
  68. $params = array('circleId' => $circleId); 
  69. $params = array_merge($params, $optParams); 
  70. return $this->call('listByCircle', array($params), "Google_Service_PlusDomains_PeopleFeed");