Documentation

Google_Service_Calendar_Resource_Acl extends Google_Service_Resource
in package

The "acl" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Deletes an access control rule. (acl.delete)
get()  : Google_Service_Calendar_AclRule
Returns an access control rule. (acl.get)
insert()  : Google_Service_Calendar_AclRule
Creates an access control rule. (acl.insert)
listAcl()  : Google_Service_Calendar_Acl
Returns the rules in the access control list for the calendar. (acl.listAcl)
patch()  : Google_Service_Calendar_AclRule
Updates an access control rule. This method supports patch semantics.
update()  : Google_Service_Calendar_AclRule
Updates an access control rule. (acl.update)
watch()  : Google_Service_Calendar_Channel
Watch for changes to ACL resources. (acl.watch)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

delete()

Deletes an access control rule. (acl.delete)

public delete(string $calendarId, string $ruleId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$calendarId : string

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 : string

ACL rule identifier.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed

get()

Returns an access control rule. (acl.get)

public get(string $calendarId, string $ruleId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_AclRule
Parameters
$calendarId : string

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 : string

ACL rule identifier.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Calendar_AclRule

insert()

Creates an access control rule. (acl.insert)

public insert(string $calendarId, Google_Service_Calendar_AclRule $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_AclRule
Parameters
$calendarId : string

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 : Google_Service_Calendar_AclRule
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool sendNotifications Whether to send notifications about the calendar sharing change. Optional. The default is True.

Return values
Google_Service_Calendar_AclRule

listAcl()

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

public listAcl(string $calendarId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_Acl
Parameters
$calendarId : string

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 : array<string|int, mixed> = array()

Optional parameters.

Tags
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.

opt_param

string pageToken Token specifying which result page to return. Optional.

Return values
Google_Service_Calendar_Acl

patch()

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

public patch(string $calendarId, string $ruleId, Google_Service_Calendar_AclRule $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_AclRule

(acl.patch)

Parameters
$calendarId : string

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 : string

ACL rule identifier.

$postBody : Google_Service_Calendar_AclRule
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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.

Return values
Google_Service_Calendar_AclRule

update()

Updates an access control rule. (acl.update)

public update(string $calendarId, string $ruleId, Google_Service_Calendar_AclRule $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_AclRule
Parameters
$calendarId : string

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 : string

ACL rule identifier.

$postBody : Google_Service_Calendar_AclRule
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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.

Return values
Google_Service_Calendar_AclRule

watch()

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

public watch(string $calendarId, Google_Service_Calendar_Channel $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Calendar_Channel
Parameters
$calendarId : string

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 : Google_Service_Calendar_Channel
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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.

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

string pageToken Token specifying which result page to return. Optional.

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.

Return values
Google_Service_Calendar_Channel

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results