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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the votes by the authenticated user for the specified submission within the specified series.<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 | seriesId: integer, The decimal ID of the Series. (required)<br> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 21 | unauthToken: string, User identifier for unauthenticated usage mode<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 22 | userId: string, A parameter<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 23 | submissionId: integer, The decimal ID of the Submission within the Series. (required)<br> |
| 24 | <br> |
| 25 | Returns:<br> |
| 26 | An object of the form<br> |
| 27 | <br> |
| 28 | {<br> |
| 29 | "vote": "A String",<br> |
| 30 | "flag": "A String",<br> |
| 31 | "id": {<br> |
| 32 | "seriesId": "A String",<br> |
| 33 | "submissionId": "A String",<br> |
| 34 | },<br> |
| 35 | "kind": "moderator#vote",<br> |
| 36 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 37 | |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 38 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts a new vote by the authenticated user for the specified submission within the specified series.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 39 | <br> |
| 40 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 41 | seriesId: integer, The decimal ID of the Series. (required)<br> |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 42 | body: object, The request body. (required)<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 43 | The object takes the form of:<br> |
| 44 | <br> |
| 45 | {<br> |
| 46 | "vote": "A String",<br> |
| 47 | "flag": "A String",<br> |
| 48 | "id": {<br> |
| 49 | "seriesId": "A String",<br> |
| 50 | "submissionId": "A String",<br> |
| 51 | },<br> |
| 52 | "kind": "moderator#vote",<br> |
| 53 | }<br> |
| 54 | <br> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 55 | unauthToken: string, User identifier for unauthenticated usage mode<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 56 | submissionId: integer, The decimal ID of the Submission within the Series. (required)<br> |
| 57 | <br> |
| 58 | Returns:<br> |
| 59 | An object of the form<br> |
| 60 | <br> |
| 61 | {<br> |
| 62 | "vote": "A String",<br> |
| 63 | "flag": "A String",<br> |
| 64 | "id": {<br> |
| 65 | "seriesId": "A String",<br> |
| 66 | "submissionId": "A String",<br> |
| 67 | },<br> |
| 68 | "kind": "moderator#vote",<br> |
| 69 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 70 | |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 71 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists the votes by the authenticated user for the given series.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 72 | <br> |
| 73 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 74 | seriesId: integer, The decimal ID of the Series. (required)<br> |
| 75 | max_results: integer, Maximum number of results to return.<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 76 | start_index: integer, Index of the first result to be retrieved.<br> |
| 77 | <br> |
| 78 | Returns:<br> |
| 79 | An object of the form<br> |
| 80 | <br> |
| 81 | {<br> |
| 82 | "items": [<br> |
| 83 | {<br> |
| 84 | "vote": "A String",<br> |
| 85 | "flag": "A String",<br> |
| 86 | "id": {<br> |
| 87 | "seriesId": "A String",<br> |
| 88 | "submissionId": "A String",<br> |
| 89 | },<br> |
| 90 | "kind": "moderator#vote",<br> |
| 91 | },<br> |
| 92 | ],<br> |
| 93 | "kind": "moderator#voteList",<br> |
| 94 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 95 | |
Joe Gregorio | b9e63ff | 2011-06-30 12:38:10 -0400 | [diff] [blame] | 96 | <dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the votes by the authenticated user for the specified submission within the specified series. This method supports patch semantics.<br> |
| 97 | <br> |
| 98 | Args:<br> |
| 99 | seriesId: integer, The decimal ID of the Series. (required)<br> |
| 100 | body: object, The request body. (required)<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 101 | The object takes the form of:<br> |
| 102 | <br> |
| 103 | {<br> |
| 104 | "vote": "A String",<br> |
| 105 | "flag": "A String",<br> |
| 106 | "id": {<br> |
| 107 | "seriesId": "A String",<br> |
| 108 | "submissionId": "A String",<br> |
| 109 | },<br> |
| 110 | "kind": "moderator#vote",<br> |
| 111 | }<br> |
| 112 | <br> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 113 | unauthToken: string, User identifier for unauthenticated usage mode<br> |
Joe Gregorio | b9e63ff | 2011-06-30 12:38:10 -0400 | [diff] [blame] | 114 | userId: string, A parameter<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 115 | submissionId: integer, The decimal ID of the Submission within the Series. (required)<br> |
| 116 | <br> |
| 117 | Returns:<br> |
| 118 | An object of the form<br> |
| 119 | <br> |
| 120 | {<br> |
| 121 | "vote": "A String",<br> |
| 122 | "flag": "A String",<br> |
| 123 | "id": {<br> |
| 124 | "seriesId": "A String",<br> |
| 125 | "submissionId": "A String",<br> |
| 126 | },<br> |
| 127 | "kind": "moderator#vote",<br> |
| 128 | }</tt></dd></dl> |
Joe Gregorio | b9e63ff | 2011-06-30 12:38:10 -0400 | [diff] [blame] | 129 | |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 130 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the votes by the authenticated user for the specified submission within the specified series.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 131 | <br> |
| 132 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 133 | seriesId: integer, The decimal ID of the Series. (required)<br> |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 134 | body: object, The request body. (required)<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 135 | The object takes the form of:<br> |
| 136 | <br> |
| 137 | {<br> |
| 138 | "vote": "A String",<br> |
| 139 | "flag": "A String",<br> |
| 140 | "id": {<br> |
| 141 | "seriesId": "A String",<br> |
| 142 | "submissionId": "A String",<br> |
| 143 | },<br> |
| 144 | "kind": "moderator#vote",<br> |
| 145 | }<br> |
| 146 | <br> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 147 | unauthToken: string, User identifier for unauthenticated usage mode<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 148 | userId: string, A parameter<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 149 | submissionId: integer, The decimal ID of the Submission within the Series. (required)<br> |
| 150 | <br> |
| 151 | Returns:<br> |
| 152 | An object of the form<br> |
| 153 | <br> |
| 154 | {<br> |
| 155 | "vote": "A String",<br> |
| 156 | "flag": "A String",<br> |
| 157 | "id": {<br> |
| 158 | "seriesId": "A String",<br> |
| 159 | "submissionId": "A String",<br> |
| 160 | },<br> |
| 161 | "kind": "moderator#vote",<br> |
| 162 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 163 | |
| 164 | <hr> |
| 165 | Data descriptors defined here:<br> |
| 166 | <dl><dt><strong>__dict__</strong></dt> |
| 167 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 168 | </dl> |
| 169 | <dl><dt><strong>__weakref__</strong></dt> |
| 170 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 171 | </dl> |
| 172 | </td></tr></table> |
| 173 | </body></html> |