blob: e0c63e32e4b38b28e5cc7ae3309e133f69d3fa8a [file] [log] [blame]
Joe Gregorio2401bd62011-12-15 09:18:49 -05001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<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>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;a&nbsp;single&nbsp;user&nbsp;setting.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;setting:&nbsp;string,&nbsp;Name&nbsp;of&nbsp;the&nbsp;user&nbsp;setting.&nbsp;(required)<br>
21&nbsp;<br>
22Returns:<br>
23&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
24&nbsp;<br>
25&nbsp;&nbsp;&nbsp;&nbsp;{<br>
26&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#setting",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#setting").<br>
27&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
28&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;user&nbsp;setting.<br>
29&nbsp;&nbsp;&nbsp;&nbsp;"value":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Value&nbsp;of&nbsp;the&nbsp;user&nbsp;setting.&nbsp;The&nbsp;format&nbsp;of&nbsp;the&nbsp;value&nbsp;depends&nbsp;on&nbsp;the&nbsp;ID&nbsp;of&nbsp;the&nbsp;setting.<br>
30&nbsp;&nbsp;}</tt></dd></dl>
31
32<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;all&nbsp;user&nbsp;settings&nbsp;for&nbsp;the&nbsp;authenticated&nbsp;user.<br>
33&nbsp;<br>
34Args:<br>
35&nbsp;<br>
36Returns:<br>
37&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
38&nbsp;<br>
39&nbsp;&nbsp;&nbsp;&nbsp;{<br>
40&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;user&nbsp;settings.<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#setting",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;resource&nbsp;("calendar#setting").<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;ETag&nbsp;of&nbsp;the&nbsp;resource.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;user&nbsp;setting.<br>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"value":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Value&nbsp;of&nbsp;the&nbsp;user&nbsp;setting.&nbsp;The&nbsp;format&nbsp;of&nbsp;the&nbsp;value&nbsp;depends&nbsp;on&nbsp;the&nbsp;ID&nbsp;of&nbsp;the&nbsp;setting.<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
47&nbsp;&nbsp;&nbsp;&nbsp;],<br>
48&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"calendar#settings",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;collection&nbsp;("calendar#settings").<br>
49&nbsp;&nbsp;&nbsp;&nbsp;"etag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Etag&nbsp;of&nbsp;the&nbsp;collection.<br>
50&nbsp;&nbsp;}</tt></dd></dl>
51
52<hr>
53Data descriptors defined here:<br>
54<dl><dt><strong>__dict__</strong></dt>
55<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
56</dl>
57<dl><dt><strong>__weakref__</strong></dt>
58<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
59</dl>
60</td></tr></table>
61</body></html>