Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: class Resource</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | <p> |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 7 | <tr bgcolor="#ffc8d8"> |
| 8 | <td colspan=3 valign=bottom> <br> |
| 9 | <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> |
| 10 | |
| 11 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </td> |
| 14 | <td width="100%">Methods defined here:<br> |
| 15 | <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| 16 | |
| 17 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the communities related to another one.<br> |
| 18 | <br> |
| 19 | Args:<br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 20 | pp: string, A parameter<br> |
| 21 | trace: string, A parameter<br> |
Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 22 | hl: string, Specifies the interface language (host language) of your user interface.<br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 23 | strict: string, A parameter<br> |
| 24 | userip: string, A parameter<br> |
Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 25 | communityId: integer, The ID of the community whose related communities will be listed. (required)<br> |
| 26 | <br> |
| 27 | Returns:<br> |
| 28 | An object of the form<br> |
| 29 | <br> |
| 30 | {<br> |
| 31 | "items": [ # List of communities retrieved.<br> |
| 32 | {<br> |
| 33 | "category": "A String", # The category of the community.<br> |
| 34 | "kind": "orkut#community", # Identifies this resource as a community. Value: "orkut#community"<br> |
Joe Gregorio | df70dfc | 2012-04-23 08:31:37 -0400 | [diff] [blame] | 35 | "member_count": 42, # The number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.<br> |
Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 36 | "description": "A String", # The description of the community.<br> |
| 37 | "language": "A String", # The official language of the community.<br> |
| 38 | "links": [ # List of resources for the community.<br> |
| 39 | { # Links to resources related to the parent object.<br> |
| 40 | "href": "A String", # URL of the link.<br> |
| 41 | "type": "A String", # Media type of the link.<br> |
| 42 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 43 | "title": "A String", # Title of the link.<br> |
| 44 | },<br> |
| 45 | ],<br> |
| 46 | "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> |
| 47 | "owner": { # The person who owns the community.<br> |
| 48 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
Joe Gregorio | df70dfc | 2012-04-23 08:31:37 -0400 | [diff] [blame] | 49 | "image": { # Image data about the author.<br> |
Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 50 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 51 | },<br> |
| 52 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 53 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 54 | },<br> |
Joe Gregorio | df70dfc | 2012-04-23 08:31:37 -0400 | [diff] [blame] | 55 | "moderators": [ # The list of moderators of the community.<br> |
Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 56 | {<br> |
| 57 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
Joe Gregorio | df70dfc | 2012-04-23 08:31:37 -0400 | [diff] [blame] | 58 | "image": { # Image data about the author.<br> |
Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 59 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 60 | },<br> |
| 61 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 62 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 63 | },<br> |
| 64 | ],<br> |
| 65 | "location": "A String", # The location of the community.<br> |
| 66 | "co_owners": [ # The co-owners of the community.<br> |
| 67 | {<br> |
| 68 | "url": "A String", # The URL of the author who posted the comment [not yet implemented]<br> |
Joe Gregorio | df70dfc | 2012-04-23 08:31:37 -0400 | [diff] [blame] | 69 | "image": { # Image data about the author.<br> |
Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 70 | "url": "A String", # A URL that points to a thumbnail photo of the author.<br> |
| 71 | },<br> |
| 72 | "displayName": "A String", # The name of the author, suitable for display.<br> |
| 73 | "id": "A String", # Unique identifier of the person who posted the comment. This is the person's OpenSocial ID.<br> |
| 74 | },<br> |
| 75 | ],<br> |
| 76 | "photo_url": "A String", # The photo of the community.<br> |
| 77 | "id": 42, # The id of the community.<br> |
| 78 | "name": "A String", # The name of the community.<br> |
| 79 | },<br> |
| 80 | ],<br> |
| 81 | "kind": "orkut#communityList", # Identifies this resource as a collection of communities. Value: "orkut#communityList"<br> |
| 82 | }</tt></dd></dl> |
| 83 | |
| 84 | <hr> |
| 85 | Data descriptors defined here:<br> |
| 86 | <dl><dt><strong>__dict__</strong></dt> |
| 87 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 88 | </dl> |
| 89 | <dl><dt><strong>__weakref__</strong></dt> |
| 90 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 91 | </dl> |
| 92 | </td></tr></table> |
| 93 | </body></html> |