docs/dyn/orkut.v2.communityRelated.html - platform/external/python/google-api-python-client - Gitiles


 <!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-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves&nbsp;the&nbsp;communities&nbsp;related&nbsp;to&nbsp;another&nbsp;one.<br>
 &nbsp;<br>
 Args:<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;related&nbsp;communities&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;"items":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;communities&nbsp;retrieved.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;category&nbsp;of&nbsp;the&nbsp;community.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#community",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;community.&nbsp;Value:&nbsp;"orkut#community"<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"member_count":&nbsp;42,&nbsp;#&nbsp;The&nbsp;number&nbsp;of&nbsp;users&nbsp;who&nbsp;are&nbsp;part&nbsp;of&nbsp;the&nbsp;community.&nbsp;This&nbsp;number&nbsp;may&nbsp;be&nbsp;approximate,&nbsp;so&nbsp;do&nbsp;not&nbsp;rely&nbsp;on&nbsp;it&nbsp;for&nbsp;iteration.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;description&nbsp;of&nbsp;the&nbsp;community.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"language":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;official&nbsp;language&nbsp;of&nbsp;the&nbsp;community.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;community.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;resources&nbsp;related&nbsp;to&nbsp;the&nbsp;parent&nbsp;object.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;link.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Media&nbsp;type&nbsp;of&nbsp;the&nbsp;link.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Relation&nbsp;between&nbsp;the&nbsp;resource&nbsp;and&nbsp;the&nbsp;parent&nbsp;object.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;link.<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;"creation_date":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;time&nbsp;the&nbsp;community&nbsp;was&nbsp;created,&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;"owner":&nbsp;{&nbsp;#&nbsp;The&nbsp;person&nbsp;who&nbsp;owns&nbsp;the&nbsp;community.<br>
 &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;"image":&nbsp;{&nbsp;#&nbsp;Image&nbsp;data&nbsp;about&nbsp;the&nbsp;author.<br>
 &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;},<br>
 &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;"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;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"moderators":&nbsp;[&nbsp;#&nbsp;The&nbsp;list&nbsp;of&nbsp;moderators&nbsp;of&nbsp;the&nbsp;community.<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;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;author.<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;&nbsp;&nbsp;&nbsp;&nbsp;"location":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;location&nbsp;of&nbsp;the&nbsp;community.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"co_owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;co-owners&nbsp;of&nbsp;the&nbsp;community.<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;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;author.<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;&nbsp;&nbsp;&nbsp;&nbsp;"photo_url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;photo&nbsp;of&nbsp;the&nbsp;community.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;42,&nbsp;#&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;community.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;name&nbsp;of&nbsp;the&nbsp;community.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#communityList",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;collection&nbsp;of&nbsp;communities.&nbsp;Value:&nbsp;"orkut#communityList"<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>

	<!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-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the communities related to another one.<br>
	<br>
	Args:<br>
	hl: string, Specifies the interface language (host language) of your user interface.<br>
	communityId: integer, The ID of the community whose related communities will be listed. (required)<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 number of users who are part of the community. This number may be approximate, so do not rely on it for iteration.<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 author.<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 list of moderators 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 author.<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 author.<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>