152 lines
16 KiB
HTML
152 lines
16 KiB
HTML
|
|
<!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> <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> </tt></td>
|
|
<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
|
|
<tr><td> </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 the profile of a community.<br>
|
|
<br>
|
|
Args:<br>
|
|
hl: string, Specifies the interface language (host language) of your user interface.<br>
|
|
communityId: integer, The ID of the community to get. (required)<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"category": "A String", # The category of the community.<br>
|
|
"kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"<br>
|
|
"member_count": 42, # The count of members on the community.<br>
|
|
"description": "A String", # The description of the community.<br>
|
|
"language": "A String", # The official language of the community.<br>
|
|
"links": [ # List of resources for the community.<br>
|
|
{ # Links to resources related to the parent object.<br>
|
|
"href": "A String", # URL of the link.<br>
|
|
"type": "A String", # Media type of the link.<br>
|
|
"rel": "A String", # Relation between the resource and the parent object.<br>
|
|
"title": "A String", # Title of the link.<br>
|
|
},<br>
|
|
],<br>
|
|
"creation_date": "A String", # The time the community was created, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br>
|
|
"owner": { # The person who owns the community.<br>
|
|
"url": "A String", # The URL of the author who posted the comment [not yet implemented]<br>
|
|
"image": { # Image data about the actor.<br>
|
|
"url": "A String", # A URL that points to a thumbnail photo of the author.<br>
|
|
},<br>
|
|
"displayName": "A String", # The name of the author, suitable for display.<br>
|
|
"id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br>
|
|
},<br>
|
|
"moderators": [ # The moderator of the community.<br>
|
|
{<br>
|
|
"url": "A String", # The URL of the author who posted the comment [not yet implemented]<br>
|
|
"image": { # Image data about the actor.<br>
|
|
"url": "A String", # A URL that points to a thumbnail photo of the author.<br>
|
|
},<br>
|
|
"displayName": "A String", # The name of the author, suitable for display.<br>
|
|
"id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br>
|
|
},<br>
|
|
],<br>
|
|
"location": "A String", # The location of the community.<br>
|
|
"co_owners": [ # The co-owners of the community.<br>
|
|
{<br>
|
|
"url": "A String", # The URL of the author who posted the comment [not yet implemented]<br>
|
|
"image": { # Image data about the actor.<br>
|
|
"url": "A String", # A URL that points to a thumbnail photo of the author.<br>
|
|
},<br>
|
|
"displayName": "A String", # The name of the author, suitable for display.<br>
|
|
"id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br>
|
|
},<br>
|
|
],<br>
|
|
"photo_url": "A String", # The photo of the community.<br>
|
|
"id": 42, # The id of the community.<br>
|
|
"name": "A String", # The name of the community.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the communities an user is member of.<br>
|
|
<br>
|
|
Args:<br>
|
|
orderBy: string, How to order the communities by.<br>
|
|
Allowed values<br>
|
|
id - Returns the communities sorted by a fixed, natural order.<br>
|
|
ranked - Returns the communities ranked accordingly to how they are displayed on the orkut web application.<br>
|
|
userId: string, The ID of the user whose communities will be listed. Can be me to refer to caller. (required)<br>
|
|
maxResults: integer, The maximum number of communities to include in the response.<br>
|
|
hl: string, Specifies the interface language (host language) of your user interface.<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"items": [ # List of communities retrieved.<br>
|
|
{<br>
|
|
"category": "A String", # The category of the community.<br>
|
|
"kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"<br>
|
|
"member_count": 42, # The count of members on the community.<br>
|
|
"description": "A String", # The description of the community.<br>
|
|
"language": "A String", # The official language of the community.<br>
|
|
"links": [ # List of resources for the community.<br>
|
|
{ # Links to resources related to the parent object.<br>
|
|
"href": "A String", # URL of the link.<br>
|
|
"type": "A String", # Media type of the link.<br>
|
|
"rel": "A String", # Relation between the resource and the parent object.<br>
|
|
"title": "A String", # Title of the link.<br>
|
|
},<br>
|
|
],<br>
|
|
"creation_date": "A String", # The time the community was created, in <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> format.<br>
|
|
"owner": { # The person who owns the community.<br>
|
|
"url": "A String", # The URL of the author who posted the comment [not yet implemented]<br>
|
|
"image": { # Image data about the actor.<br>
|
|
"url": "A String", # A URL that points to a thumbnail photo of the author.<br>
|
|
},<br>
|
|
"displayName": "A String", # The name of the author, suitable for display.<br>
|
|
"id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br>
|
|
},<br>
|
|
"moderators": [ # The moderator of the community.<br>
|
|
{<br>
|
|
"url": "A String", # The URL of the author who posted the comment [not yet implemented]<br>
|
|
"image": { # Image data about the actor.<br>
|
|
"url": "A String", # A URL that points to a thumbnail photo of the author.<br>
|
|
},<br>
|
|
"displayName": "A String", # The name of the author, suitable for display.<br>
|
|
"id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br>
|
|
},<br>
|
|
],<br>
|
|
"location": "A String", # The location of the community.<br>
|
|
"co_owners": [ # The co-owners of the community.<br>
|
|
{<br>
|
|
"url": "A String", # The URL of the author who posted the comment [not yet implemented]<br>
|
|
"image": { # Image data about the actor.<br>
|
|
"url": "A String", # A URL that points to a thumbnail photo of the author.<br>
|
|
},<br>
|
|
"displayName": "A String", # The name of the author, suitable for display.<br>
|
|
"id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br>
|
|
},<br>
|
|
],<br>
|
|
"photo_url": "A String", # The photo of the community.<br>
|
|
"id": 42, # The id of the community.<br>
|
|
"name": "A String", # The name of the community.<br>
|
|
},<br>
|
|
],<br>
|
|
"kind": "orkut#communityList", # Identifies this resource as a collection of communities. Value: "orkut#communityList"<br>
|
|
}</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
</td></tr></table>
|
|
</body></html> |