The "acl" collection of methods. Typical usage is:
$calendarService = new Google_Service_Calendar(...);
$acl = $calendarService->acl;
Methods summary
public
|
#
delete( string $calendarId, string $ruleId, array $optParams = array() )
Deletes an access control rule. (acl.delete)
Deletes an access control rule. (acl.delete)
Parameters
- $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.
- $ruleId
- ACL rule identifier.
- $optParams
- Optional parameters.
|
public
Google_Service_Calendar_AclRule
|
#
get( string $calendarId, string $ruleId, array $optParams = array() )
Returns an access control rule. (acl.get)
Returns an access control rule. (acl.get)
Parameters
- $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.
- $ruleId
- ACL rule identifier.
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Calendar_AclRule
|
#
insert( string $calendarId, Google_Service_Calendar_AclRule $postBody, array $optParams = array() )
Creates an access control rule. (acl.insert)
Creates an access control rule. (acl.insert)
Parameters
- $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.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
bool sendNotifications Whether to send notifications about the calendar sharing
change. Optional. The default is True.
|
public
Google_Service_Calendar_Acl
|
#
listAcl( string $calendarId, array $optParams = array() )
Returns the rules in the access control list for the calendar.
(acl.listAcl)
Returns the rules in the access control list for the calendar.
(acl.listAcl)
Parameters
- $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.
- $optParams
- Optional parameters.
Returns
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.
string pageToken Token specifying which result page to return. Optional.
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.
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.
|
public
Google_Service_Calendar_AclRule
|
#
patch( string $calendarId, string $ruleId, Google_Service_Calendar_AclRule $postBody, array $optParams = array() )
Updates an access control rule. This method supports patch semantics.
(acl.patch)
Updates an access control rule. This method supports patch semantics.
(acl.patch)
Parameters
- $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.
- $ruleId
- ACL rule identifier.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
bool sendNotifications Whether to send notifications about the calendar sharing
change. Note that there are no notifications on access removal. Optional. The
default is True.
|
public
Google_Service_Calendar_AclRule
|
#
update( string $calendarId, string $ruleId, Google_Service_Calendar_AclRule $postBody, array $optParams = array() )
Updates an access control rule. (acl.update)
Updates an access control rule. (acl.update)
Parameters
- $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.
- $ruleId
- ACL rule identifier.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
bool sendNotifications Whether to send notifications about the calendar sharing
change. Note that there are no notifications on access removal. Optional. The
default is True.
|
public
Google_Service_Calendar_Channel
|
#
watch( string $calendarId, Google_Service_Calendar_Channel $postBody, array $optParams = array() )
Watch for changes to ACL resources. (acl.watch)
Watch for changes to ACL resources. (acl.watch)
Parameters
- $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.
- $postBody
- $optParams
- Optional parameters.
Returns
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.
string pageToken Token specifying which result page to return. Optional.
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.
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.
|
Google_Service_Calendar_Acl_Resource