328 lines
46 KiB
HTML
328 lines
46 KiB
HTML
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><title>Python: class Resource</title>
|
|
</head><body bgcolor="#f0f0f8">
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
|
|
|
|
<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes an entry on the user's calendar list.<br>
|
|
<br>
|
|
Args:<br>
|
|
calendarId: string, Calendar identifier. (required)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns an entry on the user's calendar list.<br>
|
|
<br>
|
|
Args:<br>
|
|
calendarId: string, Calendar identifier. (required)<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").<br>
|
|
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.<br>
|
|
{<br>
|
|
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.<br>
|
|
"method": "A String", # The method used by this reminder. Possible values are:<br>
|
|
# - "email" - Reminders are sent via email.<br>
|
|
# - "sms" - Reminders are sent via SMS.<br>
|
|
# - "popup" - Reminders are sent via a UI popup.<br>
|
|
},<br>
|
|
],<br>
|
|
"description": "A String", # Description of the calendar. Optional. Read-only.<br>
|
|
"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.<br>
|
|
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.<br>
|
|
"summary": "A String", # Title of the calendar. Read-only.<br>
|
|
"etag": "A String", # ETag of the resource.<br>
|
|
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.<br>
|
|
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.<br>
|
|
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.<br>
|
|
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.<br>
|
|
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:<br>
|
|
# - "freeBusyReader" - Provides read access to free/busy information.<br>
|
|
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br>
|
|
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br>
|
|
# - "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.<br>
|
|
"id": "A String", # Identifier of the calendar.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds an entry to the user's calendar list.<br>
|
|
<br>
|
|
Args:<br>
|
|
body: object, The request body. (required)<br>
|
|
The object takes the form of:<br>
|
|
<br>
|
|
{<br>
|
|
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").<br>
|
|
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.<br>
|
|
{<br>
|
|
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.<br>
|
|
"method": "A String", # The method used by this reminder. Possible values are:<br>
|
|
# - "email" - Reminders are sent via email.<br>
|
|
# - "sms" - Reminders are sent via SMS.<br>
|
|
# - "popup" - Reminders are sent via a UI popup.<br>
|
|
},<br>
|
|
],<br>
|
|
"description": "A String", # Description of the calendar. Optional. Read-only.<br>
|
|
"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.<br>
|
|
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.<br>
|
|
"summary": "A String", # Title of the calendar. Read-only.<br>
|
|
"etag": "A String", # ETag of the resource.<br>
|
|
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.<br>
|
|
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.<br>
|
|
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.<br>
|
|
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.<br>
|
|
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:<br>
|
|
# - "freeBusyReader" - Provides read access to free/busy information.<br>
|
|
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br>
|
|
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br>
|
|
# - "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.<br>
|
|
"id": "A String", # Identifier of the calendar.<br>
|
|
}<br>
|
|
<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").<br>
|
|
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.<br>
|
|
{<br>
|
|
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.<br>
|
|
"method": "A String", # The method used by this reminder. Possible values are:<br>
|
|
# - "email" - Reminders are sent via email.<br>
|
|
# - "sms" - Reminders are sent via SMS.<br>
|
|
# - "popup" - Reminders are sent via a UI popup.<br>
|
|
},<br>
|
|
],<br>
|
|
"description": "A String", # Description of the calendar. Optional. Read-only.<br>
|
|
"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.<br>
|
|
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.<br>
|
|
"summary": "A String", # Title of the calendar. Read-only.<br>
|
|
"etag": "A String", # ETag of the resource.<br>
|
|
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.<br>
|
|
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.<br>
|
|
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.<br>
|
|
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.<br>
|
|
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:<br>
|
|
# - "freeBusyReader" - Provides read access to free/busy information.<br>
|
|
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br>
|
|
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br>
|
|
# - "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.<br>
|
|
"id": "A String", # Identifier of the calendar.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns entries on the user's calendar list.<br>
|
|
<br>
|
|
Args:<br>
|
|
minAccessRole: string, The minimum access role for the user in the returned entires. Optional. The default is no restriction.<br>
|
|
Allowed values<br>
|
|
freeBusyReader - The user can read free/busy information.<br>
|
|
owner - The user can read and modify events and access control lists.<br>
|
|
reader - The user can read events that are not private.<br>
|
|
writer - The user can read and modify events.<br>
|
|
maxResults: integer, Maximum number of entries returned on one result page. Optional.<br>
|
|
pageToken: string, Token specifying which result page to return. Optional.<br>
|
|
showHidden: boolean, Whether to show hidden entries. Optional. The default is False.<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"nextPageToken": "A String", # Token used to access the next page of this result.<br>
|
|
"items": [ # Calendars that are present on the user's calendar list.<br>
|
|
{<br>
|
|
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").<br>
|
|
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.<br>
|
|
{<br>
|
|
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.<br>
|
|
"method": "A String", # The method used by this reminder. Possible values are:<br>
|
|
# - "email" - Reminders are sent via email.<br>
|
|
# - "sms" - Reminders are sent via SMS.<br>
|
|
# - "popup" - Reminders are sent via a UI popup.<br>
|
|
},<br>
|
|
],<br>
|
|
"description": "A String", # Description of the calendar. Optional. Read-only.<br>
|
|
"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.<br>
|
|
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.<br>
|
|
"summary": "A String", # Title of the calendar. Read-only.<br>
|
|
"etag": "A String", # ETag of the resource.<br>
|
|
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.<br>
|
|
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.<br>
|
|
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.<br>
|
|
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.<br>
|
|
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:<br>
|
|
# - "freeBusyReader" - Provides read access to free/busy information.<br>
|
|
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br>
|
|
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br>
|
|
# - "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.<br>
|
|
"id": "A String", # Identifier of the calendar.<br>
|
|
},<br>
|
|
],<br>
|
|
"kind": "calendar#calendarList", # Type of the collection ("calendar#calendarList").<br>
|
|
"etag": "A String", # ETag of the collection.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
|
<br>
|
|
Args:<br>
|
|
previous_request: The request for the previous page.<br>
|
|
previous_response: The response from the request for the previous page.<br>
|
|
<br>
|
|
Returns:<br>
|
|
A request object that you can call 'execute()' on to request the next<br>
|
|
page. Returns None if there are no more items in the collection.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates an entry on the user's calendar list. This method supports patch semantics.<br>
|
|
<br>
|
|
Args:<br>
|
|
body: object, The request body. (required)<br>
|
|
The object takes the form of:<br>
|
|
<br>
|
|
{<br>
|
|
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").<br>
|
|
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.<br>
|
|
{<br>
|
|
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.<br>
|
|
"method": "A String", # The method used by this reminder. Possible values are:<br>
|
|
# - "email" - Reminders are sent via email.<br>
|
|
# - "sms" - Reminders are sent via SMS.<br>
|
|
# - "popup" - Reminders are sent via a UI popup.<br>
|
|
},<br>
|
|
],<br>
|
|
"description": "A String", # Description of the calendar. Optional. Read-only.<br>
|
|
"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.<br>
|
|
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.<br>
|
|
"summary": "A String", # Title of the calendar. Read-only.<br>
|
|
"etag": "A String", # ETag of the resource.<br>
|
|
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.<br>
|
|
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.<br>
|
|
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.<br>
|
|
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.<br>
|
|
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:<br>
|
|
# - "freeBusyReader" - Provides read access to free/busy information.<br>
|
|
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br>
|
|
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br>
|
|
# - "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.<br>
|
|
"id": "A String", # Identifier of the calendar.<br>
|
|
}<br>
|
|
<br>
|
|
calendarId: string, Calendar identifier. (required)<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").<br>
|
|
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.<br>
|
|
{<br>
|
|
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.<br>
|
|
"method": "A String", # The method used by this reminder. Possible values are:<br>
|
|
# - "email" - Reminders are sent via email.<br>
|
|
# - "sms" - Reminders are sent via SMS.<br>
|
|
# - "popup" - Reminders are sent via a UI popup.<br>
|
|
},<br>
|
|
],<br>
|
|
"description": "A String", # Description of the calendar. Optional. Read-only.<br>
|
|
"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.<br>
|
|
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.<br>
|
|
"summary": "A String", # Title of the calendar. Read-only.<br>
|
|
"etag": "A String", # ETag of the resource.<br>
|
|
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.<br>
|
|
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.<br>
|
|
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.<br>
|
|
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.<br>
|
|
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:<br>
|
|
# - "freeBusyReader" - Provides read access to free/busy information.<br>
|
|
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br>
|
|
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br>
|
|
# - "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.<br>
|
|
"id": "A String", # Identifier of the calendar.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates an entry on the user's calendar list.<br>
|
|
<br>
|
|
Args:<br>
|
|
body: object, The request body. (required)<br>
|
|
The object takes the form of:<br>
|
|
<br>
|
|
{<br>
|
|
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").<br>
|
|
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.<br>
|
|
{<br>
|
|
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.<br>
|
|
"method": "A String", # The method used by this reminder. Possible values are:<br>
|
|
# - "email" - Reminders are sent via email.<br>
|
|
# - "sms" - Reminders are sent via SMS.<br>
|
|
# - "popup" - Reminders are sent via a UI popup.<br>
|
|
},<br>
|
|
],<br>
|
|
"description": "A String", # Description of the calendar. Optional. Read-only.<br>
|
|
"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.<br>
|
|
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.<br>
|
|
"summary": "A String", # Title of the calendar. Read-only.<br>
|
|
"etag": "A String", # ETag of the resource.<br>
|
|
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.<br>
|
|
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.<br>
|
|
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.<br>
|
|
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.<br>
|
|
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:<br>
|
|
# - "freeBusyReader" - Provides read access to free/busy information.<br>
|
|
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br>
|
|
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br>
|
|
# - "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.<br>
|
|
"id": "A String", # Identifier of the calendar.<br>
|
|
}<br>
|
|
<br>
|
|
calendarId: string, Calendar identifier. (required)<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"kind": "calendar#calendarListEntry", # Type of the resource ("calendar#calendarListEntry").<br>
|
|
"defaultReminders": [ # The default reminders that the authenticated user has for this calendar.<br>
|
|
{<br>
|
|
"minutes": 42, # Number of minutes before the start of the event when the reminder should trigger.<br>
|
|
"method": "A String", # The method used by this reminder. Possible values are:<br>
|
|
# - "email" - Reminders are sent via email.<br>
|
|
# - "sms" - Reminders are sent via SMS.<br>
|
|
# - "popup" - Reminders are sent via a UI popup.<br>
|
|
},<br>
|
|
],<br>
|
|
"description": "A String", # Description of the calendar. Optional. Read-only.<br>
|
|
"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.<br>
|
|
"selected": True or False, # Whether the calendar content shows up in the calendar UI. Optional. The default is False.<br>
|
|
"summary": "A String", # Title of the calendar. Read-only.<br>
|
|
"etag": "A String", # ETag of the resource.<br>
|
|
"location": "A String", # Geographic location of the calendar as free-form text. Optional. Read-only.<br>
|
|
"summaryOverride": "A String", # The summary that the authenticated user has set for this calendar. Optional.<br>
|
|
"timeZone": "A String", # The time zone of the calendar. Optional. Read-only.<br>
|
|
"hidden": True or False, # Whether the calendar has been hidden from the list. Optional. The default is False.<br>
|
|
"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:<br>
|
|
# - "freeBusyReader" - Provides read access to free/busy information.<br>
|
|
# - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br>
|
|
# - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br>
|
|
# - "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.<br>
|
|
"id": "A String", # Identifier of the calendar.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</body></html> |