Google_Service_PlusDomains_Circles_Resource

The "circles" 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_Circles_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * Add a person to a circle. Google+ limits certain circle operations, including 
  5. * the number of circle adds. Learn More. (circles.addPeople) 
  6. * @param string $circleId The ID of the circle to add the person to. 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string userId IDs of the people to add to the circle. Optional,  
  9. * can be repeated. 
  10. * @opt_param string email Email of the people to add to the circle. Optional,  
  11. * can be repeated. 
  12. * @return Google_Service_PlusDomains_Circle 
  13. */ 
  14. public function addPeople($circleId, $optParams = array()) 
  15. $params = array('circleId' => $circleId); 
  16. $params = array_merge($params, $optParams); 
  17. return $this->call('addPeople', array($params), "Google_Service_PlusDomains_Circle"); 
  18.  
  19. /** 
  20. * Get a circle. (circles.get) 
  21. * @param string $circleId The ID of the circle to get. 
  22. * @param array $optParams Optional parameters. 
  23. * @return Google_Service_PlusDomains_Circle 
  24. */ 
  25. public function get($circleId, $optParams = array()) 
  26. $params = array('circleId' => $circleId); 
  27. $params = array_merge($params, $optParams); 
  28. return $this->call('get', array($params), "Google_Service_PlusDomains_Circle"); 
  29.  
  30. /** 
  31. * Create a new circle for the authenticated user. (circles.insert) 
  32. * @param string $userId The ID of the user to create the circle on behalf of. 
  33. * The value "me" can be used to indicate the authenticated user. 
  34. * @param Google_Circle $postBody 
  35. * @param array $optParams Optional parameters. 
  36. * @return Google_Service_PlusDomains_Circle 
  37. */ 
  38. public function insert($userId, Google_Service_PlusDomains_Circle $postBody, $optParams = array()) 
  39. $params = array('userId' => $userId, 'postBody' => $postBody); 
  40. $params = array_merge($params, $optParams); 
  41. return $this->call('insert', array($params), "Google_Service_PlusDomains_Circle"); 
  42.  
  43. /** 
  44. * List all of the circles for a user. (circles.listCircles) 
  45. * @param string $userId The ID of the user to get circles for. The special 
  46. * value "me" can be used to indicate the authenticated user. 
  47. * @param array $optParams Optional parameters. 
  48. * @opt_param string pageToken The continuation token, which is used to page 
  49. * through large result sets. To get the next page of results, set this 
  50. * parameter to the value of "nextPageToken" from the previous response. 
  51. * @opt_param string maxResults The maximum number of circles to include in the 
  52. * response, which is used for paging. For any response, the actual number 
  53. * returned might be less than the specified maxResults. 
  54. * @return Google_Service_PlusDomains_CircleFeed 
  55. */ 
  56. public function listCircles($userId, $optParams = array()) 
  57. $params = array('userId' => $userId); 
  58. $params = array_merge($params, $optParams); 
  59. return $this->call('list', array($params), "Google_Service_PlusDomains_CircleFeed"); 
  60.  
  61. /** 
  62. * Update a circle's description. This method supports patch semantics. 
  63. * (circles.patch) 
  64. * @param string $circleId The ID of the circle to update. 
  65. * @param Google_Circle $postBody 
  66. * @param array $optParams Optional parameters. 
  67. * @return Google_Service_PlusDomains_Circle 
  68. */ 
  69. public function patch($circleId, Google_Service_PlusDomains_Circle $postBody, $optParams = array()) 
  70. $params = array('circleId' => $circleId, 'postBody' => $postBody); 
  71. $params = array_merge($params, $optParams); 
  72. return $this->call('patch', array($params), "Google_Service_PlusDomains_Circle"); 
  73.  
  74. /** 
  75. * Delete a circle. (circles.remove) 
  76. * @param string $circleId The ID of the circle to delete. 
  77. * @param array $optParams Optional parameters. 
  78. */ 
  79. public function remove($circleId, $optParams = array()) 
  80. $params = array('circleId' => $circleId); 
  81. $params = array_merge($params, $optParams); 
  82. return $this->call('remove', array($params)); 
  83.  
  84. /** 
  85. * Remove a person from a circle. (circles.removePeople) 
  86. * @param string $circleId The ID of the circle to remove the person from. 
  87. * @param array $optParams Optional parameters. 
  88. * @opt_param string userId IDs of the people to remove from the circle. 
  89. * Optional, can be repeated. 
  90. * @opt_param string email Email of the people to add to the circle. Optional,  
  91. * can be repeated. 
  92. */ 
  93. public function removePeople($circleId, $optParams = array()) 
  94. $params = array('circleId' => $circleId); 
  95. $params = array_merge($params, $optParams); 
  96. return $this->call('removePeople', array($params)); 
  97.  
  98. /** 
  99. * Update a circle's description. (circles.update) 
  100. * @param string $circleId The ID of the circle to update. 
  101. * @param Google_Circle $postBody 
  102. * @param array $optParams Optional parameters. 
  103. * @return Google_Service_PlusDomains_Circle 
  104. */ 
  105. public function update($circleId, Google_Service_PlusDomains_Circle $postBody, $optParams = array()) 
  106. $params = array('circleId' => $circleId, 'postBody' => $postBody); 
  107. $params = array_merge($params, $optParams); 
  108. return $this->call('update', array($params), "Google_Service_PlusDomains_Circle");