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 | |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 17 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Searches the submissions for the specified series and returns the search results.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 18 | <br> |
| 19 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 20 | lang: string, The language code for the language the client prefers resuls in.<br> |
| 21 | seriesId: integer, The decimal ID of the Series. (required)<br> |
Joe Gregorio | 20a5aa9 | 2011-04-01 17:44:25 -0400 | [diff] [blame] | 22 | includeVotes: boolean, Specifies whether to include the current user's vote<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 23 | author: string, Restricts the results to submissions by a specific author.<br> |
| 24 | sort: string, Sort order.<br> |
| 25 | max_results: integer, Maximum number of results to return.<br> |
| 26 | q: string, Search query.<br> |
| 27 | start_index: integer, Index of the first result to be retrieved.<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame^] | 28 | hasAttachedVideo: boolean, Specifies whether to restrict to submissions that have videos attached.<br> |
| 29 | <br> |
| 30 | Returns:<br> |
| 31 | An object of the form<br> |
| 32 | <br> |
| 33 | {<br> |
| 34 | "items": [<br> |
| 35 | {<br> |
| 36 | "kind": "moderator#submission",<br> |
| 37 | "attribution": {<br> |
| 38 | "displayName": "A String",<br> |
| 39 | "location": "A String",<br> |
| 40 | "avatarUrl": "A String",<br> |
| 41 | },<br> |
| 42 | "created": "A String",<br> |
| 43 | "text": "A String",<br> |
| 44 | "topics": [<br> |
| 45 | {<br> |
| 46 | "id": {<br> |
| 47 | "seriesId": "A String",<br> |
| 48 | "topicId": "A String",<br> |
| 49 | },<br> |
| 50 | },<br> |
| 51 | ],<br> |
| 52 | "author": "A String",<br> |
| 53 | "translations": [<br> |
| 54 | {<br> |
| 55 | "lang": "A String",<br> |
| 56 | "text": "A String",<br> |
| 57 | },<br> |
| 58 | ],<br> |
| 59 | "parentSubmissionId": {<br> |
| 60 | "seriesId": "A String",<br> |
| 61 | "submissionId": "A String",<br> |
| 62 | },<br> |
| 63 | "vote": {<br> |
| 64 | "vote": "A String",<br> |
| 65 | "flag": "A String",<br> |
| 66 | },<br> |
| 67 | "attachmentUrl": "A String",<br> |
| 68 | "geo": {<br> |
| 69 | "latitude": 3.140000,<br> |
| 70 | "location": "A String",<br> |
| 71 | "longitude": 3.140000,<br> |
| 72 | },<br> |
| 73 | "id": {<br> |
| 74 | "seriesId": "A String",<br> |
| 75 | "submissionId": "A String",<br> |
| 76 | },<br> |
| 77 | "counters": {<br> |
| 78 | "noneVotes": 42,<br> |
| 79 | "minusVotes": 42,<br> |
| 80 | "plusVotes": 42,<br> |
| 81 | },<br> |
| 82 | },<br> |
| 83 | ],<br> |
| 84 | "kind": "moderator#submissionList",<br> |
| 85 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 86 | |
| 87 | <hr> |
| 88 | Data descriptors defined here:<br> |
| 89 | <dl><dt><strong>__dict__</strong></dt> |
| 90 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 91 | </dl> |
| 92 | <dl><dt><strong>__weakref__</strong></dt> |
| 93 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 94 | </dl> |
| 95 | </td></tr></table> |
| 96 | </body></html> |