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 | |
Joe Gregorio | df70dfc | 2012-04-23 08:31:37 -0400 | [diff] [blame] | 17 | <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Removes a user from the followers of a community.<br> |
Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 18 | <br> |
| 19 | Args:<br> |
| 20 | userId: string, ID of the user. (required)<br> |
| 21 | communityId: integer, ID of the community. (required)</tt></dd></dl> |
| 22 | |
Joe Gregorio | df70dfc | 2012-04-23 08:31:37 -0400 | [diff] [blame] | 23 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds a user as a follower of a community.<br> |
Joe Gregorio | 945cca1 | 2012-02-21 11:59:48 -0500 | [diff] [blame] | 24 | <br> |
| 25 | Args:<br> |
| 26 | userId: string, ID of the user. (required)<br> |
| 27 | communityId: integer, ID of the community. (required)<br> |
| 28 | <br> |
| 29 | Returns:<br> |
| 30 | An object of the form<br> |
| 31 | <br> |
| 32 | {<br> |
| 33 | "communityMembershipStatus": { # Status and permissions of the user related to the community.<br> |
| 34 | "status": "A String", # The status of the current link between the community and the user.<br> |
| 35 | "isFollowing": True or False, # Whether the user is following this community.<br> |
| 36 | "isRestoreAvailable": True or False, # Whether the restore operation is available for the community.<br> |
| 37 | "isModerator": True or False, # Whether the session user is a community moderator.<br> |
| 38 | "kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.<br> |
| 39 | "isCoOwner": True or False, # Whether the session user is a community co-owner.<br> |
| 40 | "canCreatePoll": True or False, # Whether the user can create a poll in this community.<br> |
| 41 | "canShout": True or False, # Whether the user can perform a shout operation in this community.<br> |
| 42 | "isOwner": True or False, # Whether the session user is the community owner.<br> |
| 43 | "canCreateTopic": True or False, # Whether the user can create a topic in this community.<br> |
| 44 | "isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.<br> |
| 45 | },<br> |
| 46 | "person": { # Description of the community member.<br> |
| 47 | "name": { # An object that encapsulates the individual components of a person's name.<br> |
| 48 | "givenName": "A String", # The given name (first name) of this person.<br> |
| 49 | "familyName": "A String", # The family name (last name) of this person.<br> |
| 50 | },<br> |
| 51 | "url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br> |
| 52 | "gender": "A String", # The person's gender. Values include "male", "female", and "other".<br> |
| 53 | "image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br> |
| 54 | "url": "A String", # The URL of the person's profile photo.<br> |
| 55 | },<br> |
| 56 | "birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.<br> |
| 57 | "id": "A String", # The person's opensocial ID.<br> |
| 58 | },<br> |
| 59 | "kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.<br> |
| 60 | }</tt></dd></dl> |
| 61 | |
| 62 | <hr> |
| 63 | Data descriptors defined here:<br> |
| 64 | <dl><dt><strong>__dict__</strong></dt> |
| 65 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 66 | </dl> |
| 67 | <dl><dt><strong>__weakref__</strong></dt> |
| 68 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 69 | </dl> |
| 70 | </td></tr></table> |
| 71 | </body></html> |