blob: 12ce51bf9f34f609645fb69972c80d548c3e5188 [file] [log] [blame]
<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="plus_v1.html">Google+ API</a> . <a href="plus_v1.comments.html">comments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(commentId)</a></code></p>
<p class="firstline">Shut down. See https://developers.google.com/+/api-shutdown for more details.</p>
<p class="toc_element">
<code><a href="#list">list(activityId, maxResults=None, pageToken=None, sortOrder=None)</a></code></p>
<p class="firstline">Shut down. See https://developers.google.com/+/api-shutdown for more details.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(commentId)</code>
<pre>Shut down. See https://developers.google.com/+/api-shutdown for more details.
Args:
commentId: string, The ID of the comment to get. (required)
Returns:
An object of the form:
{
&quot;actor&quot;: { # The person who posted this comment.
&quot;clientSpecificActorInfo&quot;: { # Actor info specific to particular clients.
&quot;youtubeActorInfo&quot;: { # Actor info specific to YouTube clients.
&quot;channelId&quot;: &quot;A String&quot;, # ID of the YouTube channel owned by the Actor.
},
},
&quot;displayName&quot;: &quot;A String&quot;, # The name of this actor, suitable for display.
&quot;id&quot;: &quot;A String&quot;, # The ID of the actor.
&quot;image&quot;: { # The image representation of this actor.
&quot;url&quot;: &quot;A String&quot;, # The URL of the actor&#x27;s profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
&quot;url&quot;: &quot;A String&quot;, # A link to the Person resource for this actor.
&quot;verification&quot;: { # Verification status of actor.
&quot;adHocVerified&quot;: &quot;A String&quot;, # Verification for one-time or manual processes.
},
},
&quot;etag&quot;: &quot;A String&quot;, # ETag of this response for caching purposes.
&quot;id&quot;: &quot;A String&quot;, # The ID of this comment.
&quot;inReplyTo&quot;: [ # The activity this comment replied to.
{
&quot;id&quot;: &quot;A String&quot;, # The ID of the activity.
&quot;url&quot;: &quot;A String&quot;, # The URL of the activity.
},
],
&quot;kind&quot;: &quot;plus#comment&quot;, # Identifies this resource as a comment. Value: &quot;plus#comment&quot;.
&quot;object&quot;: { # The object of this comment.
&quot;content&quot;: &quot;A String&quot;, # The HTML-formatted content, suitable for display.
&quot;objectType&quot;: &quot;comment&quot;, # The object type of this comment. Possible values are:
# - &quot;comment&quot; - A comment in reply to an activity.
&quot;originalContent&quot;: &quot;A String&quot;, # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
},
&quot;plusoners&quot;: { # People who +1&#x27;d this comment.
&quot;totalItems&quot;: 42, # Total number of people who +1&#x27;d this comment.
},
&quot;published&quot;: &quot;A String&quot;, # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
&quot;selfLink&quot;: &quot;A String&quot;, # Link to this comment resource.
&quot;updated&quot;: &quot;A String&quot;, # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
&quot;verb&quot;: &quot;post&quot;, # This comment&#x27;s verb, indicating what action was performed. Possible values are:
# - &quot;post&quot; - Publish content to the stream.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(activityId, maxResults=None, pageToken=None, sortOrder=None)</code>
<pre>Shut down. See https://developers.google.com/+/api-shutdown for more details.
Args:
activityId: string, The ID of the activity to get comments for. (required)
maxResults: integer, The maximum number of comments to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of &quot;nextPageToken&quot; from the previous response.
sortOrder: string, The order in which to sort the list of comments.
Allowed values
ascending - Sort oldest comments first.
descending - Sort newest comments first.
Returns:
An object of the form:
{
&quot;etag&quot;: &quot;A String&quot;, # ETag of this response for caching purposes.
&quot;id&quot;: &quot;A String&quot;, # The ID of this collection of comments.
&quot;items&quot;: [ # The comments in this page of results.
{
&quot;actor&quot;: { # The person who posted this comment.
&quot;clientSpecificActorInfo&quot;: { # Actor info specific to particular clients.
&quot;youtubeActorInfo&quot;: { # Actor info specific to YouTube clients.
&quot;channelId&quot;: &quot;A String&quot;, # ID of the YouTube channel owned by the Actor.
},
},
&quot;displayName&quot;: &quot;A String&quot;, # The name of this actor, suitable for display.
&quot;id&quot;: &quot;A String&quot;, # The ID of the actor.
&quot;image&quot;: { # The image representation of this actor.
&quot;url&quot;: &quot;A String&quot;, # The URL of the actor&#x27;s profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
},
&quot;url&quot;: &quot;A String&quot;, # A link to the Person resource for this actor.
&quot;verification&quot;: { # Verification status of actor.
&quot;adHocVerified&quot;: &quot;A String&quot;, # Verification for one-time or manual processes.
},
},
&quot;etag&quot;: &quot;A String&quot;, # ETag of this response for caching purposes.
&quot;id&quot;: &quot;A String&quot;, # The ID of this comment.
&quot;inReplyTo&quot;: [ # The activity this comment replied to.
{
&quot;id&quot;: &quot;A String&quot;, # The ID of the activity.
&quot;url&quot;: &quot;A String&quot;, # The URL of the activity.
},
],
&quot;kind&quot;: &quot;plus#comment&quot;, # Identifies this resource as a comment. Value: &quot;plus#comment&quot;.
&quot;object&quot;: { # The object of this comment.
&quot;content&quot;: &quot;A String&quot;, # The HTML-formatted content, suitable for display.
&quot;objectType&quot;: &quot;comment&quot;, # The object type of this comment. Possible values are:
# - &quot;comment&quot; - A comment in reply to an activity.
&quot;originalContent&quot;: &quot;A String&quot;, # The content (text) as provided by the author, stored without any HTML formatting. When creating or updating a comment, this value must be supplied as plain text in the request.
},
&quot;plusoners&quot;: { # People who +1&#x27;d this comment.
&quot;totalItems&quot;: 42, # Total number of people who +1&#x27;d this comment.
},
&quot;published&quot;: &quot;A String&quot;, # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
&quot;selfLink&quot;: &quot;A String&quot;, # Link to this comment resource.
&quot;updated&quot;: &quot;A String&quot;, # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
&quot;verb&quot;: &quot;post&quot;, # This comment&#x27;s verb, indicating what action was performed. Possible values are:
# - &quot;post&quot; - Publish content to the stream.
},
],
&quot;kind&quot;: &quot;plus#commentFeed&quot;, # Identifies this resource as a collection of comments. Value: &quot;plus#commentFeed&quot;.
&quot;nextLink&quot;: &quot;A String&quot;, # Link to the next page of activities.
&quot;nextPageToken&quot;: &quot;A String&quot;, # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
&quot;title&quot;: &quot;A String&quot;, # The title of this collection of comments.
&quot;updated&quot;: &quot;A String&quot;, # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>