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

ResourcesCalendars

class ResourcesCalendars extends Resource (View source)

The "calendars" collection of methods.

Typical usage is:

 $adminService = new Google\Service\Directory(...);
 $calendars = $adminService->resources_calendars;

Methods

delete(string $customer, string $calendarResourceId, array $optParams = [])

Deletes a calendar resource. (calendars.delete)

CalendarResource
get(string $customer, string $calendarResourceId, array $optParams = [])

Retrieves a calendar resource. (calendars.get)

CalendarResource
insert(string $customer, CalendarResource $postBody, array $optParams = [])

Inserts a calendar resource. (calendars.insert)

CalendarResources
listResourcesCalendars(string $customer, array $optParams = [])

Retrieves a list of calendar resources for an account.

CalendarResource
patch(string $customer, string $calendarResourceId, CalendarResource $postBody, array $optParams = [])

Patches a calendar resource. (calendars.patch)

CalendarResource
update(string $customer, string $calendarResourceId, CalendarResource $postBody, array $optParams = [])

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)

Details

at line 44
delete(string $customer, string $calendarResourceId, array $optParams = [])

Deletes a calendar resource. (calendars.delete)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
string $calendarResourceId

The unique ID of the calendar resource to delete.
array $optParams

Optional parameters.

Exceptions

Exception

at line 62
CalendarResource get(string $customer, string $calendarResourceId, array $optParams = [])

Retrieves a calendar resource. (calendars.get)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
string $calendarResourceId

The unique ID of the calendar resource to retrieve.
array $optParams

Optional parameters.

Return Value

CalendarResource

Exceptions

Exception

at line 79
CalendarResource insert(string $customer, CalendarResource $postBody, array $optParams = [])

Inserts a calendar resource. (calendars.insert)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
CalendarResource $postBody
array $optParams

Optional parameters.

Return Value

CalendarResource

Exceptions

Exception

at line 116
CalendarResources listResourcesCalendars(string $customer, array $optParams = [])

Retrieves a list of calendar resources for an account.

(calendars.listResourcesCalendars)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
array $optParams

Optional parameters.

Return Value

CalendarResources

Exceptions

Exception

at line 135
CalendarResource patch(string $customer, string $calendarResourceId, CalendarResource $postBody, array $optParams = [])

Patches a calendar resource. (calendars.patch)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
string $calendarResourceId

The unique ID of the calendar resource to update.
CalendarResource $postBody
array $optParams

Optional parameters.

Return Value

CalendarResource

Exceptions

Exception

at line 156
CalendarResource update(string $customer, string $calendarResourceId, CalendarResource $postBody, array $optParams = [])

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)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.
string $calendarResourceId

The unique ID of the calendar resource to update.
CalendarResource $postBody
array $optParams

Optional parameters.

Return Value

CalendarResource

Exceptions

Exception