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 topic from 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 | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 21 | topicId: integer, The decimal ID of the Topic within the Series. (required)<br> |
| 22 | <br> |
| 23 | Returns:<br> |
| 24 | An object of the form<br> |
| 25 | <br> |
| 26 | {<br> |
| 27 | "kind": "moderator#topic",<br> |
| 28 | "description": "A String",<br> |
| 29 | "rules": {<br> |
| 30 | "votes": {<br> |
| 31 | "close": "A String",<br> |
| 32 | "open": "A String",<br> |
| 33 | },<br> |
| 34 | "submissions": {<br> |
| 35 | "close": "A String",<br> |
| 36 | "open": "A String",<br> |
| 37 | },<br> |
| 38 | },<br> |
| 39 | "featuredSubmission": {<br> |
| 40 | "kind": "moderator#submission",<br> |
| 41 | "attribution": {<br> |
| 42 | "displayName": "A String",<br> |
| 43 | "location": "A String",<br> |
| 44 | "avatarUrl": "A String",<br> |
| 45 | },<br> |
| 46 | "created": "A String",<br> |
| 47 | "text": "A String",<br> |
| 48 | "topics": [<br> |
| 49 | {<br> |
| 50 | "id": {<br> |
| 51 | "seriesId": "A String",<br> |
| 52 | "topicId": "A String",<br> |
| 53 | },<br> |
| 54 | },<br> |
| 55 | ],<br> |
| 56 | "author": "A String",<br> |
| 57 | "translations": [<br> |
| 58 | {<br> |
| 59 | "lang": "A String",<br> |
| 60 | "text": "A String",<br> |
| 61 | },<br> |
| 62 | ],<br> |
| 63 | "parentSubmissionId": {<br> |
| 64 | "seriesId": "A String",<br> |
| 65 | "submissionId": "A String",<br> |
| 66 | },<br> |
| 67 | "vote": {<br> |
| 68 | "vote": "A String",<br> |
| 69 | "flag": "A String",<br> |
| 70 | },<br> |
| 71 | "attachmentUrl": "A String",<br> |
| 72 | "geo": {<br> |
| 73 | "latitude": 3.140000,<br> |
| 74 | "location": "A String",<br> |
| 75 | "longitude": 3.140000,<br> |
| 76 | },<br> |
| 77 | "id": {<br> |
| 78 | "seriesId": "A String",<br> |
| 79 | "submissionId": "A String",<br> |
| 80 | },<br> |
| 81 | "counters": {<br> |
| 82 | "noneVotes": 42,<br> |
| 83 | "minusVotes": 42,<br> |
| 84 | "plusVotes": 42,<br> |
| 85 | },<br> |
| 86 | },<br> |
| 87 | "presenter": "A String",<br> |
| 88 | "counters": {<br> |
| 89 | "users": 42,<br> |
| 90 | "noneVotes": 42,<br> |
| 91 | "videoSubmissions": 42,<br> |
| 92 | "minusVotes": 42,<br> |
| 93 | "submissions": 42,<br> |
| 94 | "plusVotes": 42,<br> |
| 95 | },<br> |
| 96 | "id": {<br> |
| 97 | "seriesId": "A String",<br> |
| 98 | "topicId": "A String",<br> |
| 99 | },<br> |
| 100 | "name": "A String",<br> |
| 101 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 102 | |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 103 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts a new topic into the specified series.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 104 | <br> |
| 105 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 106 | seriesId: integer, The decimal ID of the Series. (required)<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 107 | body: object, The request body. (required)<br> |
| 108 | The object takes the form of:<br> |
| 109 | <br> |
| 110 | {<br> |
| 111 | "kind": "moderator#topic",<br> |
| 112 | "description": "A String",<br> |
| 113 | "rules": {<br> |
| 114 | "votes": {<br> |
| 115 | "close": "A String",<br> |
| 116 | "open": "A String",<br> |
| 117 | },<br> |
| 118 | "submissions": {<br> |
| 119 | "close": "A String",<br> |
| 120 | "open": "A String",<br> |
| 121 | },<br> |
| 122 | },<br> |
| 123 | "featuredSubmission": {<br> |
| 124 | "kind": "moderator#submission",<br> |
| 125 | "attribution": {<br> |
| 126 | "displayName": "A String",<br> |
| 127 | "location": "A String",<br> |
| 128 | "avatarUrl": "A String",<br> |
| 129 | },<br> |
| 130 | "created": "A String",<br> |
| 131 | "text": "A String",<br> |
| 132 | "topics": [<br> |
| 133 | {<br> |
| 134 | "id": {<br> |
| 135 | "seriesId": "A String",<br> |
| 136 | "topicId": "A String",<br> |
| 137 | },<br> |
| 138 | },<br> |
| 139 | ],<br> |
| 140 | "author": "A String",<br> |
| 141 | "translations": [<br> |
| 142 | {<br> |
| 143 | "lang": "A String",<br> |
| 144 | "text": "A String",<br> |
| 145 | },<br> |
| 146 | ],<br> |
| 147 | "parentSubmissionId": {<br> |
| 148 | "seriesId": "A String",<br> |
| 149 | "submissionId": "A String",<br> |
| 150 | },<br> |
| 151 | "vote": {<br> |
| 152 | "vote": "A String",<br> |
| 153 | "flag": "A String",<br> |
| 154 | },<br> |
| 155 | "attachmentUrl": "A String",<br> |
| 156 | "geo": {<br> |
| 157 | "latitude": 3.140000,<br> |
| 158 | "location": "A String",<br> |
| 159 | "longitude": 3.140000,<br> |
| 160 | },<br> |
| 161 | "id": {<br> |
| 162 | "seriesId": "A String",<br> |
| 163 | "submissionId": "A String",<br> |
| 164 | },<br> |
| 165 | "counters": {<br> |
| 166 | "noneVotes": 42,<br> |
| 167 | "minusVotes": 42,<br> |
| 168 | "plusVotes": 42,<br> |
| 169 | },<br> |
| 170 | },<br> |
| 171 | "presenter": "A String",<br> |
| 172 | "counters": {<br> |
| 173 | "users": 42,<br> |
| 174 | "noneVotes": 42,<br> |
| 175 | "videoSubmissions": 42,<br> |
| 176 | "minusVotes": 42,<br> |
| 177 | "submissions": 42,<br> |
| 178 | "plusVotes": 42,<br> |
| 179 | },<br> |
| 180 | "id": {<br> |
| 181 | "seriesId": "A String",<br> |
| 182 | "topicId": "A String",<br> |
| 183 | },<br> |
| 184 | "name": "A String",<br> |
| 185 | }<br> |
| 186 | <br> |
| 187 | <br> |
| 188 | Returns:<br> |
| 189 | An object of the form<br> |
| 190 | <br> |
| 191 | {<br> |
| 192 | "kind": "moderator#topic",<br> |
| 193 | "description": "A String",<br> |
| 194 | "rules": {<br> |
| 195 | "votes": {<br> |
| 196 | "close": "A String",<br> |
| 197 | "open": "A String",<br> |
| 198 | },<br> |
| 199 | "submissions": {<br> |
| 200 | "close": "A String",<br> |
| 201 | "open": "A String",<br> |
| 202 | },<br> |
| 203 | },<br> |
| 204 | "featuredSubmission": {<br> |
| 205 | "kind": "moderator#submission",<br> |
| 206 | "attribution": {<br> |
| 207 | "displayName": "A String",<br> |
| 208 | "location": "A String",<br> |
| 209 | "avatarUrl": "A String",<br> |
| 210 | },<br> |
| 211 | "created": "A String",<br> |
| 212 | "text": "A String",<br> |
| 213 | "topics": [<br> |
| 214 | {<br> |
| 215 | "id": {<br> |
| 216 | "seriesId": "A String",<br> |
| 217 | "topicId": "A String",<br> |
| 218 | },<br> |
| 219 | },<br> |
| 220 | ],<br> |
| 221 | "author": "A String",<br> |
| 222 | "translations": [<br> |
| 223 | {<br> |
| 224 | "lang": "A String",<br> |
| 225 | "text": "A String",<br> |
| 226 | },<br> |
| 227 | ],<br> |
| 228 | "parentSubmissionId": {<br> |
| 229 | "seriesId": "A String",<br> |
| 230 | "submissionId": "A String",<br> |
| 231 | },<br> |
| 232 | "vote": {<br> |
| 233 | "vote": "A String",<br> |
| 234 | "flag": "A String",<br> |
| 235 | },<br> |
| 236 | "attachmentUrl": "A String",<br> |
| 237 | "geo": {<br> |
| 238 | "latitude": 3.140000,<br> |
| 239 | "location": "A String",<br> |
| 240 | "longitude": 3.140000,<br> |
| 241 | },<br> |
| 242 | "id": {<br> |
| 243 | "seriesId": "A String",<br> |
| 244 | "submissionId": "A String",<br> |
| 245 | },<br> |
| 246 | "counters": {<br> |
| 247 | "noneVotes": 42,<br> |
| 248 | "minusVotes": 42,<br> |
| 249 | "plusVotes": 42,<br> |
| 250 | },<br> |
| 251 | },<br> |
| 252 | "presenter": "A String",<br> |
| 253 | "counters": {<br> |
| 254 | "users": 42,<br> |
| 255 | "noneVotes": 42,<br> |
| 256 | "videoSubmissions": 42,<br> |
| 257 | "minusVotes": 42,<br> |
| 258 | "submissions": 42,<br> |
| 259 | "plusVotes": 42,<br> |
| 260 | },<br> |
| 261 | "id": {<br> |
| 262 | "seriesId": "A String",<br> |
| 263 | "topicId": "A String",<br> |
| 264 | },<br> |
| 265 | "name": "A String",<br> |
| 266 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 267 | |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 268 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Searches the topics within the specified series and returns the search results.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 269 | <br> |
| 270 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 271 | seriesId: integer, The decimal ID of the Series. (required)<br> |
| 272 | q: string, Search query.<br> |
| 273 | max_results: integer, Maximum number of results to return.<br> |
| 274 | mode: string, A parameter<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 275 | start_index: integer, Index of the first result to be retrieved.<br> |
| 276 | <br> |
| 277 | Returns:<br> |
| 278 | An object of the form<br> |
| 279 | <br> |
| 280 | {<br> |
| 281 | "items": [<br> |
| 282 | {<br> |
| 283 | "kind": "moderator#topic",<br> |
| 284 | "description": "A String",<br> |
| 285 | "rules": {<br> |
| 286 | "votes": {<br> |
| 287 | "close": "A String",<br> |
| 288 | "open": "A String",<br> |
| 289 | },<br> |
| 290 | "submissions": {<br> |
| 291 | "close": "A String",<br> |
| 292 | "open": "A String",<br> |
| 293 | },<br> |
| 294 | },<br> |
| 295 | "featuredSubmission": {<br> |
| 296 | "kind": "moderator#submission",<br> |
| 297 | "attribution": {<br> |
| 298 | "displayName": "A String",<br> |
| 299 | "location": "A String",<br> |
| 300 | "avatarUrl": "A String",<br> |
| 301 | },<br> |
| 302 | "created": "A String",<br> |
| 303 | "text": "A String",<br> |
| 304 | "topics": [<br> |
| 305 | {<br> |
| 306 | "id": {<br> |
| 307 | "seriesId": "A String",<br> |
| 308 | "topicId": "A String",<br> |
| 309 | },<br> |
| 310 | },<br> |
| 311 | ],<br> |
| 312 | "author": "A String",<br> |
| 313 | "translations": [<br> |
| 314 | {<br> |
| 315 | "lang": "A String",<br> |
| 316 | "text": "A String",<br> |
| 317 | },<br> |
| 318 | ],<br> |
| 319 | "parentSubmissionId": {<br> |
| 320 | "seriesId": "A String",<br> |
| 321 | "submissionId": "A String",<br> |
| 322 | },<br> |
| 323 | "vote": {<br> |
| 324 | "vote": "A String",<br> |
| 325 | "flag": "A String",<br> |
| 326 | },<br> |
| 327 | "attachmentUrl": "A String",<br> |
| 328 | "geo": {<br> |
| 329 | "latitude": 3.140000,<br> |
| 330 | "location": "A String",<br> |
| 331 | "longitude": 3.140000,<br> |
| 332 | },<br> |
| 333 | "id": {<br> |
| 334 | "seriesId": "A String",<br> |
| 335 | "submissionId": "A String",<br> |
| 336 | },<br> |
| 337 | "counters": {<br> |
| 338 | "noneVotes": 42,<br> |
| 339 | "minusVotes": 42,<br> |
| 340 | "plusVotes": 42,<br> |
| 341 | },<br> |
| 342 | },<br> |
| 343 | "presenter": "A String",<br> |
| 344 | "counters": {<br> |
| 345 | "users": 42,<br> |
| 346 | "noneVotes": 42,<br> |
| 347 | "videoSubmissions": 42,<br> |
| 348 | "minusVotes": 42,<br> |
| 349 | "submissions": 42,<br> |
| 350 | "plusVotes": 42,<br> |
| 351 | },<br> |
| 352 | "id": {<br> |
| 353 | "seriesId": "A String",<br> |
| 354 | "topicId": "A String",<br> |
| 355 | },<br> |
| 356 | "name": "A String",<br> |
| 357 | },<br> |
| 358 | ],<br> |
| 359 | "kind": "moderator#topicList",<br> |
| 360 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 361 | |
| 362 | <dl><dt><a name="Resource-submissions"><strong><a href="moderator.v1.topics.submissions.html">submissions</a></strong></a> = methodResource(self)</dt><dd><tt>A collection resource.</tt></dd></dl> |
| 363 | |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame] | 364 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the specified topic within the specified series.<br> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 365 | <br> |
| 366 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 367 | seriesId: integer, The decimal ID of the Series. (required)<br> |
| 368 | topicId: integer, The decimal ID of the Topic within the Series. (required)<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 369 | body: object, The request body. (required)<br> |
| 370 | The object takes the form of:<br> |
| 371 | <br> |
| 372 | {<br> |
| 373 | "kind": "moderator#topic",<br> |
| 374 | "description": "A String",<br> |
| 375 | "rules": {<br> |
| 376 | "votes": {<br> |
| 377 | "close": "A String",<br> |
| 378 | "open": "A String",<br> |
| 379 | },<br> |
| 380 | "submissions": {<br> |
| 381 | "close": "A String",<br> |
| 382 | "open": "A String",<br> |
| 383 | },<br> |
| 384 | },<br> |
| 385 | "featuredSubmission": {<br> |
| 386 | "kind": "moderator#submission",<br> |
| 387 | "attribution": {<br> |
| 388 | "displayName": "A String",<br> |
| 389 | "location": "A String",<br> |
| 390 | "avatarUrl": "A String",<br> |
| 391 | },<br> |
| 392 | "created": "A String",<br> |
| 393 | "text": "A String",<br> |
| 394 | "topics": [<br> |
| 395 | {<br> |
| 396 | "id": {<br> |
| 397 | "seriesId": "A String",<br> |
| 398 | "topicId": "A String",<br> |
| 399 | },<br> |
| 400 | },<br> |
| 401 | ],<br> |
| 402 | "author": "A String",<br> |
| 403 | "translations": [<br> |
| 404 | {<br> |
| 405 | "lang": "A String",<br> |
| 406 | "text": "A String",<br> |
| 407 | },<br> |
| 408 | ],<br> |
| 409 | "parentSubmissionId": {<br> |
| 410 | "seriesId": "A String",<br> |
| 411 | "submissionId": "A String",<br> |
| 412 | },<br> |
| 413 | "vote": {<br> |
| 414 | "vote": "A String",<br> |
| 415 | "flag": "A String",<br> |
| 416 | },<br> |
| 417 | "attachmentUrl": "A String",<br> |
| 418 | "geo": {<br> |
| 419 | "latitude": 3.140000,<br> |
| 420 | "location": "A String",<br> |
| 421 | "longitude": 3.140000,<br> |
| 422 | },<br> |
| 423 | "id": {<br> |
| 424 | "seriesId": "A String",<br> |
| 425 | "submissionId": "A String",<br> |
| 426 | },<br> |
| 427 | "counters": {<br> |
| 428 | "noneVotes": 42,<br> |
| 429 | "minusVotes": 42,<br> |
| 430 | "plusVotes": 42,<br> |
| 431 | },<br> |
| 432 | },<br> |
| 433 | "presenter": "A String",<br> |
| 434 | "counters": {<br> |
| 435 | "users": 42,<br> |
| 436 | "noneVotes": 42,<br> |
| 437 | "videoSubmissions": 42,<br> |
| 438 | "minusVotes": 42,<br> |
| 439 | "submissions": 42,<br> |
| 440 | "plusVotes": 42,<br> |
| 441 | },<br> |
| 442 | "id": {<br> |
| 443 | "seriesId": "A String",<br> |
| 444 | "topicId": "A String",<br> |
| 445 | },<br> |
| 446 | "name": "A String",<br> |
| 447 | }<br> |
| 448 | <br> |
| 449 | <br> |
| 450 | Returns:<br> |
| 451 | An object of the form<br> |
| 452 | <br> |
| 453 | {<br> |
| 454 | "kind": "moderator#topic",<br> |
| 455 | "description": "A String",<br> |
| 456 | "rules": {<br> |
| 457 | "votes": {<br> |
| 458 | "close": "A String",<br> |
| 459 | "open": "A String",<br> |
| 460 | },<br> |
| 461 | "submissions": {<br> |
| 462 | "close": "A String",<br> |
| 463 | "open": "A String",<br> |
| 464 | },<br> |
| 465 | },<br> |
| 466 | "featuredSubmission": {<br> |
| 467 | "kind": "moderator#submission",<br> |
| 468 | "attribution": {<br> |
| 469 | "displayName": "A String",<br> |
| 470 | "location": "A String",<br> |
| 471 | "avatarUrl": "A String",<br> |
| 472 | },<br> |
| 473 | "created": "A String",<br> |
| 474 | "text": "A String",<br> |
| 475 | "topics": [<br> |
| 476 | {<br> |
| 477 | "id": {<br> |
| 478 | "seriesId": "A String",<br> |
| 479 | "topicId": "A String",<br> |
| 480 | },<br> |
| 481 | },<br> |
| 482 | ],<br> |
| 483 | "author": "A String",<br> |
| 484 | "translations": [<br> |
| 485 | {<br> |
| 486 | "lang": "A String",<br> |
| 487 | "text": "A String",<br> |
| 488 | },<br> |
| 489 | ],<br> |
| 490 | "parentSubmissionId": {<br> |
| 491 | "seriesId": "A String",<br> |
| 492 | "submissionId": "A String",<br> |
| 493 | },<br> |
| 494 | "vote": {<br> |
| 495 | "vote": "A String",<br> |
| 496 | "flag": "A String",<br> |
| 497 | },<br> |
| 498 | "attachmentUrl": "A String",<br> |
| 499 | "geo": {<br> |
| 500 | "latitude": 3.140000,<br> |
| 501 | "location": "A String",<br> |
| 502 | "longitude": 3.140000,<br> |
| 503 | },<br> |
| 504 | "id": {<br> |
| 505 | "seriesId": "A String",<br> |
| 506 | "submissionId": "A String",<br> |
| 507 | },<br> |
| 508 | "counters": {<br> |
| 509 | "noneVotes": 42,<br> |
| 510 | "minusVotes": 42,<br> |
| 511 | "plusVotes": 42,<br> |
| 512 | },<br> |
| 513 | },<br> |
| 514 | "presenter": "A String",<br> |
| 515 | "counters": {<br> |
| 516 | "users": 42,<br> |
| 517 | "noneVotes": 42,<br> |
| 518 | "videoSubmissions": 42,<br> |
| 519 | "minusVotes": 42,<br> |
| 520 | "submissions": 42,<br> |
| 521 | "plusVotes": 42,<br> |
| 522 | },<br> |
| 523 | "id": {<br> |
| 524 | "seriesId": "A String",<br> |
| 525 | "topicId": "A String",<br> |
| 526 | },<br> |
| 527 | "name": "A String",<br> |
| 528 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 529 | |
| 530 | <hr> |
| 531 | Data descriptors defined here:<br> |
| 532 | <dl><dt><strong>__dict__</strong></dt> |
| 533 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 534 | </dl> |
| 535 | <dl><dt><strong>__weakref__</strong></dt> |
| 536 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 537 | </dl> |
| 538 | </td></tr></table> |
| 539 | </body></html> |