Files
deb-python-oauth2client/docs/dyn/moderator_v1.submissions.html
2012-07-09 16:53:09 -04:00

262 lines
5.7 KiB
HTML

<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="moderator_v1.html">Moderator API</a> . <a href="moderator_v1.submissions.html">submissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(seriesId, submissionId, lang=None, includeVotes=None)</a></code></p>
<p class="firstline">Returns the specified submission within the specified series.</p>
<p class="toc_element">
<code><a href="#insert">insert(seriesId, topicId, body, unauthToken=None, anonymous=None)</a></code></p>
<p class="firstline">Inserts a new submission in the specified topic within the specified series.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(seriesId, submissionId, lang=None, includeVotes=None)</code>
<pre>Returns the specified submission within the specified series.
Args:
seriesId: integer, The decimal ID of the Series. (required)
submissionId: integer, The decimal ID of the Submission within the Series. (required)
lang: string, The language code for the language the client prefers resuls in.
includeVotes: boolean, Specifies whether to include the current user's vote
Returns:
An object of the form:
{
"kind": "moderator#submission",
"attribution": {
"displayName": "A String",
"location": "A String",
"avatarUrl": "A String",
},
"created": "A String",
"text": "A String",
"topics": [
{
"id": {
"seriesId": "A String",
"topicId": "A String",
},
},
],
"author": "A String",
"translations": [
{
"lang": "A String",
"text": "A String",
},
],
"parentSubmissionId": {
"seriesId": "A String",
"submissionId": "A String",
},
"vote": {
"vote": "A String",
"flag": "A String",
},
"attachmentUrl": "A String",
"geo": {
"latitude": 3.14,
"location": "A String",
"longitude": 3.14,
},
"id": {
"seriesId": "A String",
"submissionId": "A String",
},
"counters": {
"noneVotes": 42,
"minusVotes": 42,
"plusVotes": 42,
},
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(seriesId, topicId, body, unauthToken=None, anonymous=None)</code>
<pre>Inserts a new submission in the specified topic within the specified series.
Args:
seriesId: integer, The decimal ID of the Series. (required)
topicId: integer, The decimal ID of the Topic within the Series. (required)
body: object, The request body. (required)
The object takes the form of:
{
"kind": "moderator#submission",
"attribution": {
"displayName": "A String",
"location": "A String",
"avatarUrl": "A String",
},
"created": "A String",
"text": "A String",
"topics": [
{
"id": {
"seriesId": "A String",
"topicId": "A String",
},
},
],
"author": "A String",
"translations": [
{
"lang": "A String",
"text": "A String",
},
],
"parentSubmissionId": {
"seriesId": "A String",
"submissionId": "A String",
},
"vote": {
"vote": "A String",
"flag": "A String",
},
"attachmentUrl": "A String",
"geo": {
"latitude": 3.14,
"location": "A String",
"longitude": 3.14,
},
"id": {
"seriesId": "A String",
"submissionId": "A String",
},
"counters": {
"noneVotes": 42,
"minusVotes": 42,
"plusVotes": 42,
},
}
unauthToken: string, User identifier for unauthenticated usage mode
anonymous: boolean, Set to true to mark the new submission as anonymous.
Returns:
An object of the form:
{
"kind": "moderator#submission",
"attribution": {
"displayName": "A String",
"location": "A String",
"avatarUrl": "A String",
},
"created": "A String",
"text": "A String",
"topics": [
{
"id": {
"seriesId": "A String",
"topicId": "A String",
},
},
],
"author": "A String",
"translations": [
{
"lang": "A String",
"text": "A String",
},
],
"parentSubmissionId": {
"seriesId": "A String",
"submissionId": "A String",
},
"vote": {
"vote": "A String",
"flag": "A String",
},
"attachmentUrl": "A String",
"geo": {
"latitude": 3.14,
"location": "A String",
"longitude": 3.14,
},
"id": {
"seriesId": "A String",
"submissionId": "A String",
},
"counters": {
"noneVotes": 42,
"minusVotes": 42,
"plusVotes": 42,
},
}</pre>
</div>
</body></html>