blob: 1d84614461e0c0c7545b7d08350eba753f408e3f [file] [log] [blame]
<!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>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets&nbsp;one&nbsp;blog&nbsp;page&nbsp;by&nbsp;id.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;pageId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;page&nbsp;to&nbsp;get.&nbsp;(required)<br>
&nbsp;&nbsp;blogId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;blog&nbsp;containing&nbsp;the&nbsp;page.&nbsp;(required)<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;"content":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;body&nbsp;content&nbsp;of&nbsp;this&nbsp;Page,&nbsp;in&nbsp;HTML.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"blogger#page",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;this&nbsp;entity.&nbsp;Always&nbsp;blogger#page<br>
&nbsp;&nbsp;&nbsp;&nbsp;"author":&nbsp;{&nbsp;#&nbsp;The&nbsp;author&nbsp;of&nbsp;this&nbsp;Page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;Page&nbsp;creator's&nbsp;Profile&nbsp;page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;The&nbsp;page&nbsp;author's&nbsp;avatar.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;page&nbsp;author's&nbsp;avatar&nbsp;URL.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;display&nbsp;name.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;Page&nbsp;creator.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;that&nbsp;this&nbsp;Page&nbsp;is&nbsp;displayed&nbsp;at.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;title&nbsp;of&nbsp;this&nbsp;entity.&nbsp;This&nbsp;is&nbsp;the&nbsp;name&nbsp;displayed&nbsp;in&nbsp;the&nbsp;Admin&nbsp;user&nbsp;interface.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;date-time&nbsp;when&nbsp;this&nbsp;Page&nbsp;was&nbsp;last&nbsp;updated.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"blog":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;blog&nbsp;containing&nbsp;this&nbsp;Page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;blog&nbsp;containing&nbsp;this&nbsp;page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"published":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;date-time&nbsp;when&nbsp;this&nbsp;Page&nbsp;was&nbsp;published.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;for&nbsp;this&nbsp;resource.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;API&nbsp;REST&nbsp;URL&nbsp;to&nbsp;fetch&nbsp;this&nbsp;resource&nbsp;from.<br>
&nbsp;&nbsp;}</tt></dd></dl>
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;pages&nbsp;for&nbsp;a&nbsp;blog,&nbsp;possibly&nbsp;filtered.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;fetchBodies:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;retrieve&nbsp;the&nbsp;Page&nbsp;bodies.<br>
&nbsp;&nbsp;blogId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;blog&nbsp;to&nbsp;fetch&nbsp;pages&nbsp;from.&nbsp;(required)<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;list&nbsp;of&nbsp;Pages&nbsp;for&nbsp;a&nbsp;Blog.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"content":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;body&nbsp;content&nbsp;of&nbsp;this&nbsp;Page,&nbsp;in&nbsp;HTML.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"blogger#page",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;this&nbsp;entity.&nbsp;Always&nbsp;blogger#page<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"author":&nbsp;{&nbsp;#&nbsp;The&nbsp;author&nbsp;of&nbsp;this&nbsp;Page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;Page&nbsp;creator's&nbsp;Profile&nbsp;page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;The&nbsp;page&nbsp;author's&nbsp;avatar.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;page&nbsp;author's&nbsp;avatar&nbsp;URL.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;display&nbsp;name.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;Page&nbsp;creator.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;that&nbsp;this&nbsp;Page&nbsp;is&nbsp;displayed&nbsp;at.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;title&nbsp;of&nbsp;this&nbsp;entity.&nbsp;This&nbsp;is&nbsp;the&nbsp;name&nbsp;displayed&nbsp;in&nbsp;the&nbsp;Admin&nbsp;user&nbsp;interface.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;date-time&nbsp;when&nbsp;this&nbsp;Page&nbsp;was&nbsp;last&nbsp;updated.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"blog":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;blog&nbsp;containing&nbsp;this&nbsp;Page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;blog&nbsp;containing&nbsp;this&nbsp;page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"published":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;date-time&nbsp;when&nbsp;this&nbsp;Page&nbsp;was&nbsp;published.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;for&nbsp;this&nbsp;resource.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;API&nbsp;REST&nbsp;URL&nbsp;to&nbsp;fetch&nbsp;this&nbsp;resource&nbsp;from.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"blogger#pageList",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;this&nbsp;entity.&nbsp;Always&nbsp;blogger#pageList<br>
&nbsp;&nbsp;}</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>