172 lines
20 KiB
HTML
172 lines
20 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-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Makes the user leave a community.<br>
|
|
<br>
|
|
Args:<br>
|
|
userId: string, ID of the user. (required)<br>
|
|
communityId: integer, ID of the community. (required)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves the relationship between a user and a community.<br>
|
|
<br>
|
|
Args:<br>
|
|
userId: string, ID of the user. (required)<br>
|
|
hl: string, Specifies the interface language (host language) of your user interface.<br>
|
|
communityId: integer, ID of the community. (required)<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"communityMembershipStatus": { # Status and permissions of the user related to the community.<br>
|
|
"status": "A String", # The status of the current link between the community and the user.<br>
|
|
"isFollowing": True or False, # Whether the user is following this community.<br>
|
|
"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.<br>
|
|
"isModerator": True or False, # Whether the session user is a community moderator.<br>
|
|
"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.<br>
|
|
"isCoOwner": True or False, # Whether the session user is a community co-owner.<br>
|
|
"canCreatePoll": True or False, # Whether the user can create a poll in this community.<br>
|
|
"canShout": True or False, # Whether the user can perform a shout operation in this community.<br>
|
|
"isOwner": True or False, # Whether the session user is the community owner.<br>
|
|
"canCreateTopic": True or False, # Whether the user can create a topic in this community.<br>
|
|
"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.<br>
|
|
},<br>
|
|
"person": { # Description of the community member.<br>
|
|
"name": { # An object that encapsulates the individual components of a person's name.<br>
|
|
"givenName": "A String", # The given name (first name) of this person.<br>
|
|
"familyName": "A String", # The family name (last name) of this person.<br>
|
|
},<br>
|
|
"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br>
|
|
"gender": "A String", # The person's gender. Values include "male", "female", and "other".<br>
|
|
"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br>
|
|
"url": "A String", # The URL of the person's profile photo.<br>
|
|
},<br>
|
|
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.<br>
|
|
"id": "A String", # The person's opensocial ID.<br>
|
|
},<br>
|
|
"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Makes the user join a community.<br>
|
|
<br>
|
|
Args:<br>
|
|
userId: string, ID of the user. (required)<br>
|
|
communityId: integer, ID of the community. (required)<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"communityMembershipStatus": { # Status and permissions of the user related to the community.<br>
|
|
"status": "A String", # The status of the current link between the community and the user.<br>
|
|
"isFollowing": True or False, # Whether the user is following this community.<br>
|
|
"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.<br>
|
|
"isModerator": True or False, # Whether the session user is a community moderator.<br>
|
|
"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.<br>
|
|
"isCoOwner": True or False, # Whether the session user is a community co-owner.<br>
|
|
"canCreatePoll": True or False, # Whether the user can create a poll in this community.<br>
|
|
"canShout": True or False, # Whether the user can perform a shout operation in this community.<br>
|
|
"isOwner": True or False, # Whether the session user is the community owner.<br>
|
|
"canCreateTopic": True or False, # Whether the user can create a topic in this community.<br>
|
|
"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.<br>
|
|
},<br>
|
|
"person": { # Description of the community member.<br>
|
|
"name": { # An object that encapsulates the individual components of a person's name.<br>
|
|
"givenName": "A String", # The given name (first name) of this person.<br>
|
|
"familyName": "A String", # The family name (last name) of this person.<br>
|
|
},<br>
|
|
"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br>
|
|
"gender": "A String", # The person's gender. Values include "male", "female", and "other".<br>
|
|
"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br>
|
|
"url": "A String", # The URL of the person's profile photo.<br>
|
|
},<br>
|
|
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.<br>
|
|
"id": "A String", # The person's opensocial ID.<br>
|
|
},<br>
|
|
"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists members of a community.<br>
|
|
<br>
|
|
Args:<br>
|
|
friendsOnly: boolean, Whether to list only community members who are friends of the user.<br>
|
|
pageToken: string, A continuation token that allows pagination.<br>
|
|
maxResults: integer, The maximum number of members to include in the response.<br>
|
|
hl: string, Specifies the interface language (host language) of your user interface.<br>
|
|
communityId: integer, The ID of the community whose members will be listed. (required)<br>
|
|
<br>
|
|
Returns:<br>
|
|
An object of the form<br>
|
|
<br>
|
|
{<br>
|
|
"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.<br>
|
|
"kind": "orkut#communityMembersList", # Kind of this item. Always orkut#communityMembersList.<br>
|
|
"items": [ # List of community members retrieved.<br>
|
|
{<br>
|
|
"communityMembershipStatus": { # Status and permissions of the user related to the community.<br>
|
|
"status": "A String", # The status of the current link between the community and the user.<br>
|
|
"isFollowing": True or False, # Whether the user is following this community.<br>
|
|
"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.<br>
|
|
"isModerator": True or False, # Whether the session user is a community moderator.<br>
|
|
"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.<br>
|
|
"isCoOwner": True or False, # Whether the session user is a community co-owner.<br>
|
|
"canCreatePoll": True or False, # Whether the user can create a poll in this community.<br>
|
|
"canShout": True or False, # Whether the user can perform a shout operation in this community.<br>
|
|
"isOwner": True or False, # Whether the session user is the community owner.<br>
|
|
"canCreateTopic": True or False, # Whether the user can create a topic in this community.<br>
|
|
"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.<br>
|
|
},<br>
|
|
"person": { # Description of the community member.<br>
|
|
"name": { # An object that encapsulates the individual components of a person's name.<br>
|
|
"givenName": "A String", # The given name (first name) of this person.<br>
|
|
"familyName": "A String", # The family name (last name) of this person.<br>
|
|
},<br>
|
|
"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br>
|
|
"gender": "A String", # The person's gender. Values include "male", "female", and "other".<br>
|
|
"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br>
|
|
"url": "A String", # The URL of the person's profile photo.<br>
|
|
},<br>
|
|
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.<br>
|
|
"id": "A String", # The person's opensocial ID.<br>
|
|
},<br>
|
|
"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.<br>
|
|
},<br>
|
|
],<br>
|
|
"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.<br>
|
|
"lastPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the last page.<br>
|
|
"firstPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the first page.<br>
|
|
}</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br>
|
|
<br>
|
|
Args:<br>
|
|
previous_request: The request for the previous page.<br>
|
|
previous_response: The response from the request for the previous page.<br>
|
|
<br>
|
|
Returns:<br>
|
|
A request object that you can call 'execute()' on to request the next<br>
|
|
page. Returns None if there are no more items in the collection.</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> |