Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / plus_v1.comments.html
blob: 12ce51bf9f34f609645fb69972c80d548c3e5188 [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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Shut down. See https://developers.google.com/+/api-shutdown for more details.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]81 <code><a href="#list">list(activityId, maxResults=None, pageToken=None, sortOrder=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Shut down. See https://developers.google.com/+/api-shutdown for more details.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89 <pre>Shut down. See https://developers.google.com/+/api-shutdown for more details.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]90
91Args:
92 commentId: string, The ID of the comment to get. (required)
93
94Returns:
95 An object of the form:
96
97 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]98 &quot;actor&quot;: { # The person who posted this comment.
99 &quot;clientSpecificActorInfo&quot;: { # Actor info specific to particular clients.
100 &quot;youtubeActorInfo&quot;: { # Actor info specific to YouTube clients.
101 &quot;channelId&quot;: &quot;A String&quot;, # ID of the YouTube channel owned by the Actor.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102 },
103 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]104 &quot;displayName&quot;: &quot;A String&quot;, # The name of this actor, suitable for display.
105 &quot;id&quot;: &quot;A String&quot;, # The ID of the actor.
106 &quot;image&quot;: { # The image representation of this actor.
107 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]109 &quot;url&quot;: &quot;A String&quot;, # A link to the Person resource for this actor.
110 &quot;verification&quot;: { # Verification status of actor.
111 &quot;adHocVerified&quot;: &quot;A String&quot;, # Verification for one-time or manual processes.
112 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]113 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]114 &quot;etag&quot;: &quot;A String&quot;, # ETag of this response for caching purposes.
115 &quot;id&quot;: &quot;A String&quot;, # The ID of this comment.
116 &quot;inReplyTo&quot;: [ # The activity this comment replied to.
117 {
118 &quot;id&quot;: &quot;A String&quot;, # The ID of the activity.
119 &quot;url&quot;: &quot;A String&quot;, # The URL of the activity.
120 },
121 ],
122 &quot;kind&quot;: &quot;plus#comment&quot;, # Identifies this resource as a comment. Value: &quot;plus#comment&quot;.
123 &quot;object&quot;: { # The object of this comment.
124 &quot;content&quot;: &quot;A String&quot;, # The HTML-formatted content, suitable for display.
125 &quot;objectType&quot;: &quot;comment&quot;, # The object type of this comment. Possible values are:
126 # - &quot;comment&quot; - A comment in reply to an activity.
127 &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.
128 },
129 &quot;plusoners&quot;: { # People who +1&#x27;d this comment.
130 &quot;totalItems&quot;: 42, # Total number of people who +1&#x27;d this comment.
131 },
132 &quot;published&quot;: &quot;A String&quot;, # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
133 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this comment resource.
134 &quot;updated&quot;: &quot;A String&quot;, # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
135 &quot;verb&quot;: &quot;post&quot;, # This comment&#x27;s verb, indicating what action was performed. Possible values are:
136 # - &quot;post&quot; - Publish content to the stream.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]137 }</pre>
138</div>
139
140<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]141 <code class="details" id="list">list(activityId, maxResults=None, pageToken=None, sortOrder=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 <pre>Shut down. See https://developers.google.com/+/api-shutdown for more details.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143
144Args:
145 activityId: string, The ID of the activity to get comments for. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]147 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 sortOrder: string, The order in which to sort the list of comments.
149 Allowed values
150 ascending - Sort oldest comments first.
151 descending - Sort newest comments first.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]152
153Returns:
154 An object of the form:
155
156 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]157 &quot;etag&quot;: &quot;A String&quot;, # ETag of this response for caching purposes.
158 &quot;id&quot;: &quot;A String&quot;, # The ID of this collection of comments.
159 &quot;items&quot;: [ # The comments in this page of results.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]160 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]161 &quot;actor&quot;: { # The person who posted this comment.
162 &quot;clientSpecificActorInfo&quot;: { # Actor info specific to particular clients.
163 &quot;youtubeActorInfo&quot;: { # Actor info specific to YouTube clients.
164 &quot;channelId&quot;: &quot;A String&quot;, # ID of the YouTube channel owned by the Actor.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 },
166 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]167 &quot;displayName&quot;: &quot;A String&quot;, # The name of this actor, suitable for display.
168 &quot;id&quot;: &quot;A String&quot;, # The ID of the actor.
169 &quot;image&quot;: { # The image representation of this actor.
170 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]172 &quot;url&quot;: &quot;A String&quot;, # A link to the Person resource for this actor.
173 &quot;verification&quot;: { # Verification status of actor.
174 &quot;adHocVerified&quot;: &quot;A String&quot;, # Verification for one-time or manual processes.
175 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]176 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]177 &quot;etag&quot;: &quot;A String&quot;, # ETag of this response for caching purposes.
178 &quot;id&quot;: &quot;A String&quot;, # The ID of this comment.
179 &quot;inReplyTo&quot;: [ # The activity this comment replied to.
180 {
181 &quot;id&quot;: &quot;A String&quot;, # The ID of the activity.
182 &quot;url&quot;: &quot;A String&quot;, # The URL of the activity.
183 },
184 ],
185 &quot;kind&quot;: &quot;plus#comment&quot;, # Identifies this resource as a comment. Value: &quot;plus#comment&quot;.
186 &quot;object&quot;: { # The object of this comment.
187 &quot;content&quot;: &quot;A String&quot;, # The HTML-formatted content, suitable for display.
188 &quot;objectType&quot;: &quot;comment&quot;, # The object type of this comment. Possible values are:
189 # - &quot;comment&quot; - A comment in reply to an activity.
190 &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.
191 },
192 &quot;plusoners&quot;: { # People who +1&#x27;d this comment.
193 &quot;totalItems&quot;: 42, # Total number of people who +1&#x27;d this comment.
194 },
195 &quot;published&quot;: &quot;A String&quot;, # The time at which this comment was initially published. Formatted as an RFC 3339 timestamp.
196 &quot;selfLink&quot;: &quot;A String&quot;, # Link to this comment resource.
197 &quot;updated&quot;: &quot;A String&quot;, # The time at which this comment was last updated. Formatted as an RFC 3339 timestamp.
198 &quot;verb&quot;: &quot;post&quot;, # This comment&#x27;s verb, indicating what action was performed. Possible values are:
199 # - &quot;post&quot; - Publish content to the stream.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]200 },
201 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]202 &quot;kind&quot;: &quot;plus#commentFeed&quot;, # Identifies this resource as a collection of comments. Value: &quot;plus#commentFeed&quot;.
203 &quot;nextLink&quot;: &quot;A String&quot;, # Link to the next page of activities.
204 &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.
205 &quot;title&quot;: &quot;A String&quot;, # The title of this collection of comments.
206 &quot;updated&quot;: &quot;A String&quot;, # The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]207 }</pre>
208</div>
209
210<div class="method">
211 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
212 <pre>Retrieves the next page of results.
213
214Args:
215 previous_request: The request for the previous page. (required)
216 previous_response: The response from the request for the previous page. (required)
217
218Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]219 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]220 page. Returns None if there are no more items in the collection.
221 </pre>
222</div>
223
224</body></html>