1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Calendar
  7. \
  8. Resource
  9. \
  10. Acl

Acl

class Acl extends Resource (View source)

The "acl" collection of methods.

Typical usage is:

 $calendarService = new Google\Service\Calendar(...);
 $acl = $calendarService->acl;

Methods

delete(string $calendarId, string $ruleId, array $optParams = [])

Deletes an access control rule. (acl.delete)

AclRule
get(string $calendarId, string $ruleId, array $optParams = [])

Returns an access control rule. (acl.get)

AclRule
insert(string $calendarId, AclRule $postBody, array $optParams = [])

Creates an access control rule. (acl.insert)

Acl
listAcl(string $calendarId, array $optParams = [])

Returns the rules in the access control list for the calendar. (acl.listAcl)

AclRule
patch(string $calendarId, string $ruleId, AclRule $postBody, array $optParams = [])

Updates an access control rule. This method supports patch semantics.

AclRule
update(string $calendarId, string $ruleId, AclRule $postBody, array $optParams = [])

Updates an access control rule. (acl.update)

Channel
watch(string $calendarId, Channel $postBody, array $optParams = [])

Watch for changes to ACL resources. (acl.watch)

Details

at line 44
delete(string $calendarId, string $ruleId, array $optParams = [])

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.

Exceptions

Exception

at line 61
AclRule get(string $calendarId, string $ruleId, array $optParams = [])

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 Value

AclRule

Exceptions

Exception

at line 81
AclRule insert(string $calendarId, AclRule $postBody, array $optParams = [])

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.
AclRule $postBody
array $optParams

Optional parameters.

Return Value

AclRule

Exceptions

Exception

at line 115
Acl listAcl(string $calendarId, array $optParams = [])

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.

Return Value

Acl

Exceptions

Exception

at line 138
AclRule patch(string $calendarId, string $ruleId, AclRule $postBody, array $optParams = [])

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.
AclRule $postBody
array $optParams

Optional parameters.

Return Value

AclRule

Exceptions

Exception

at line 160
AclRule update(string $calendarId, string $ruleId, AclRule $postBody, array $optParams = [])

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.
AclRule $postBody
array $optParams

Optional parameters.

Return Value

AclRule

Exceptions

Exception

at line 195
Channel watch(string $calendarId, Channel $postBody, array $optParams = [])

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.
Channel $postBody
array $optParams

Optional parameters.

Return Value

Channel

Exceptions

Exception