blob: e9fc4b2bda6d62bb28805404cad176947cb124d0 [file] [log] [blame]
Joe Gregorioafc45f22011-02-20 16:11:28 -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-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete&nbsp;a&nbsp;photo<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050020&nbsp;&nbsp;photoId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;photo&nbsp;to&nbsp;delete.&nbsp;(required)<br>
21&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
22&nbsp;&nbsp;albumId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;album&nbsp;to&nbsp;which&nbsp;to&nbsp;photo&nbsp;belongs.&nbsp;(required)<br>
23&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
24&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
25&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
26&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
27&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050028
29<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;photo&nbsp;metadata<br>
30&nbsp;<br>
31Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050032&nbsp;&nbsp;photoId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;album&nbsp;containing&nbsp;the&nbsp;photo.&nbsp;(required)<br>
33&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
34&nbsp;&nbsp;albumId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;photo&nbsp;for&nbsp;which&nbsp;to&nbsp;get&nbsp;metadata.&nbsp;(required)<br>
35&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
36&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050040
41<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Upload&nbsp;a&nbsp;photo&nbsp;to&nbsp;an&nbsp;album<br>
42&nbsp;<br>
43Args:<br>
Joe Gregorio93841702011-03-02 16:12:05 -080044&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050045&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
46&nbsp;&nbsp;albumId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;album&nbsp;to&nbsp;which&nbsp;to&nbsp;upload.&nbsp;(required)<br>
47&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
48&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
49&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050052
53<dl><dt><a name="Resource-insert2"><strong>insert2</strong></a> = method(self, **kwargs)</dt><dd><tt>Upload&nbsp;a&nbsp;photo&nbsp;to&nbsp;an&nbsp;album<br>
54&nbsp;<br>
55Args:<br>
Joe Gregorio93841702011-03-02 16:12:05 -080056&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050057&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
58&nbsp;&nbsp;albumId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;album&nbsp;to&nbsp;which&nbsp;to&nbsp;upload.&nbsp;(required)<br>
59&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
60&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
61&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050064
65<dl><dt><a name="Resource-listByAlbum"><strong>listByAlbum</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;photos&nbsp;in&nbsp;an&nbsp;album<br>
66&nbsp;<br>
67Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050068&nbsp;&nbsp;c:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
69&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
70&nbsp;&nbsp;albumId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;album&nbsp;for&nbsp;which&nbsp;to&nbsp;list&nbsp;photos.&nbsp;(required)<br>
71&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
72&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
73&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
74&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
75&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
76&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050077
78<dl><dt><a name="Resource-listByScope"><strong>listByScope</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;user's&nbsp;photos<br>
79&nbsp;<br>
80Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -050081&nbsp;&nbsp;c:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
82&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
83&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
84&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
85&nbsp;&nbsp;scope:&nbsp;string,&nbsp;The&nbsp;collection&nbsp;of&nbsp;photos&nbsp;to&nbsp;list.&nbsp;(required)<br>
86&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;@recent&nbsp;-&nbsp;Recent&nbsp;photos&nbsp;uploaded&nbsp;by&nbsp;the&nbsp;user.<br>
88&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
89&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
90&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
91&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -050092
93<hr>
94Data descriptors defined here:<br>
95<dl><dt><strong>__dict__</strong></dt>
96<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
97</dl>
98<dl><dt><strong>__weakref__</strong></dt>
99<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
100</dl>
101</td></tr></table>
102</body></html>