com.google.api.services.calendar

Class Calendar.Calendars

java.lang.Object

com.google.api.services.calendar.Calendar.Calendars

Enclosing class:

Calendar

public class Calendar.Calendars
extends Object

The "calendars" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Calendar.Calendars.Clear
class	Calendar.Calendars.Delete
class	Calendar.Calendars.Get
class	Calendar.Calendars.Insert
class	Calendar.Calendars.Patch
class	Calendar.Calendars.TransferOwnership
class	Calendar.Calendars.Update

Constructor Summary

Constructors

Constructor and Description
Calendars()

Method Summary

Modifier and Type	Method and Description
Calendar.Calendars.Clear	clear(String calendarId) Clears a primary calendar.
Calendar.Calendars.Delete	delete(String calendarId) Deletes a secondary calendar.
Calendar.Calendars.Get	get(String calendarId) Returns metadata for a calendar.
Calendar.Calendars.Insert	insert(Calendar content) Creates a secondary calendar.
Calendar.Calendars.Patch	patch(String calendarId, Calendar content) Updates metadata for a calendar.
Calendar.Calendars.TransferOwnership	transferOwnership(String calendarId, String newDataOwner, Boolean useAdminAccess) Transfers a secondary calendar between users within a Google Workspace organization.
Calendar.Calendars.Update	update(String calendarId, Calendar content) Updates metadata for a calendar.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Calendars

public Calendars()

Method Detail

clear

public Calendar.Calendars.Clear clear(String calendarId)
                               throws IOException

Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. Create a request for the method "calendars.clear". This request holds the parameters needed by the calendar server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

Returns:

the request

Throws:

IOException

delete

public Calendar.Calendars.Delete delete(String calendarId)
                                 throws IOException

Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. Create a request for the method "calendars.delete". This request holds the parameters needed by the calendar server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

Returns:

the request

Throws:

IOException

get

public Calendar.Calendars.Get get(String calendarId)
                           throws IOException

Returns metadata for a calendar. Create a request for the method "calendars.get". This request holds the parameters needed by the calendar server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

Returns:

the request

Throws:

IOException

insert

public Calendar.Calendars.Insert insert(Calendar content)
                                 throws IOException

Creates a secondary calendar. The authenticated user for the request is made the data owner of the new calendar. Note: We recommend to authenticate as the intended data owner of the calendar. You can use domain-wide delegation of authority to allow applications to act on behalf of a specific user. Don't use a service account for authentication. If you use a service account for authentication, the service account is the data owner, which can lead to unexpected behavior. For example, if a service account is the data owner, data ownership cannot be transferred. Create a request for the method "calendars.insert". This request holds the parameters needed by the calendar server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the Calendar

Returns:

the request

Throws:

IOException

patch

public Calendar.Calendars.Patch patch(String calendarId,
                                      Calendar content)
                               throws IOException

Updates metadata for a calendar. This method supports patch semantics. Create a request for the method "calendars.patch". This request holds the parameters needed by the calendar server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

content - the Calendar

Returns:

the request

Throws:

IOException

transferOwnership

public Calendar.Calendars.TransferOwnership transferOwnership(String calendarId,
                                                              String newDataOwner,
                                                              Boolean useAdminAccess)
                                                       throws IOException

Transfers a secondary calendar between users within a Google Workspace organization. Requires user authentication with Manage Calendars administrator privilege, and one of the following authorization scopes: - https://www.googleapis.com/auth/calendar - https://www.googleapis.com/auth/calendar.calendars In the request, set useAdminAccess to true. The secondary calendar must be active to be transferred. Transferring disabled or deleted calendars isn't supported. Create a request for the method "calendars.transferOwnership". This request holds the parameters needed by the calendar server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

calendarId - Calendar identifier. To retrieve calendar IDs, call the calendarList.list method.

newDataOwner - The email address of a user who will become the data owner of the calendar.

useAdminAccess - When true, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the Manage Calendars privilege. This method currently only supports admin access, thus only true is accepted for this field.

Returns:

the request

Throws:

IOException

update

public Calendar.Calendars.Update update(String calendarId,
                                        Calendar content)
                                 throws IOException

Updates metadata for a calendar. Create a request for the method "calendars.update". This request holds the parameters needed by the calendar server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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.

content - the Calendar

Returns:

the request

Throws:

IOException