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 specified series.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 18 | <br> |
| 19 | Args:<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame^] | 20 | seriesId: integer, The decimal ID of the Series. (required)<br> |
| 21 | <br> |
| 22 | Returns:<br> |
| 23 | An object of the form<br> |
| 24 | <br> |
| 25 | {<br> |
| 26 | "kind": "moderator#series",<br> |
| 27 | "description": "A String",<br> |
| 28 | "rules": {<br> |
| 29 | "votes": {<br> |
| 30 | "close": "A String",<br> |
| 31 | "open": "A String",<br> |
| 32 | },<br> |
| 33 | "submissions": {<br> |
| 34 | "close": "A String",<br> |
| 35 | "open": "A String",<br> |
| 36 | },<br> |
| 37 | },<br> |
| 38 | "unauthVotingAllowed": True or False,<br> |
| 39 | "videoSubmissionAllowed": True or False,<br> |
| 40 | "name": "A String",<br> |
| 41 | "numTopics": 42,<br> |
| 42 | "anonymousSubmissionAllowed": True or False,<br> |
| 43 | "unauthSubmissionAllowed": True or False,<br> |
| 44 | "id": {<br> |
| 45 | "seriesId": "A String",<br> |
| 46 | },<br> |
| 47 | "counters": {<br> |
| 48 | "users": 42,<br> |
| 49 | "noneVotes": 42,<br> |
| 50 | "videoSubmissions": 42,<br> |
| 51 | "minusVotes": 42,<br> |
| 52 | "anonymousSubmissions": 42,<br> |
| 53 | "submissions": 42,<br> |
| 54 | "plusVotes": 42,<br> |
| 55 | },<br> |
| 56 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 57 | |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 58 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts a new series.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 59 | <br> |
| 60 | Args:<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame^] | 61 | body: object, The request body. (required)<br> |
| 62 | The object takes the form of:<br> |
| 63 | <br> |
| 64 | {<br> |
| 65 | "kind": "moderator#series",<br> |
| 66 | "description": "A String",<br> |
| 67 | "rules": {<br> |
| 68 | "votes": {<br> |
| 69 | "close": "A String",<br> |
| 70 | "open": "A String",<br> |
| 71 | },<br> |
| 72 | "submissions": {<br> |
| 73 | "close": "A String",<br> |
| 74 | "open": "A String",<br> |
| 75 | },<br> |
| 76 | },<br> |
| 77 | "unauthVotingAllowed": True or False,<br> |
| 78 | "videoSubmissionAllowed": True or False,<br> |
| 79 | "name": "A String",<br> |
| 80 | "numTopics": 42,<br> |
| 81 | "anonymousSubmissionAllowed": True or False,<br> |
| 82 | "unauthSubmissionAllowed": True or False,<br> |
| 83 | "id": {<br> |
| 84 | "seriesId": "A String",<br> |
| 85 | },<br> |
| 86 | "counters": {<br> |
| 87 | "users": 42,<br> |
| 88 | "noneVotes": 42,<br> |
| 89 | "videoSubmissions": 42,<br> |
| 90 | "minusVotes": 42,<br> |
| 91 | "anonymousSubmissions": 42,<br> |
| 92 | "submissions": 42,<br> |
| 93 | "plusVotes": 42,<br> |
| 94 | },<br> |
| 95 | }<br> |
| 96 | <br> |
| 97 | <br> |
| 98 | Returns:<br> |
| 99 | An object of the form<br> |
| 100 | <br> |
| 101 | {<br> |
| 102 | "kind": "moderator#series",<br> |
| 103 | "description": "A String",<br> |
| 104 | "rules": {<br> |
| 105 | "votes": {<br> |
| 106 | "close": "A String",<br> |
| 107 | "open": "A String",<br> |
| 108 | },<br> |
| 109 | "submissions": {<br> |
| 110 | "close": "A String",<br> |
| 111 | "open": "A String",<br> |
| 112 | },<br> |
| 113 | },<br> |
| 114 | "unauthVotingAllowed": True or False,<br> |
| 115 | "videoSubmissionAllowed": True or False,<br> |
| 116 | "name": "A String",<br> |
| 117 | "numTopics": 42,<br> |
| 118 | "anonymousSubmissionAllowed": True or False,<br> |
| 119 | "unauthSubmissionAllowed": True or False,<br> |
| 120 | "id": {<br> |
| 121 | "seriesId": "A String",<br> |
| 122 | },<br> |
| 123 | "counters": {<br> |
| 124 | "users": 42,<br> |
| 125 | "noneVotes": 42,<br> |
| 126 | "videoSubmissions": 42,<br> |
| 127 | "minusVotes": 42,<br> |
| 128 | "anonymousSubmissions": 42,<br> |
| 129 | "submissions": 42,<br> |
| 130 | "plusVotes": 42,<br> |
| 131 | },<br> |
| 132 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 133 | |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 134 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Searches the series and returns the search results.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 135 | <br> |
| 136 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 137 | q: string, Search query.<br> |
| 138 | max_results: integer, Maximum number of results to return.<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame^] | 139 | start_index: integer, Index of the first result to be retrieved.<br> |
| 140 | <br> |
| 141 | Returns:<br> |
| 142 | An object of the form<br> |
| 143 | <br> |
| 144 | {<br> |
| 145 | "items": [<br> |
| 146 | {<br> |
| 147 | "kind": "moderator#series",<br> |
| 148 | "description": "A String",<br> |
| 149 | "rules": {<br> |
| 150 | "votes": {<br> |
| 151 | "close": "A String",<br> |
| 152 | "open": "A String",<br> |
| 153 | },<br> |
| 154 | "submissions": {<br> |
| 155 | "close": "A String",<br> |
| 156 | "open": "A String",<br> |
| 157 | },<br> |
| 158 | },<br> |
| 159 | "unauthVotingAllowed": True or False,<br> |
| 160 | "videoSubmissionAllowed": True or False,<br> |
| 161 | "name": "A String",<br> |
| 162 | "numTopics": 42,<br> |
| 163 | "anonymousSubmissionAllowed": True or False,<br> |
| 164 | "unauthSubmissionAllowed": True or False,<br> |
| 165 | "id": {<br> |
| 166 | "seriesId": "A String",<br> |
| 167 | },<br> |
| 168 | "counters": {<br> |
| 169 | "users": 42,<br> |
| 170 | "noneVotes": 42,<br> |
| 171 | "videoSubmissions": 42,<br> |
| 172 | "minusVotes": 42,<br> |
| 173 | "anonymousSubmissions": 42,<br> |
| 174 | "submissions": 42,<br> |
| 175 | "plusVotes": 42,<br> |
| 176 | },<br> |
| 177 | },<br> |
| 178 | ],<br> |
| 179 | "kind": "moderator#seriesList",<br> |
| 180 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 181 | |
Joe Gregorio | b9e63ff | 2011-06-30 12:38:10 -0400 | [diff] [blame] | 182 | <dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the specified series. This method supports patch semantics.<br> |
| 183 | <br> |
| 184 | Args:<br> |
| 185 | seriesId: integer, The decimal ID of the Series. (required)<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame^] | 186 | body: object, The request body. (required)<br> |
| 187 | The object takes the form of:<br> |
| 188 | <br> |
| 189 | {<br> |
| 190 | "kind": "moderator#series",<br> |
| 191 | "description": "A String",<br> |
| 192 | "rules": {<br> |
| 193 | "votes": {<br> |
| 194 | "close": "A String",<br> |
| 195 | "open": "A String",<br> |
| 196 | },<br> |
| 197 | "submissions": {<br> |
| 198 | "close": "A String",<br> |
| 199 | "open": "A String",<br> |
| 200 | },<br> |
| 201 | },<br> |
| 202 | "unauthVotingAllowed": True or False,<br> |
| 203 | "videoSubmissionAllowed": True or False,<br> |
| 204 | "name": "A String",<br> |
| 205 | "numTopics": 42,<br> |
| 206 | "anonymousSubmissionAllowed": True or False,<br> |
| 207 | "unauthSubmissionAllowed": True or False,<br> |
| 208 | "id": {<br> |
| 209 | "seriesId": "A String",<br> |
| 210 | },<br> |
| 211 | "counters": {<br> |
| 212 | "users": 42,<br> |
| 213 | "noneVotes": 42,<br> |
| 214 | "videoSubmissions": 42,<br> |
| 215 | "minusVotes": 42,<br> |
| 216 | "anonymousSubmissions": 42,<br> |
| 217 | "submissions": 42,<br> |
| 218 | "plusVotes": 42,<br> |
| 219 | },<br> |
| 220 | }<br> |
| 221 | <br> |
| 222 | <br> |
| 223 | Returns:<br> |
| 224 | An object of the form<br> |
| 225 | <br> |
| 226 | {<br> |
| 227 | "kind": "moderator#series",<br> |
| 228 | "description": "A String",<br> |
| 229 | "rules": {<br> |
| 230 | "votes": {<br> |
| 231 | "close": "A String",<br> |
| 232 | "open": "A String",<br> |
| 233 | },<br> |
| 234 | "submissions": {<br> |
| 235 | "close": "A String",<br> |
| 236 | "open": "A String",<br> |
| 237 | },<br> |
| 238 | },<br> |
| 239 | "unauthVotingAllowed": True or False,<br> |
| 240 | "videoSubmissionAllowed": True or False,<br> |
| 241 | "name": "A String",<br> |
| 242 | "numTopics": 42,<br> |
| 243 | "anonymousSubmissionAllowed": True or False,<br> |
| 244 | "unauthSubmissionAllowed": True or False,<br> |
| 245 | "id": {<br> |
| 246 | "seriesId": "A String",<br> |
| 247 | },<br> |
| 248 | "counters": {<br> |
| 249 | "users": 42,<br> |
| 250 | "noneVotes": 42,<br> |
| 251 | "videoSubmissions": 42,<br> |
| 252 | "minusVotes": 42,<br> |
| 253 | "anonymousSubmissions": 42,<br> |
| 254 | "submissions": 42,<br> |
| 255 | "plusVotes": 42,<br> |
| 256 | },<br> |
| 257 | }</tt></dd></dl> |
Joe Gregorio | b9e63ff | 2011-06-30 12:38:10 -0400 | [diff] [blame] | 258 | |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 259 | <dl><dt><a name="Resource-responses"><strong><a href="moderator.v1.series.responses.html">responses</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl> |
| 260 | |
| 261 | <dl><dt><a name="Resource-submissions"><strong><a href="moderator.v1.series.submissions.html">submissions</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl> |
| 262 | |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 263 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the specified series.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 264 | <br> |
| 265 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 266 | seriesId: integer, The decimal ID of the Series. (required)<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame^] | 267 | body: object, The request body. (required)<br> |
| 268 | The object takes the form of:<br> |
| 269 | <br> |
| 270 | {<br> |
| 271 | "kind": "moderator#series",<br> |
| 272 | "description": "A String",<br> |
| 273 | "rules": {<br> |
| 274 | "votes": {<br> |
| 275 | "close": "A String",<br> |
| 276 | "open": "A String",<br> |
| 277 | },<br> |
| 278 | "submissions": {<br> |
| 279 | "close": "A String",<br> |
| 280 | "open": "A String",<br> |
| 281 | },<br> |
| 282 | },<br> |
| 283 | "unauthVotingAllowed": True or False,<br> |
| 284 | "videoSubmissionAllowed": True or False,<br> |
| 285 | "name": "A String",<br> |
| 286 | "numTopics": 42,<br> |
| 287 | "anonymousSubmissionAllowed": True or False,<br> |
| 288 | "unauthSubmissionAllowed": True or False,<br> |
| 289 | "id": {<br> |
| 290 | "seriesId": "A String",<br> |
| 291 | },<br> |
| 292 | "counters": {<br> |
| 293 | "users": 42,<br> |
| 294 | "noneVotes": 42,<br> |
| 295 | "videoSubmissions": 42,<br> |
| 296 | "minusVotes": 42,<br> |
| 297 | "anonymousSubmissions": 42,<br> |
| 298 | "submissions": 42,<br> |
| 299 | "plusVotes": 42,<br> |
| 300 | },<br> |
| 301 | }<br> |
| 302 | <br> |
| 303 | <br> |
| 304 | Returns:<br> |
| 305 | An object of the form<br> |
| 306 | <br> |
| 307 | {<br> |
| 308 | "kind": "moderator#series",<br> |
| 309 | "description": "A String",<br> |
| 310 | "rules": {<br> |
| 311 | "votes": {<br> |
| 312 | "close": "A String",<br> |
| 313 | "open": "A String",<br> |
| 314 | },<br> |
| 315 | "submissions": {<br> |
| 316 | "close": "A String",<br> |
| 317 | "open": "A String",<br> |
| 318 | },<br> |
| 319 | },<br> |
| 320 | "unauthVotingAllowed": True or False,<br> |
| 321 | "videoSubmissionAllowed": True or False,<br> |
| 322 | "name": "A String",<br> |
| 323 | "numTopics": 42,<br> |
| 324 | "anonymousSubmissionAllowed": True or False,<br> |
| 325 | "unauthSubmissionAllowed": True or False,<br> |
| 326 | "id": {<br> |
| 327 | "seriesId": "A String",<br> |
| 328 | },<br> |
| 329 | "counters": {<br> |
| 330 | "users": 42,<br> |
| 331 | "noneVotes": 42,<br> |
| 332 | "videoSubmissions": 42,<br> |
| 333 | "minusVotes": 42,<br> |
| 334 | "anonymousSubmissions": 42,<br> |
| 335 | "submissions": 42,<br> |
| 336 | "plusVotes": 42,<br> |
| 337 | },<br> |
| 338 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 339 | |
| 340 | <hr> |
| 341 | Data descriptors defined here:<br> |
| 342 | <dl><dt><strong>__dict__</strong></dt> |
| 343 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 344 | </dl> |
| 345 | <dl><dt><strong>__weakref__</strong></dt> |
| 346 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 347 | </dl> |
| 348 | </td></tr></table> |
| 349 | </body></html> |