openstack/deb-python-oauth2client
Code Issues Proposed changes
Files
b417caf3c9cfa17ebce4d08357d67d9d88c67c21
deb-python-oauth2client/docs/dyn/plus.v1.comments.html
Joe Gregorio b417caf3c9 Updated generated docs
2011-12-08 12:04:24 -05:00

125 lines
13 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>Get&nbsp;a&nbsp;comment.<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;<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;"inReplyTo":&nbsp;[&nbsp;#&nbsp;The&nbsp;activity&nbsp;this&nbsp;comment&nbsp;replied&nbsp;to.<br>
&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;of&nbsp;the&nbsp;activity.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;activity.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"plus#comment",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;comment.&nbsp;Value:&nbsp;"plus#comment".<br>
&nbsp;&nbsp;&nbsp;&nbsp;"object":&nbsp;{&nbsp;#&nbsp;The&nbsp;object&nbsp;of&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"content":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;content&nbsp;of&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"objectType":&nbsp;"comment",&nbsp;#&nbsp;The&nbsp;object&nbsp;type&nbsp;of&nbsp;this&nbsp;comment.&nbsp;Possible&nbsp;values&nbsp;are:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;"comment"&nbsp;-&nbsp;A&nbsp;comment&nbsp;in&nbsp;reply&nbsp;to&nbsp;an&nbsp;activity.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;at&nbsp;which&nbsp;this&nbsp;comment&nbsp;was&nbsp;last&nbsp;updated.&nbsp;Formatted&nbsp;as&nbsp;an&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"actor":&nbsp;{&nbsp;#&nbsp;The&nbsp;person&nbsp;who&nbsp;posted&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;link&nbsp;to&nbsp;the&nbsp;person&nbsp;resource&nbsp;for&nbsp;this&nbsp;actor.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;The&nbsp;image&nbsp;representation&nbsp;of&nbsp;this&nbsp;actor.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;actor's&nbsp;profile&nbsp;photo.&nbsp;To&nbsp;re-size&nbsp;the&nbsp;image&nbsp;and&nbsp;crop&nbsp;it&nbsp;to&nbsp;a&nbsp;square,&nbsp;append&nbsp;the&nbsp;query&nbsp;string&nbsp;?sz=x,&nbsp;where&nbsp;x&nbsp;is&nbsp;the&nbsp;dimension&nbsp;in&nbsp;pixels&nbsp;of&nbsp;each&nbsp;side.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;this&nbsp;actor,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;actor.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"verb":&nbsp;"post",&nbsp;#&nbsp;This&nbsp;comment's&nbsp;verb,&nbsp;indicating&nbsp;what&nbsp;action&nbsp;was&nbsp;performed.&nbsp;Possible&nbsp;values&nbsp;are:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;"post"&nbsp;-&nbsp;Publish&nbsp;content&nbsp;to&nbsp;the&nbsp;stream.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"published":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;at&nbsp;which&nbsp;this&nbsp;comment&nbsp;was&nbsp;initially&nbsp;published.&nbsp;Formatted&nbsp;as&nbsp;an&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;this&nbsp;comment&nbsp;resource.<br>
&nbsp;&nbsp;}</tt></dd></dl>
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;all&nbsp;of&nbsp;the&nbsp;comments&nbsp;for&nbsp;an&nbsp;activity.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;The&nbsp;continuation&nbsp;token,&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;large&nbsp;result&nbsp;sets.&nbsp;To&nbsp;get&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results,&nbsp;set&nbsp;this&nbsp;parameter&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;"nextPageToken"&nbsp;from&nbsp;the&nbsp;previous&nbsp;response.<br>
&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;comments&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;response,&nbsp;used&nbsp;for&nbsp;paging.&nbsp;For&nbsp;any&nbsp;response,&nbsp;the&nbsp;actual&nbsp;number&nbsp;returned&nbsp;may&nbsp;be&nbsp;less&nbsp;than&nbsp;the&nbsp;specified&nbsp;maxResults.<br>
&nbsp;&nbsp;activityId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;to&nbsp;get&nbsp;comments&nbsp;for.&nbsp;(required)<br>
&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<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;The&nbsp;continuation&nbsp;token,&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;large&nbsp;result&nbsp;sets.&nbsp;Provide&nbsp;this&nbsp;value&nbsp;in&nbsp;a&nbsp;subsequent&nbsp;request&nbsp;to&nbsp;return&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"plus#commentFeed",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;collection&nbsp;of&nbsp;comments.&nbsp;Value:&nbsp;"plus#commentFeed".<br>
&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;title&nbsp;of&nbsp;this&nbsp;collection&nbsp;of&nbsp;comments.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;comments&nbsp;in&nbsp;this&nbsp;page&nbsp;of&nbsp;results.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"inReplyTo":&nbsp;[&nbsp;#&nbsp;The&nbsp;activity&nbsp;this&nbsp;comment&nbsp;replied&nbsp;to.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&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;activity.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;activity.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"plus#comment",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;comment.&nbsp;Value:&nbsp;"plus#comment".<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"object":&nbsp;{&nbsp;#&nbsp;The&nbsp;object&nbsp;of&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"content":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;content&nbsp;of&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"objectType":&nbsp;"comment",&nbsp;#&nbsp;The&nbsp;object&nbsp;type&nbsp;of&nbsp;this&nbsp;comment.&nbsp;Possible&nbsp;values&nbsp;are:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;"comment"&nbsp;-&nbsp;A&nbsp;comment&nbsp;in&nbsp;reply&nbsp;to&nbsp;an&nbsp;activity.<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;The&nbsp;time&nbsp;at&nbsp;which&nbsp;this&nbsp;comment&nbsp;was&nbsp;last&nbsp;updated.&nbsp;Formatted&nbsp;as&nbsp;an&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"actor":&nbsp;{&nbsp;#&nbsp;The&nbsp;person&nbsp;who&nbsp;posted&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;link&nbsp;to&nbsp;the&nbsp;person&nbsp;resource&nbsp;for&nbsp;this&nbsp;actor.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;The&nbsp;image&nbsp;representation&nbsp;of&nbsp;this&nbsp;actor.<br>
&nbsp;&nbsp;&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;actor's&nbsp;profile&nbsp;photo.&nbsp;To&nbsp;re-size&nbsp;the&nbsp;image&nbsp;and&nbsp;crop&nbsp;it&nbsp;to&nbsp;a&nbsp;square,&nbsp;append&nbsp;the&nbsp;query&nbsp;string&nbsp;?sz=x,&nbsp;where&nbsp;x&nbsp;is&nbsp;the&nbsp;dimension&nbsp;in&nbsp;pixels&nbsp;of&nbsp;each&nbsp;side.<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;name&nbsp;of&nbsp;this&nbsp;actor,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;actor.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"verb":&nbsp;"post",&nbsp;#&nbsp;This&nbsp;comment's&nbsp;verb,&nbsp;indicating&nbsp;what&nbsp;action&nbsp;was&nbsp;performed.&nbsp;Possible&nbsp;values&nbsp;are:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;"post"&nbsp;-&nbsp;Publish&nbsp;content&nbsp;to&nbsp;the&nbsp;stream.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"published":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;at&nbsp;which&nbsp;this&nbsp;comment&nbsp;was&nbsp;initially&nbsp;published.&nbsp;Formatted&nbsp;as&nbsp;an&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;this&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;this&nbsp;comment&nbsp;resource.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;at&nbsp;which&nbsp;this&nbsp;collection&nbsp;of&nbsp;comments&nbsp;was&nbsp;last&nbsp;updated.&nbsp;Formatted&nbsp;as&nbsp;an&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"nextLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;activities.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;this&nbsp;collection&nbsp;of&nbsp;comments.<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