blob: 4d892a93b2cec2d64364cbdf20a4053dd8a573b0 [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001<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="smartdevicemanagement_v1.html">Smart Device Management API</a> . <a href="smartdevicemanagement_v1.enterprises.html">enterprises</a> . <a href="smartdevicemanagement_v1.enterprises.structures.html">structures</a> . <a href="smartdevicemanagement_v1.enterprises.structures.rooms.html">rooms</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets a room managed by the enterprise.</p>
83<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080084 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">Lists rooms managed by the enterprise.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
96 <code class="details" id="get">get(name, x__xgafv=None)</code>
97 <pre>Gets a room managed by the enterprise.
98
99Args:
100 name: string, The name of the room requested. For example: &quot;enterprises/XYZ/structures/ABC/rooms/123&quot;. (required)
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 { # Room resource represents an instance of sub-space within a structure such as rooms in a hotel suite or rental apartment.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800110 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the room. For example: &quot;enterprises/XYZ/structures/ABC/rooms/123&quot;.
111 &quot;traits&quot;: { # Room traits.
112 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
113 },
114}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700115</div>
116
117<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800118 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700119 <pre>Lists rooms managed by the enterprise.
120
121Args:
122 parent: string, The parent resource name of the rooms requested. For example: &quot;enterprises/XYZ/structures/ABC&quot;. (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800123 pageSize: integer, Requested page size. Server may return fewer rooms than requested. If unspecified, server will pick an appropriate default.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800124 pageToken: string, The token of the page to retrieve.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130Returns:
131 An object of the form:
132
133 { # Response message for SmartDeviceManagementService.ListRooms
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800134 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token to retrieve the next page of results. If this field is omitted, there are no subsequent pages.
135 &quot;rooms&quot;: [ # The list of rooms.
136 { # Room resource represents an instance of sub-space within a structure such as rooms in a hotel suite or rental apartment.
137 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the room. For example: &quot;enterprises/XYZ/structures/ABC/rooms/123&quot;.
138 &quot;traits&quot;: { # Room traits.
139 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700140 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800141 },
142 ],
143}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700144</div>
145
146<div class="method">
147 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
148 <pre>Retrieves the next page of results.
149
150Args:
151 previous_request: The request for the previous page. (required)
152 previous_response: The response from the request for the previous page. (required)
153
154Returns:
155 A request object that you can call &#x27;execute()&#x27; on to request the next
156 page. Returns None if there are no more items in the collection.
157 </pre>
158</div>
159
160</body></html>