| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: class Resource</title> |
| </head><body bgcolor="#f0f0f8"> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <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> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the specified series.<br> |
| <br> |
| Args:<br> |
| seriesId: integer, The decimal ID of the Series. (required)<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "moderator#series",<br> |
| "description": "A String",<br> |
| "rules": {<br> |
| "votes": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| "submissions": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| },<br> |
| "unauthVotingAllowed": True or False,<br> |
| "videoSubmissionAllowed": True or False,<br> |
| "name": "A String",<br> |
| "numTopics": 42,<br> |
| "anonymousSubmissionAllowed": True or False,<br> |
| "unauthSubmissionAllowed": True or False,<br> |
| "id": {<br> |
| "seriesId": "A String",<br> |
| },<br> |
| "counters": {<br> |
| "users": 42,<br> |
| "noneVotes": 42,<br> |
| "videoSubmissions": 42,<br> |
| "minusVotes": 42,<br> |
| "anonymousSubmissions": 42,<br> |
| "submissions": 42,<br> |
| "plusVotes": 42,<br> |
| },<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Inserts a new series.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "kind": "moderator#series",<br> |
| "description": "A String",<br> |
| "rules": {<br> |
| "votes": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| "submissions": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| },<br> |
| "unauthVotingAllowed": True or False,<br> |
| "videoSubmissionAllowed": True or False,<br> |
| "name": "A String",<br> |
| "numTopics": 42,<br> |
| "anonymousSubmissionAllowed": True or False,<br> |
| "unauthSubmissionAllowed": True or False,<br> |
| "id": {<br> |
| "seriesId": "A String",<br> |
| },<br> |
| "counters": {<br> |
| "users": 42,<br> |
| "noneVotes": 42,<br> |
| "videoSubmissions": 42,<br> |
| "minusVotes": 42,<br> |
| "anonymousSubmissions": 42,<br> |
| "submissions": 42,<br> |
| "plusVotes": 42,<br> |
| },<br> |
| }<br> |
| <br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "moderator#series",<br> |
| "description": "A String",<br> |
| "rules": {<br> |
| "votes": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| "submissions": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| },<br> |
| "unauthVotingAllowed": True or False,<br> |
| "videoSubmissionAllowed": True or False,<br> |
| "name": "A String",<br> |
| "numTopics": 42,<br> |
| "anonymousSubmissionAllowed": True or False,<br> |
| "unauthSubmissionAllowed": True or False,<br> |
| "id": {<br> |
| "seriesId": "A String",<br> |
| },<br> |
| "counters": {<br> |
| "users": 42,<br> |
| "noneVotes": 42,<br> |
| "videoSubmissions": 42,<br> |
| "minusVotes": 42,<br> |
| "anonymousSubmissions": 42,<br> |
| "submissions": 42,<br> |
| "plusVotes": 42,<br> |
| },<br> |
| }</tt></dd></dl> |
| |
| <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> |
| <br> |
| Args:<br> |
| q: string, Search query.<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| strict: string, A parameter<br> |
| max_results: integer, Maximum number of results to return.<br> |
| userip: string, A parameter<br> |
| start_index: integer, Index of the first result to be retrieved.<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "items": [<br> |
| {<br> |
| "kind": "moderator#series",<br> |
| "description": "A String",<br> |
| "rules": {<br> |
| "votes": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| "submissions": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| },<br> |
| "unauthVotingAllowed": True or False,<br> |
| "videoSubmissionAllowed": True or False,<br> |
| "name": "A String",<br> |
| "numTopics": 42,<br> |
| "anonymousSubmissionAllowed": True or False,<br> |
| "unauthSubmissionAllowed": True or False,<br> |
| "id": {<br> |
| "seriesId": "A String",<br> |
| },<br> |
| "counters": {<br> |
| "users": 42,<br> |
| "noneVotes": 42,<br> |
| "videoSubmissions": 42,<br> |
| "minusVotes": 42,<br> |
| "anonymousSubmissions": 42,<br> |
| "submissions": 42,<br> |
| "plusVotes": 42,<br> |
| },<br> |
| },<br> |
| ],<br> |
| "kind": "moderator#seriesList",<br> |
| }</tt></dd></dl> |
| |
| <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> |
| <br> |
| Args:<br> |
| seriesId: integer, The decimal ID of the Series. (required)<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "kind": "moderator#series",<br> |
| "description": "A String",<br> |
| "rules": {<br> |
| "votes": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| "submissions": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| },<br> |
| "unauthVotingAllowed": True or False,<br> |
| "videoSubmissionAllowed": True or False,<br> |
| "name": "A String",<br> |
| "numTopics": 42,<br> |
| "anonymousSubmissionAllowed": True or False,<br> |
| "unauthSubmissionAllowed": True or False,<br> |
| "id": {<br> |
| "seriesId": "A String",<br> |
| },<br> |
| "counters": {<br> |
| "users": 42,<br> |
| "noneVotes": 42,<br> |
| "videoSubmissions": 42,<br> |
| "minusVotes": 42,<br> |
| "anonymousSubmissions": 42,<br> |
| "submissions": 42,<br> |
| "plusVotes": 42,<br> |
| },<br> |
| }<br> |
| <br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "moderator#series",<br> |
| "description": "A String",<br> |
| "rules": {<br> |
| "votes": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| "submissions": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| },<br> |
| "unauthVotingAllowed": True or False,<br> |
| "videoSubmissionAllowed": True or False,<br> |
| "name": "A String",<br> |
| "numTopics": 42,<br> |
| "anonymousSubmissionAllowed": True or False,<br> |
| "unauthSubmissionAllowed": True or False,<br> |
| "id": {<br> |
| "seriesId": "A String",<br> |
| },<br> |
| "counters": {<br> |
| "users": 42,<br> |
| "noneVotes": 42,<br> |
| "videoSubmissions": 42,<br> |
| "minusVotes": 42,<br> |
| "anonymousSubmissions": 42,<br> |
| "submissions": 42,<br> |
| "plusVotes": 42,<br> |
| },<br> |
| }</tt></dd></dl> |
| |
| <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> |
| |
| <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> |
| |
| <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the specified series.<br> |
| <br> |
| Args:<br> |
| seriesId: integer, The decimal ID of the Series. (required)<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "kind": "moderator#series",<br> |
| "description": "A String",<br> |
| "rules": {<br> |
| "votes": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| "submissions": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| },<br> |
| "unauthVotingAllowed": True or False,<br> |
| "videoSubmissionAllowed": True or False,<br> |
| "name": "A String",<br> |
| "numTopics": 42,<br> |
| "anonymousSubmissionAllowed": True or False,<br> |
| "unauthSubmissionAllowed": True or False,<br> |
| "id": {<br> |
| "seriesId": "A String",<br> |
| },<br> |
| "counters": {<br> |
| "users": 42,<br> |
| "noneVotes": 42,<br> |
| "videoSubmissions": 42,<br> |
| "minusVotes": 42,<br> |
| "anonymousSubmissions": 42,<br> |
| "submissions": 42,<br> |
| "plusVotes": 42,<br> |
| },<br> |
| }<br> |
| <br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| strict: string, A parameter<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "moderator#series",<br> |
| "description": "A String",<br> |
| "rules": {<br> |
| "votes": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| "submissions": {<br> |
| "close": "A String",<br> |
| "open": "A String",<br> |
| },<br> |
| },<br> |
| "unauthVotingAllowed": True or False,<br> |
| "videoSubmissionAllowed": True or False,<br> |
| "name": "A String",<br> |
| "numTopics": 42,<br> |
| "anonymousSubmissionAllowed": True or False,<br> |
| "unauthSubmissionAllowed": True or False,<br> |
| "id": {<br> |
| "seriesId": "A String",<br> |
| },<br> |
| "counters": {<br> |
| "users": 42,<br> |
| "noneVotes": 42,<br> |
| "videoSubmissions": 42,<br> |
| "minusVotes": 42,<br> |
| "anonymousSubmissions": 42,<br> |
| "submissions": 42,<br> |
| "plusVotes": 42,<br> |
| },<br> |
| }</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table> |
| </body></html> |