Documentation

Google_Service_Directory_Resource_ResourcesCalendars extends Google_Service_Resource
in package

The "calendars" collection of methods.

Typical usage is: $adminService = new Google_Service_Directory(...); $calendars = $adminService->calendars;

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 a calendar resource. (calendars.delete)
get()  : Google_Service_Directory_CalendarResource
Retrieves a calendar resource. (calendars.get)
insert()  : Google_Service_Directory_CalendarResource
Inserts a calendar resource. (calendars.insert)
listResourcesCalendars()  : Google_Service_Directory_CalendarResources
Retrieves a list of calendar resources for an account.
patch()  : Google_Service_Directory_CalendarResource
Patches a calendar resource via Apiary Patch Orchestration. (calendars.patch)
update()  : Google_Service_Directory_CalendarResource
Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. (calendars.update)
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 a calendar resource. (calendars.delete)

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

The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.

$calendarResourceId : string

The unique ID of the calendar resource to delete.

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

Optional parameters.

Return values
mixed

get()

Retrieves a calendar resource. (calendars.get)

public get(string $customer, string $calendarResourceId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_CalendarResource
Parameters
$customer : string

The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.

$calendarResourceId : string

The unique ID of the calendar resource to retrieve.

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

Optional parameters.

Return values
Google_Service_Directory_CalendarResource

insert()

Inserts a calendar resource. (calendars.insert)

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

The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.

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

Optional parameters.

Return values
Google_Service_Directory_CalendarResource

listResourcesCalendars()

Retrieves a list of calendar resources for an account.

public listResourcesCalendars(string $customer[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_CalendarResources

(calendars.listResourcesCalendars)

Parameters
$customer : string

The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.

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

Optional parameters.

Tags
opt_param

string query String query used to filter results. Should be of the form "field operator value" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include generatedResourceName, name, buildingId, floor_name, capacity, featureInstances.feature.name. For example buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone.

opt_param

int maxResults Maximum number of results to return.

opt_param

string orderBy Field(s) to sort results by in either ascending or descending order. Supported fields include resourceId, resourceName, capacity, buildingId, and floorName. If no order is specified, defaults to ascending. Should be of the form "field [asc|desc], field [asc|desc], ...". For example buildingId, capacity desc would return results sorted first by buildingId in ascending order then by capacity in descending order.

opt_param

string pageToken Token to specify the next page in the list.

Return values
Google_Service_Directory_CalendarResources

patch()

Patches a calendar resource via Apiary Patch Orchestration. (calendars.patch)

public patch(string $customer, string $calendarResourceId, Google_Service_Directory_CalendarResource $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_CalendarResource
Parameters
$customer : string

The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.

$calendarResourceId : string

The unique ID of the calendar resource to update.

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

Optional parameters.

Return values
Google_Service_Directory_CalendarResource

update()

Updates a calendar resource. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. (calendars.update)

public update(string $customer, string $calendarResourceId, Google_Service_Directory_CalendarResource $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_CalendarResource
Parameters
$customer : string

The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.

$calendarResourceId : string

The unique ID of the calendar resource to update.

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

Optional parameters.

Return values
Google_Service_Directory_CalendarResource

convertToArrayAndStripNulls()

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

Search results