openstack/deb-python-oauth2client
Code Issues Proposed changes
Files
d02bf5ee3860a50d36f960cd2c90ab6d1ecec7cd
deb-python-oauth2client/docs/dyn/orkut.v2.badges.html
Joe Gregorio b417caf3c9 Updated generated docs
2011-12-08 12:04:24 -05:00

72 lines
5.6 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>Retrieves&nbsp;a&nbsp;badge&nbsp;from&nbsp;a&nbsp;user.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;badgeId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;badge&nbsp;that&nbsp;will&nbsp;be&nbsp;retrieved.&nbsp;(required)<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;badges&nbsp;will&nbsp;be&nbsp;listed.&nbsp;Can&nbsp;be&nbsp;me&nbsp;to&nbsp;refer&nbsp;to&nbsp;caller.&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;"badgeSmallLogo":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;for&nbsp;the&nbsp;24x24&nbsp;badge&nbsp;logo.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#badge",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;badge.&nbsp;Value:&nbsp;"orkut#badge"<br>
&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description&nbsp;for&nbsp;the&nbsp;badge,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"sponsorLogo":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;for&nbsp;the&nbsp;32x32&nbsp;badge&nbsp;sponsor&nbsp;logo.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"sponsorName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;badge&nbsp;sponsor,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"badgeLargeLogo":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;for&nbsp;the&nbsp;64x64&nbsp;badge&nbsp;logo.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"caption":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;badge,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"sponsorUrl":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;for&nbsp;the&nbsp;badge&nbsp;sponsor.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;ID&nbsp;for&nbsp;the&nbsp;badge.<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;list&nbsp;of&nbsp;visible&nbsp;badges&nbsp;of&nbsp;a&nbsp;user.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;badges&nbsp;will&nbsp;be&nbsp;listed.&nbsp;Can&nbsp;be&nbsp;me&nbsp;to&nbsp;refer&nbsp;to&nbsp;caller.&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;List&nbsp;of&nbsp;badges&nbsp;retrieved.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"badgeSmallLogo":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;for&nbsp;the&nbsp;24x24&nbsp;badge&nbsp;logo.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#badge",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;badge.&nbsp;Value:&nbsp;"orkut#badge"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description&nbsp;for&nbsp;the&nbsp;badge,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sponsorLogo":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;for&nbsp;the&nbsp;32x32&nbsp;badge&nbsp;sponsor&nbsp;logo.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sponsorName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;badge&nbsp;sponsor,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"badgeLargeLogo":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;for&nbsp;the&nbsp;64x64&nbsp;badge&nbsp;logo.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"caption":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;badge,&nbsp;suitable&nbsp;for&nbsp;display.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sponsorUrl":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;for&nbsp;the&nbsp;badge&nbsp;sponsor.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;ID&nbsp;for&nbsp;the&nbsp;badge.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#badgeList",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;collection&nbsp;of&nbsp;badges.&nbsp;Value:&nbsp;"orkut#badgeList"<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>
View Git Blame Copy Permalink