| Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get an activity.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | activityId: string, The ID of the activity to get. (required)<br> |
| 21 | alt: string, Specifies an alternative representation type.<br> |
| 22 | Allowed values<br> |
| 23 | json - Use JSON format</tt></dd></dl> |
| 24 | |
| 25 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List all of the activities in the specified collection for a particular user.<br> |
| 26 | <br> |
| 27 | Args:<br> |
| 28 | pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.<br> |
| 29 | userId: string, The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. (required)<br> |
| 30 | maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.<br> |
| 31 | collection: string, The collection of activities to list. (required)<br> |
| 32 | Allowed values<br> |
| 33 | public - All public activities created by the specified user.<br> |
| 34 | alt: string, Specifies an alternative representation type.<br> |
| 35 | Allowed values<br> |
| 36 | json - Use JSON format</tt></dd></dl> |
| 37 | |
| 38 | <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> |
| 39 | <br> |
| 40 | Args:<br> |
| 41 | previous_request: The request for the previous page.<br> |
| 42 | previous_response: The response from the request for the previous page.<br> |
| 43 | <br> |
| 44 | Returns:<br> |
| 45 | A request object that you can call 'execute()' on to request the next<br> |
| 46 | page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| 47 | |
| 48 | <dl><dt><a name="Resource-search"><strong>search</strong></a> = method(self, **kwargs)</dt><dd><tt>Search public activities.<br> |
| 49 | <br> |
| 50 | Args:<br> |
| 51 | orderBy: string, Specifies how to order search results.<br> |
| 52 | Allowed values<br> |
| 53 | best - Sort activities by relevance to the user, most relevant first.<br> |
| 54 | recent - Sort activities by published date, most recent first.<br> |
| 55 | pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length.<br> |
| 56 | maxResults: integer, The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.<br> |
| 57 | query: string, Full-text search query string.</tt></dd></dl> |
| 58 | |
| 59 | <dl><dt><a name="Resource-search_next"><strong>search_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br> |
| 60 | <br> |
| 61 | Args:<br> |
| 62 | previous_request: The request for the previous page.<br> |
| 63 | previous_response: The response from the request for the previous page.<br> |
| 64 | <br> |
| 65 | Returns:<br> |
| 66 | A request object that you can call 'execute()' on to request the next<br> |
| 67 | page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| 68 | |
| 69 | <hr> |
| 70 | Data descriptors defined here:<br> |
| 71 | <dl><dt><strong>__dict__</strong></dt> |
| 72 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 73 | </dl> |
| 74 | <dl><dt><strong>__weakref__</strong></dt> |
| 75 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 76 | </dl> |
| 77 | </td></tr></table> |
| 78 | </body></html> |