Google_Service_PlusDomains_Circles_Resource Class Reference

The "circles" collection of methods. More...

Inheritance diagram for Google_Service_PlusDomains_Circles_Resource:

Public Member Functions
	addPeople ($circleId, $optParams=array())
	Add a person to a circle.
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	get ($circleId, $optParams=array())
	Get a circle.
	insert ($userId, Google_Service_PlusDomains_Circle $postBody, $optParams=array())
	Create a new circle for the authenticated user.
	listCircles ($userId, $optParams=array())
	List all of the circles for a user.
	patch ($circleId, Google_Service_PlusDomains_Circle $postBody, $optParams=array())
	Update a circle's description.
	remove ($circleId, $optParams=array())
	Delete a circle.
	removePeople ($circleId, $optParams=array())
	Remove a person from a circle.
	update ($circleId, Google_Service_PlusDomains_Circle $postBody, $optParams=array())
	Update a circle's description.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "circles" collection of methods.

Typical usage is: $plusDomainsService = new Google_Service_PlusDomains(...); $circles = $plusDomainsService->circles;

Member Function Documentation

addPeople()

Google_Service_PlusDomains_Circles_Resource::addPeople	(		$circleId,
			$optParams = array() )

Add a person to a circle.

Google+ limits certain circle operations, including the number of circle adds. Learn More. (circles.addPeople)

Parameters

string	$circleId	The ID of the circle to add the person to.
array	$optParams	Optional parameters.

@opt_param string userId IDs of the people to add to the circle. Optional, can be repeated. @opt_param string email Email of the people to add to the circle. Optional, can be repeated.

Return values

Google_Service_PlusDomains_Circle

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

get()

Google_Service_PlusDomains_Circles_Resource::get	(		$circleId,
			$optParams = array() )

Get a circle.

(circles.get)

Parameters

string	$circleId	The ID of the circle to get.
array	$optParams	Optional parameters.

Return values

Google_Service_PlusDomains_Circle

insert()

Google_Service_PlusDomains_Circles_Resource::insert	(		$userId,
		Google_Service_PlusDomains_Circle	$postBody,
			$optParams = array() )

Create a new circle for the authenticated user.

(circles.insert)

Parameters

string	$userId	The ID of the user to create the circle on behalf of. The value "me" can be used to indicate the authenticated user.
Google_Circle	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_PlusDomains_Circle

listCircles()

Google_Service_PlusDomains_Circles_Resource::listCircles	(		$userId,
			$optParams = array() )

List all of the circles for a user.

(circles.listCircles)

Parameters

string	$userId	The ID of the user to get circles for. The special value "me" can be used to indicate the authenticated user.
array	$optParams	Optional parameters.

@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. @opt_param string maxResults The maximum number of circles to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

Return values

Google_Service_PlusDomains_CircleFeed

patch()

Google_Service_PlusDomains_Circles_Resource::patch	(		$circleId,
		Google_Service_PlusDomains_Circle	$postBody,
			$optParams = array() )

Update a circle's description.

This method supports patch semantics. (circles.patch)

Parameters

string	$circleId	The ID of the circle to update.
Google_Circle	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_PlusDomains_Circle

remove()

Google_Service_PlusDomains_Circles_Resource::remove	(		$circleId,
			$optParams = array() )

Delete a circle.

(circles.remove)

Parameters

string	$circleId	The ID of the circle to delete.
array	$optParams	Optional parameters.

removePeople()

Google_Service_PlusDomains_Circles_Resource::removePeople	(		$circleId,
			$optParams = array() )

Remove a person from a circle.

(circles.removePeople)

Parameters

string	$circleId	The ID of the circle to remove the person from.
array	$optParams	Optional parameters.

@opt_param string userId IDs of the people to remove from the circle. Optional, can be repeated. @opt_param string email Email of the people to add to the circle. Optional, can be repeated.

update()

Google_Service_PlusDomains_Circles_Resource::update	(		$circleId,
		Google_Service_PlusDomains_Circle	$postBody,
			$optParams = array() )

Update a circle's description.

(circles.update)

Parameters

string	$circleId	The ID of the circle to update.
Google_Circle	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_PlusDomains_Circle

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/PlusDomains.php