Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c8e421c03c1e22f35060229ea1c696a85d9a3dbc / . / docs / dyn / orkut.v2.communityRelated.html
blob: d4d20e6fe6d6f784486d52b9e2d8e794883f1a81 [file] [log] [blame]
Joe Gregorio945cca12012-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>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</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&nbsp;the&nbsp;communities&nbsp;related&nbsp;to&nbsp;another&nbsp;one.<br>
18&nbsp;<br>
19Args:<br>
20&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>
21&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>
22&nbsp;<br>
23Returns:<br>
24&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
25&nbsp;<br>
26&nbsp;&nbsp;&nbsp;&nbsp;{<br>
27&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;communities&nbsp;retrieved.<br>
28&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
29&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>
30&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>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame]31&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>
Joe Gregorio945cca12012-02-21 11:59:48 -0500[diff] [blame]32&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>
33&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>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;community.<br>
35&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>
36&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>
37&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>
38&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>
39&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>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
42&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>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owner":&nbsp;{&nbsp;#&nbsp;The&nbsp;person&nbsp;who&nbsp;owns&nbsp;the&nbsp;community.<br>
44&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>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame]45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;Image&nbsp;data&nbsp;about&nbsp;the&nbsp;author.<br>
Joe Gregorio945cca12012-02-21 11:59:48 -0500[diff] [blame]46&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>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
48&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>
49&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>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame]51&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>
Joe Gregorio945cca12012-02-21 11:59:48 -0500[diff] [blame]52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
53&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>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame]54&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>
Joe Gregorio945cca12012-02-21 11:59:48 -0500[diff] [blame]55&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>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
57&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>
58&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>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
60&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
61&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>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"co_owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;co-owners&nbsp;of&nbsp;the&nbsp;community.<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
64&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>
Joe Gregoriodf70dfc2012-04-23 08:31:37 -0400[diff] [blame]65&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>
Joe Gregorio945cca12012-02-21 11:59:48 -0500[diff] [blame]66&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>
67&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
68&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>
69&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>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
72&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>
73&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;42,&nbsp;#&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;community.<br>
74&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>
75&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
76&nbsp;&nbsp;&nbsp;&nbsp;],<br>
77&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>
78&nbsp;&nbsp;}</tt></dd></dl>
79
80<hr>
81Data descriptors defined here:<br>
82<dl><dt><strong>__dict__</strong></dt>
83<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
84</dl>
85<dl><dt><strong>__weakref__</strong></dt>
86<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
87</dl>
88</td></tr></table>
89</body></html>