|
Methods defined here:
- __init__(self)
- delete = method(self, **kwargs)
- Deletes an entry on the user's calendar list.
Args:
calendarId: string, Calendar identifier. (required)
- get = method(self, **kwargs)
- Returns an entry on the user's calendar list.
Args:
calendarId: string, Calendar identifier. (required)
Returns:
An object of the form
{
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "sms" - Reminders are sent via SMS.
# - "popup" - Reminders are sent via a UI popup.
},
],
"description": "A String", # Description of the calendar. Optional. Read-only.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"etag": "A String", # ETag of the resource.
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"id": "A String", # Identifier of the calendar.
}
- insert = method(self, **kwargs)
- Adds an entry to the user's calendar list.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "sms" - Reminders are sent via SMS.
# - "popup" - Reminders are sent via a UI popup.
},
],
"description": "A String", # Description of the calendar. Optional. Read-only.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"etag": "A String", # ETag of the resource.
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"id": "A String", # Identifier of the calendar.
}
Returns:
An object of the form
{
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "sms" - Reminders are sent via SMS.
# - "popup" - Reminders are sent via a UI popup.
},
],
"description": "A String", # Description of the calendar. Optional. Read-only.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"etag": "A String", # ETag of the resource.
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"id": "A String", # Identifier of the calendar.
}
- list = method(self, **kwargs)
- Returns entries on the user's calendar list.
Args:
minAccessRole: string, The minimum access role for the user in the returned entires. Optional. The default is no restriction.
Allowed values
freeBusyReader - The user can read free/busy information.
owner - The user can read and modify events and access control lists.
reader - The user can read events that are not private.
writer - The user can read and modify events.
maxResults: integer, Maximum number of entries returned on one result page. Optional.
pageToken: string, Token specifying which result page to return. Optional.
showHidden: boolean, Whether to show hidden entries. Optional. The default is False.
Returns:
An object of the form
{
"nextPageToken": "A String", # Token used to access the next page of this result.
"items": [ # Calendars that are present on the user's calendar list.
{
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "sms" - Reminders are sent via SMS.
# - "popup" - Reminders are sent via a UI popup.
},
],
"description": "A String", # Description of the calendar. Optional. Read-only.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"etag": "A String", # ETag of the resource.
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"id": "A String", # Identifier of the calendar.
},
],
"kind": "calendar#calendarList", # Type of the collection ("calendar#calendarList").
"etag": "A String", # ETag of the collection.
}
- list_next = methodNext(self, previous_request, previous_response)
- Retrieves the next page of results.
Args:
previous_request: The request for the previous page.
previous_response: The response from the request for the previous page.
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
- patch = method(self, **kwargs)
- Updates an entry on the user's calendar list. This method supports patch semantics.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "sms" - Reminders are sent via SMS.
# - "popup" - Reminders are sent via a UI popup.
},
],
"description": "A String", # Description of the calendar. Optional. Read-only.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"etag": "A String", # ETag of the resource.
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"id": "A String", # Identifier of the calendar.
}
calendarId: string, Calendar identifier. (required)
Returns:
An object of the form
{
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "sms" - Reminders are sent via SMS.
# - "popup" - Reminders are sent via a UI popup.
},
],
"description": "A String", # Description of the calendar. Optional. Read-only.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"etag": "A String", # ETag of the resource.
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"id": "A String", # Identifier of the calendar.
}
- update = method(self, **kwargs)
- Updates an entry on the user's calendar list.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "sms" - Reminders are sent via SMS.
# - "popup" - Reminders are sent via a UI popup.
},
],
"description": "A String", # Description of the calendar. Optional. Read-only.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"etag": "A String", # ETag of the resource.
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"id": "A String", # Identifier of the calendar.
}
calendarId: string, Calendar identifier. (required)
Returns:
An object of the form
{
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.
{
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.
"method": "A String", # The method used by this reminder. Possible values are:
# - "email" - Reminders are sent via email.
# - "sms" - Reminders are sent via SMS.
# - "popup" - Reminders are sent via a UI popup.
},
],
"description": "A String", # Description of the calendar. Optional. Read-only.
"colorId": "A String", # The color of the calendar. This is an ID referring to an entry in the "calendar" section of the colors definition (see the "colors" endpoint). Optional.
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.
"summary": "A String", # Title of the calendar. Read-only.
"etag": "A String", # ETag of the resource.
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
# - "freeBusyReader" - Provides read access to free/busy information.
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
# - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
"id": "A String", # Identifier of the calendar.
}
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|