1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="orkut_v2.html">Orkut API</a> . <a href="orkut_v2.communityMembers.html">communityMembers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(communityId, userId)</a></code></p>
<p class="firstline">Makes the user leave a community.</p>
<p class="toc_element">
<code><a href="#get">get(communityId, userId, hl=None)</a></code></p>
<p class="firstline">Retrieves the relationship between a user and a community.</p>
<p class="toc_element">
<code><a href="#insert">insert(communityId, userId)</a></code></p>
<p class="firstline">Makes the user join a community.</p>
<p class="toc_element">
<code><a href="#list">list(communityId, friendsOnly=None, pageToken=None, hl=None, maxResults=None)</a></code></p>
<p class="firstline">Lists members of a community. Use the pagination tokens to retrieve the full list; do not rely on the member count available in the community profile information to know when to stop iterating, as that count may be approximate.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(communityId, userId)</code>
<pre>Makes the user leave a community.
Args:
communityId: integer, ID of the community. (required)
userId: string, ID of the user. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(communityId, userId, hl=None)</code>
<pre>Retrieves the relationship between a user and a community.
Args:
communityId: integer, ID of the community. (required)
userId: string, ID of the user. (required)
hl: string, Specifies the interface language (host language) of your user interface.
Returns:
An object of the form:
{
"communityMembershipStatus": { # Status and permissions of the user related to the community.
"status": "A String", # The status of the current link between the community and the user.
"isFollowing": True or False, # Whether the user is following this community.
"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
"isModerator": True or False, # Whether the session user is a community moderator.
"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
"isCoOwner": True or False, # Whether the session user is a community co-owner.
"canCreatePoll": True or False, # Whether the user can create a poll in this community.
"canShout": True or False, # Whether the user can perform a shout operation in this community.
"isOwner": True or False, # Whether the session user is the community owner.
"canCreateTopic": True or False, # Whether the user can create a topic in this community.
"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
},
"person": { # Description of the community member.
"name": { # An object that encapsulates the individual components of a person's name.
"givenName": "A String", # The given name (first name) of this person.
"familyName": "A String", # The family name (last name) of this person.
},
"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"gender": "A String", # The person's gender. Values include "male", "female", and "other".
"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"url": "A String", # The URL of the person's profile photo.
},
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
"id": "A String", # The person's opensocial ID.
},
"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(communityId, userId)</code>
<pre>Makes the user join a community.
Args:
communityId: integer, ID of the community. (required)
userId: string, ID of the user. (required)
Returns:
An object of the form:
{
"communityMembershipStatus": { # Status and permissions of the user related to the community.
"status": "A String", # The status of the current link between the community and the user.
"isFollowing": True or False, # Whether the user is following this community.
"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
"isModerator": True or False, # Whether the session user is a community moderator.
"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
"isCoOwner": True or False, # Whether the session user is a community co-owner.
"canCreatePoll": True or False, # Whether the user can create a poll in this community.
"canShout": True or False, # Whether the user can perform a shout operation in this community.
"isOwner": True or False, # Whether the session user is the community owner.
"canCreateTopic": True or False, # Whether the user can create a topic in this community.
"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
},
"person": { # Description of the community member.
"name": { # An object that encapsulates the individual components of a person's name.
"givenName": "A String", # The given name (first name) of this person.
"familyName": "A String", # The family name (last name) of this person.
},
"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"gender": "A String", # The person's gender. Values include "male", "female", and "other".
"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"url": "A String", # The URL of the person's profile photo.
},
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
"id": "A String", # The person's opensocial ID.
},
"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(communityId, friendsOnly=None, pageToken=None, hl=None, maxResults=None)</code>
<pre>Lists members of a community. Use the pagination tokens to retrieve the full list; do not rely on the member count available in the community profile information to know when to stop iterating, as that count may be approximate.
Args:
communityId: integer, The ID of the community whose members will be listed. (required)
friendsOnly: boolean, Whether to list only community members who are friends of the user.
pageToken: string, A continuation token that allows pagination.
hl: string, Specifies the interface language (host language) of your user interface.
maxResults: integer, The maximum number of members to include in the response.
Returns:
An object of the form:
{
"nextPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the next page, if there are more to retrieve.
"kind": "orkut#communityMembersList", # Kind of this item. Always orkut#communityMembersList.
"items": [ # List of community members retrieved.
{
"communityMembershipStatus": { # Status and permissions of the user related to the community.
"status": "A String", # The status of the current link between the community and the user.
"isFollowing": True or False, # Whether the user is following this community.
"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
"isModerator": True or False, # Whether the session user is a community moderator.
"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
"isCoOwner": True or False, # Whether the session user is a community co-owner.
"canCreatePoll": True or False, # Whether the user can create a poll in this community.
"canShout": True or False, # Whether the user can perform a shout operation in this community.
"isOwner": True or False, # Whether the session user is the community owner.
"canCreateTopic": True or False, # Whether the user can create a topic in this community.
"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
},
"person": { # Description of the community member.
"name": { # An object that encapsulates the individual components of a person's name.
"givenName": "A String", # The given name (first name) of this person.
"familyName": "A String", # The family name (last name) of this person.
},
"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"gender": "A String", # The person's gender. Values include "male", "female", and "other".
"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"url": "A String", # The URL of the person's profile photo.
},
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
"id": "A String", # The person's opensocial ID.
},
"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
},
],
"prevPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the previous page, if there are more to retrieve.
"lastPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the last page.
"firstPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the first page.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
