openstack/deb-python-oauth2client
Code Issues Proposed changes
Files
d02bf5ee3860a50d36f960cd2c90ab6d1ecec7cd
deb-python-oauth2client/docs/dyn/orkut.v2.communityPollComments.html
Joe Gregorio 945cca12d9 Add in new docs
2012-02-21 11:59:48 -05:00

114 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-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds&nbsp;a&nbsp;comment&nbsp;on&nbsp;a&nbsp;community&nbsp;poll.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
&nbsp;<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;"body":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;body&nbsp;of&nbsp;the&nbsp;message.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#communityPollComment",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;community&nbsp;poll&nbsp;comment.&nbsp;Value:&nbsp;"orkut#communityPollComment"<br>
&nbsp;&nbsp;&nbsp;&nbsp;"addedDate":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;date&nbsp;when&nbsp;the&nbsp;message&nbsp;was&nbsp;added,&nbsp;in&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;format.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;42,&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"author":&nbsp;{&nbsp;#&nbsp;The&nbsp;creator&nbsp;of&nbsp;the&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;author&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment&nbsp;[not&nbsp;yet&nbsp;implemented]<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;Image&nbsp;data&nbsp;about&nbsp;the&nbsp;actor.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;that&nbsp;points&nbsp;to&nbsp;a&nbsp;thumbnail&nbsp;photo&nbsp;of&nbsp;the&nbsp;author.<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;the&nbsp;author,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.&nbsp;This&nbsp;is&nbsp;the&nbsp;person's&nbsp;OpenSocial&nbsp;ID.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;}<br>
&nbsp;<br>
&nbsp;&nbsp;communityId:&nbsp;integer,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;community&nbsp;whose&nbsp;poll&nbsp;is&nbsp;being&nbsp;commented.&nbsp;(required)<br>
&nbsp;&nbsp;pollId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;poll&nbsp;being&nbsp;commented.&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;&nbsp;&nbsp;"body":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;body&nbsp;of&nbsp;the&nbsp;message.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#communityPollComment",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;community&nbsp;poll&nbsp;comment.&nbsp;Value:&nbsp;"orkut#communityPollComment"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"addedDate":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;date&nbsp;when&nbsp;the&nbsp;message&nbsp;was&nbsp;added,&nbsp;in&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;format.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;42,&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"author":&nbsp;{&nbsp;#&nbsp;The&nbsp;creator&nbsp;of&nbsp;the&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;author&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment&nbsp;[not&nbsp;yet&nbsp;implemented]<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;Image&nbsp;data&nbsp;about&nbsp;the&nbsp;actor.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;that&nbsp;points&nbsp;to&nbsp;a&nbsp;thumbnail&nbsp;photo&nbsp;of&nbsp;the&nbsp;author.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;author,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.&nbsp;This&nbsp;is&nbsp;the&nbsp;person's&nbsp;OpenSocial&nbsp;ID.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&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;of&nbsp;a&nbsp;community&nbsp;poll.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<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.<br>
&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Specifies&nbsp;the&nbsp;interface&nbsp;language&nbsp;(host&nbsp;language)&nbsp;of&nbsp;your&nbsp;user&nbsp;interface.<br>
&nbsp;&nbsp;communityId:&nbsp;integer,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;community&nbsp;whose&nbsp;poll&nbsp;is&nbsp;having&nbsp;its&nbsp;comments&nbsp;listed.&nbsp;(required)<br>
&nbsp;&nbsp;pollId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;community&nbsp;whose&nbsp;polls&nbsp;will&nbsp;be&nbsp;listed.&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;The&nbsp;value&nbsp;of&nbsp;pageToken&nbsp;query&nbsp;parameter&nbsp;in&nbsp;community_poll_comments.list&nbsp;request&nbsp;to&nbsp;get&nbsp;the&nbsp;next&nbsp;page,&nbsp;if&nbsp;there&nbsp;are&nbsp;more&nbsp;to&nbsp;retrieve.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#CommunityPollCommentList",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;collection&nbsp;of&nbsp;community&nbsp;poll&nbsp;comments.&nbsp;Value:&nbsp;"orkut#CommunityPollCommentList"<br>
&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;community&nbsp;poll&nbsp;comments&nbsp;retrieved.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"body":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;body&nbsp;of&nbsp;the&nbsp;message.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#communityPollComment",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;community&nbsp;poll&nbsp;comment.&nbsp;Value:&nbsp;"orkut#communityPollComment"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"addedDate":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;date&nbsp;when&nbsp;the&nbsp;message&nbsp;was&nbsp;added,&nbsp;in&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;format.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;42,&nbsp;#&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;comment.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"author":&nbsp;{&nbsp;#&nbsp;The&nbsp;creator&nbsp;of&nbsp;the&nbsp;comment.<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;author&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment&nbsp;[not&nbsp;yet&nbsp;implemented]<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;Image&nbsp;data&nbsp;about&nbsp;the&nbsp;actor.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;that&nbsp;points&nbsp;to&nbsp;a&nbsp;thumbnail&nbsp;photo&nbsp;of&nbsp;the&nbsp;author.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"displayName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;author,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;identifier&nbsp;of&nbsp;the&nbsp;person&nbsp;who&nbsp;posted&nbsp;the&nbsp;comment.&nbsp;This&nbsp;is&nbsp;the&nbsp;person's&nbsp;OpenSocial&nbsp;ID.<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;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;"prevPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;value&nbsp;of&nbsp;pageToken&nbsp;query&nbsp;parameter&nbsp;in&nbsp;community_poll_comments.list&nbsp;request&nbsp;to&nbsp;get&nbsp;the&nbsp;previous&nbsp;page,&nbsp;if&nbsp;there&nbsp;are&nbsp;more&nbsp;to&nbsp;retrieve.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"lastPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;value&nbsp;of&nbsp;pageToken&nbsp;query&nbsp;parameter&nbsp;in&nbsp;community_poll_comments.list&nbsp;request&nbsp;to&nbsp;get&nbsp;the&nbsp;last&nbsp;page.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"firstPageToken":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;value&nbsp;of&nbsp;pageToken&nbsp;query&nbsp;parameter&nbsp;in&nbsp;community_poll_comments.list&nbsp;request&nbsp;to&nbsp;get&nbsp;the&nbsp;first&nbsp;page.<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