openstack/deb-python-oauth2client
Code Issues Proposed changes
Files
3d55ac5b603f9e4355cae3924d1970ae16b716b2
deb-python-oauth2client/docs/dyn/blogger.v2.comments.html
Joe Gregorio 3d55ac5b60 Update generated docs.
2012-02-21 10:11:19 -05:00

118 lines
11 KiB
HTML
Raw Blame History

<!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;comment&nbsp;by&nbsp;id.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;commentId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;comment&nbsp;to&nbsp;get.&nbsp;(required)<br>
&nbsp;&nbsp;postId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;post&nbsp;to&nbsp;fetch&nbsp;posts&nbsp;from.&nbsp;(required)<br>
&nbsp;&nbsp;blogId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;blog&nbsp;to&nbsp;containing&nbsp;the&nbsp;comment.&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;actual&nbsp;content&nbsp;of&nbsp;the&nbsp;comment.&nbsp;May&nbsp;include&nbsp;HTML&nbsp;markup.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"blogger#comment",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;this&nbsp;entry.&nbsp;Always&nbsp;blogger#comment<br>
&nbsp;&nbsp;&nbsp;&nbsp;"inReplyTo":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;comment&nbsp;this&nbsp;is&nbsp;in&nbsp;reply&nbsp;to.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identified&nbsp;of&nbsp;the&nbsp;parent&nbsp;of&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"author":&nbsp;{&nbsp;#&nbsp;The&nbsp;author&nbsp;of&nbsp;this&nbsp;Comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;Comment&nbsp;creator's&nbsp;Profile&nbsp;page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;The&nbsp;comment&nbsp;creator's&nbsp;avatar.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;comment&nbsp;creator'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;Comment&nbsp;creator.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<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;comment&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;comment.<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;comment.<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;comment&nbsp;was&nbsp;published.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"post":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;post&nbsp;containing&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identifier&nbsp;of&nbsp;the&nbsp;post&nbsp;containing&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<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;the&nbsp;comments&nbsp;for&nbsp;a&nbsp;blog,&nbsp;possibly&nbsp;filtered.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;startDate:&nbsp;string,&nbsp;Earliest&nbsp;date&nbsp;of&nbsp;comment&nbsp;to&nbsp;fetch.<br>
&nbsp;&nbsp;fetchBodies:&nbsp;boolean,&nbsp;Whether&nbsp;the&nbsp;body&nbsp;content&nbsp;of&nbsp;the&nbsp;comments&nbsp;is&nbsp;included.<br>
&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;Continuation&nbsp;token&nbsp;if&nbsp;request&nbsp;is&nbsp;paged.<br>
&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;comments&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;result.<br>
&nbsp;&nbsp;postId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;post&nbsp;to&nbsp;fetch&nbsp;posts&nbsp;from.&nbsp;(required)<br>
&nbsp;&nbsp;blogId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;blog&nbsp;to&nbsp;fetch&nbsp;comments&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;"nextPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Pagination&nbsp;token&nbsp;to&nbsp;fetch&nbsp;the&nbsp;next&nbsp;page,&nbsp;if&nbsp;one&nbsp;exists.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;List&nbsp;of&nbsp;Comments&nbsp;for&nbsp;a&nbsp;Post.<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;actual&nbsp;content&nbsp;of&nbsp;the&nbsp;comment.&nbsp;May&nbsp;include&nbsp;HTML&nbsp;markup.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"blogger#comment",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;this&nbsp;entry.&nbsp;Always&nbsp;blogger#comment<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"inReplyTo":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;comment&nbsp;this&nbsp;is&nbsp;in&nbsp;reply&nbsp;to.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;identified&nbsp;of&nbsp;the&nbsp;parent&nbsp;of&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"author":&nbsp;{&nbsp;#&nbsp;The&nbsp;author&nbsp;of&nbsp;this&nbsp;Comment.<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;Comment&nbsp;creator's&nbsp;Profile&nbsp;page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;The&nbsp;comment&nbsp;creator'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;comment&nbsp;creator'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;Comment&nbsp;creator.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<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;comment&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;comment.<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;comment.<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;comment&nbsp;was&nbsp;published.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"post":&nbsp;{&nbsp;#&nbsp;Data&nbsp;about&nbsp;the&nbsp;post&nbsp;containing&nbsp;this&nbsp;comment.<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;post&nbsp;containing&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<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#commentList",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;this&nbsp;entry.&nbsp;Always&nbsp;blogger#commentList<br>
&nbsp;&nbsp;&nbsp;&nbsp;"prevPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Pagination&nbsp;token&nbsp;to&nbsp;fetch&nbsp;the&nbsp;previous&nbsp;page,&nbsp;if&nbsp;one&nbsp;exists.<br>
&nbsp;&nbsp;}</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&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;A&nbsp;request&nbsp;object&nbsp;that&nbsp;you&nbsp;can&nbsp;call&nbsp;'execute()'&nbsp;on&nbsp;to&nbsp;request&nbsp;the&nbsp;next<br>
&nbsp;&nbsp;page.&nbsp;Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</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>
View Git Blame Copy Permalink