The "acl" collection of methods. More...

Inheritance diagram for Google_Service_Calendar_Acl_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.

	delete ($calendarId, $ruleId, $optParams=array())
	Deletes an access control rule.

	get ($calendarId, $ruleId, $optParams=array())
	Returns an access control rule.

	insert ($calendarId, Google_Service_Calendar_AclRule $postBody, $optParams=array())
	Creates an access control rule.

	listAcl ($calendarId, $optParams=array())
	Returns the rules in the access control list for the calendar.

	patch ($calendarId, $ruleId, Google_Service_Calendar_AclRule $postBody, $optParams=array())
	Updates an access control rule.

	update ($calendarId, $ruleId, Google_Service_Calendar_AclRule $postBody, $optParams=array())
	Updates an access control rule.

	watch ($calendarId, Google_Service_Calendar_Channel $postBody, $optParams=array())
	Watch for changes to ACL resources.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "acl" collection of methods.

Typical usage is: $calendarService = new Google_Service_Calendar(...); $acl = $calendarService->acl;

Member Function Documentation

◆ 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

◆ delete()

Google_Service_Calendar_Acl_Resource::delete	(	$calendarId,
		$ruleId,
		$optParams = array() )

Deletes an access control rule.

(acl.delete)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
string	$ruleId	ACL rule identifier.
array	$optParams	Optional parameters.

◆ get()

Google_Service_Calendar_Acl_Resource::get	(	$calendarId,
		$ruleId,
		$optParams = array() )

Returns an access control rule.

(acl.get)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
string	$ruleId	ACL rule identifier.
array	$optParams	Optional parameters.

Return values

Google_Service_Calendar_AclRule

◆ insert()

Google_Service_Calendar_Acl_Resource::insert	(		$calendarId,
		Google_Service_Calendar_AclRule	$postBody,
			$optParams = array() )

Creates an access control rule.

(acl.insert)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
Google_AclRule	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Calendar_AclRule

◆ listAcl()

Google_Service_Calendar_Acl_Resource::listAcl	(		$calendarId,
			$optParams = array() )

Returns the rules in the access control list for the calendar.

(acl.listAcl)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
array	$optParams	Optional parameters.

@opt_param string pageToken Token specifying which result page to return. Optional. @opt_param string syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. @opt_param int maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. @opt_param bool showDeleted Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

Return values

Google_Service_Calendar_Acl

◆ patch()

Google_Service_Calendar_Acl_Resource::patch	(		$calendarId,
			$ruleId,
		Google_Service_Calendar_AclRule	$postBody,
			$optParams = array() )

Updates an access control rule.

This method supports patch semantics. (acl.patch)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
string	$ruleId	ACL rule identifier.
Google_AclRule	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Calendar_AclRule

◆ update()

Google_Service_Calendar_Acl_Resource::update	(		$calendarId,
			$ruleId,
		Google_Service_Calendar_AclRule	$postBody,
			$optParams = array() )

Updates an access control rule.

(acl.update)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
string	$ruleId	ACL rule identifier.
Google_AclRule	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Calendar_AclRule

◆ watch()

Google_Service_Calendar_Acl_Resource::watch	(		$calendarId,
		Google_Service_Calendar_Channel	$postBody,
			$optParams = array() )

Watch for changes to ACL resources.

(acl.watch)

Parameters

string	$calendarId	Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
Google_Channel	$postBody
array	$optParams	Optional parameters.

@opt_param string pageToken Token specifying which result page to return. Optional. @opt_param string syncToken Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. @opt_param int maxResults Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. @opt_param bool showDeleted Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

Return values

Google_Service_Calendar_Channel

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

lib/google/src/Google/Service/Calendar.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ call()

◆ delete()

◆ get()

◆ insert()

◆ listAcl()

◆ patch()

◆ update()

◆ watch()