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