| Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -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 | |
| 17 | <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Remove a person from a group<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | personId: ID of the person to remove from the group. (required)<br> |
| 21 | alt: Specifies an alternative representation type.<br> |
| 22 | userId: ID of the owner of the group. (required)<br> |
| 23 | groupId: ID of the group from which to remove the person. (required)<br> |
| 24 | hl: Language code to limit language results.</tt></dd></dl> |
| 25 | |
| 26 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a user profile<br> |
| 27 | <br> |
| 28 | Args:<br> |
| 29 | alt: Specifies an alternative representation type.<br> |
| 30 | userId: ID of the user being referenced. (required)<br> |
| 31 | hl: Language code to limit language results.</tt></dd></dl> |
| 32 | |
| 33 | <dl><dt><a name="Resource-liked"><strong>liked</strong></a> = method(self, **kwargs)</dt><dd><tt>Get people who liked an activity<br> |
| 34 | <br> |
| 35 | Args:<br> |
| 36 | c: A continuation token that allows pagination.<br> |
| 37 | userId: ID of the user being referenced. (required)<br> |
| 38 | max_results: Maximum number of results to include.<br> |
| 39 | hl: Language code to limit language results.<br> |
| 40 | scope: A parameter (required)<br> |
| 41 | alt: Specifies an alternative representation type.<br> |
| 42 | postId: ID of the activity that was liked. (required)<br> |
| 43 | groupId: A parameter (required)</tt></dd></dl> |
| 44 | |
| 45 | <dl><dt><a name="Resource-liked_next"><strong>liked_next</strong></a> = methodNext(self, previous)</dt><dd><tt>Takes a single argument, 'body', which is the results<br> |
| 46 | from the last call, and returns the next set of items<br> |
| 47 | in the collection.<br> |
| 48 | <br> |
| 49 | Returns None if there are no more items in<br> |
| 50 | the collection.</tt></dd></dl> |
| 51 | |
| 52 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Get people in a group<br> |
| 53 | <br> |
| 54 | Args:<br> |
| 55 | c: A continuation token that allows pagination.<br> |
| 56 | userId: ID of the user being referenced. (required)<br> |
| 57 | max_results: Maximum number of results to include.<br> |
| 58 | hl: Language code to limit language results.<br> |
| 59 | alt: Specifies an alternative representation type.<br> |
| 60 | groupId: ID of the group for which to list users. (required)</tt></dd></dl> |
| 61 | |
| 62 | <dl><dt><a name="Resource-reshared"><strong>reshared</strong></a> = method(self, **kwargs)</dt><dd><tt>Get people who reshared an activity<br> |
| 63 | <br> |
| 64 | Args:<br> |
| 65 | c: A continuation token that allows pagination.<br> |
| 66 | userId: ID of the user being referenced. (required)<br> |
| 67 | max_results: Maximum number of results to include.<br> |
| 68 | hl: Language code to limit language results.<br> |
| 69 | scope: A parameter (required)<br> |
| 70 | alt: Specifies an alternative representation type.<br> |
| 71 | postId: ID of the activity that was reshared. (required)<br> |
| 72 | groupId: A parameter (required)</tt></dd></dl> |
| 73 | |
| 74 | <dl><dt><a name="Resource-search"><strong>search</strong></a> = method(self, **kwargs)</dt><dd><tt>Search for people<br> |
| 75 | <br> |
| 76 | Args:<br> |
| 77 | q: Full-text search query string.<br> |
| 78 | c: A continuation token that allows pagination.<br> |
| 79 | max_results: Maximum number of results to include.<br> |
| 80 | alt: Specifies an alternative representation type.<br> |
| 81 | hl: Language code to limit language results.</tt></dd></dl> |
| 82 | |
| 83 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Add a person to a group<br> |
| 84 | <br> |
| 85 | Args:<br> |
| 86 | body: The request body.<br> |
| 87 | personId: ID of the person to add to the group. (required)<br> |
| 88 | userId: ID of the owner of the group. (required)<br> |
| 89 | hl: Language code to limit language results.<br> |
| 90 | alt: Specifies an alternative representation type.<br> |
| 91 | groupId: ID of the group to which to add the person. (required)</tt></dd></dl> |
| 92 | |
| 93 | <hr> |
| 94 | Data descriptors defined here:<br> |
| 95 | <dl><dt><strong>__dict__</strong></dt> |
| 96 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 97 | </dl> |
| 98 | <dl><dt><strong>__weakref__</strong></dt> |
| 99 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 100 | </dl> |
| 101 | </td></tr></table> |
| 102 | </body></html> |