Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 46a8071fe1d1a112dcc791f61c20fd8306b4061f / . / docs / dyn / plus_v1.comments.html
blob: e0e0e1b3e3723dc4cf4928d9e6548392a616a528 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="plus_v1.html">Google+ API</a> . <a href="plus_v1.comments.html">comments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(commentId)</a></code></p>
79<p class="firstline">Get a comment.</p>
80<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]81 <code><a href="#list">list(activityId, pageToken=None, maxResults=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">List all of the comments for an activity.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(commentId)</code>
89 <pre>Get a comment.
90
91Args:
92 commentId: string, The ID of the comment to get. (required)
93
94Returns:
95 An object of the form:
96
97 {
98 "inReplyTo": [ # The activity this comment replied to.
99 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]100 "url": "A String", # The url of the activity.
101 "id": "A String", # The id of the activity.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]102 },
103 ],
104 "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]105 "object": { # The object of this comment.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]106 "content": "A String", # The content of this comment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]107 "objectType": "comment", # The object type of this comment. Possible values are:
108 # - "comment" - A comment in reply to an activity.
109 },
110 "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
111 "actor": { # The person who posted this comment.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]112 "url": "A String", # A link to the person resource for this actor.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]113 "image": { # The image representation of this actor.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]114 "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]115 },
116 "displayName": "A String", # The name of this actor, suitable for display.
117 "id": "A String", # The ID of the actor.
118 },
119 "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
120 # - "post" - Publish content to the stream.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]121 "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
122 "id": "A String", # The ID of this comment.
123 "selfLink": "A String", # Link to this comment resource.
124 }</pre>
125</div>
126
127<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]128 <code class="details" id="list">list(activityId, pageToken=None, maxResults=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]129 <pre>List all of the comments for an activity.
130
131Args:
132 activityId: string, The ID of the activity to get comments for. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]133 pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
134 maxResults: integer, The maximum number of comments to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]135
136Returns:
137 An object of the form:
138
139 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]140 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141 "kind": "plus#commentFeed", # Identifies this resource as a collection of comments. Value: "plus#commentFeed".
142 "title": "A String", # The title of this collection of comments.
143 "items": [ # The comments in this page of results.
144 {
145 "inReplyTo": [ # The activity this comment replied to.
146 {
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]147 "url": "A String", # The url of the activity.
148 "id": "A String", # The id of the activity.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]149 },
150 ],
151 "kind": "plus#comment", # Identifies this resource as a comment. Value: "plus#comment".
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]152 "object": { # The object of this comment.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]153 "content": "A String", # The content of this comment.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 "objectType": "comment", # The object type of this comment. Possible values are:
155 # - "comment" - A comment in reply to an activity.
156 },
157 "updated": "A String", # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
158 "actor": { # The person who posted this comment.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]159 "url": "A String", # A link to the person resource for this actor.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]160 "image": { # The image representation of this actor.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]161 "url": "A String", # The URL of the actor's profile photo. To re-size the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162 },
163 "displayName": "A String", # The name of this actor, suitable for display.
164 "id": "A String", # The ID of the actor.
165 },
166 "verb": "post", # This comment's verb, indicating what action was performed. Possible values are:
167 # - "post" - Publish content to the stream.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]168 "published": "A String", # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
169 "id": "A String", # The ID of this comment.
170 "selfLink": "A String", # Link to this comment resource.
171 },
172 ],
173 "updated": "A String", # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
174 "nextLink": "A String", # Link to the next page of activities.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]175 "id": "A String", # The ID of this collection of comments.
176 }</pre>
177</div>
178
179<div class="method">
180 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
181 <pre>Retrieves the next page of results.
182
183Args:
184 previous_request: The request for the previous page. (required)
185 previous_response: The response from the request for the previous page. (required)
186
187Returns:
188 A request object that you can call 'execute()' on to request the next
189 page. Returns None if there are no more items in the collection.
190 </pre>
191</div>
192
193</body></html>