• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="plusDomains_v1.html">Google+ Domains API</a> . <a href="plusDomains_v1.circles.html">circles</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(userId, pageToken=None, maxResults=None)</a></code></p>
79<p class="firstline">Shut down. See https://developers.google.com/+/api-shutdown for more details.</p>
80<p class="toc_element">
81  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="list">list(userId, pageToken=None, maxResults=None)</code>
86  <pre>Shut down. See https://developers.google.com/+/api-shutdown for more details.
87
88Args:
89  userId: string, The ID of the user to get circles for. The special value "me" can be used to indicate the authenticated user. (required)
90  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 "nextPageToken" from the previous response.
91  maxResults: integer, The maximum number of circles to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
92
93Returns:
94  An object of the form:
95
96    {
97    "nextPageToken": "A String", # 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.
98    "kind": "plus#circleFeed", # Identifies this resource as a collection of circles. Value: "plus#circleFeed".
99    "title": "A String", # The title of this list of resources.
100    "items": [ # The circles in this page of results.
101      {
102        "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle".
103        "displayName": "A String", # The circle name.
104        "description": "A String", # The description of this circle.
105        "people": { # The people in this circle.
106          "totalItems": 42, # The total number of people in this circle.
107        },
108        "etag": "A String", # ETag of this response for caching purposes.
109        "id": "A String", # The ID of the circle.
110        "selfLink": "A String", # Link to this circle resource
111      },
112    ],
113    "nextLink": "A String", # Link to the next page of circles.
114    "etag": "A String", # ETag of this response for caching purposes.
115    "totalItems": 42, # The total number of circles. The number of circles in this response may be smaller due to paging.
116    "selfLink": "A String", # Link to this page of circles.
117  }</pre>
118</div>
119
120<div class="method">
121    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
122  <pre>Retrieves the next page of results.
123
124Args:
125  previous_request: The request for the previous page. (required)
126  previous_response: The response from the request for the previous page. (required)
127
128Returns:
129  A request object that you can call 'execute()' on to request the next
130  page. Returns None if there are no more items in the collection.
131    </pre>
132</div>
133
134</body></html>