Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / dyn / v1dev_v1dev.items.html
blob: f6c690895bf7a099467ee39b2c43fe5e6d3faf40 [file] [log] [blame]
Joe Gregorio37802c32013-08-06 12:24:05 -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="v1dev_v1dev.html">Wax API</a> . <a href="v1dev_v1dev.items.html">items</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(sessionId, itemId)</a></code></p>
79<p class="firstline">Deletes an item.</p>
80<p class="toc_element">
81 <code><a href="#get">get(sessionId, itemId)</a></code></p>
82<p class="firstline">Gets one item by ID.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(sessionId, body)</a></code></p>
85<p class="firstline">Inserts a new item into this session.</p>
86<p class="toc_element">
87 <code><a href="#list">list(sessionId)</a></code></p>
88<p class="firstline">Retrieves a list of items in a session.</p>
89<p class="toc_element">
90 <code><a href="#patch">patch(sessionId, itemId, body)</a></code></p>
91<p class="firstline">Updates an existing item. This method supports patch semantics.</p>
92<p class="toc_element">
93 <code><a href="#update">update(sessionId, itemId, body)</a></code></p>
94<p class="firstline">Updates an existing item.</p>
95<p class="toc_element">
96 <code><a href="#watch">watch(sessionId, body)</a></code></p>
97<p class="firstline">Subscribe to changes to any item in a session.</p>
98<p class="toc_element">
99 <code><a href="#watchToOneItem">watchToOneItem(sessionId, itemId, body)</a></code></p>
100<p class="firstline">Subscribe to changes to one item in a session.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="delete">delete(sessionId, itemId)</code>
104 <pre>Deletes an item.
105
106Args:
107 sessionId: string, The session ID. (required)
108 itemId: string, The item ID. (required)
109</pre>
110</div>
111
112<div class="method">
113 <code class="details" id="get">get(sessionId, itemId)</code>
114 <pre>Gets one item by ID.
115
116Args:
117 sessionId: string, The session ID. (required)
118 itemId: string, The item ID. (required)
119
120Returns:
121 An object of the form:
122
123 {
124 "blobOfData": "A String", # A blob of data stored in the item.
125 "sizeInBytes": 42, # The size (in bytes) of the blob of data.
126 "kind": "wax#waxDataItem", # The kind of object this is.
127 "id": "A String", # The item ID.
128 "name": "A String", # The name of the item.
129 }</pre>
130</div>
131
132<div class="method">
133 <code class="details" id="insert">insert(sessionId, body)</code>
134 <pre>Inserts a new item into this session.
135
136Args:
137 sessionId: string, The session ID. (required)
138 body: object, The request body. (required)
139 The object takes the form of:
140
141{
142 "blobOfData": "A String", # A blob of data stored in the item.
143 "sizeInBytes": 42, # The size (in bytes) of the blob of data.
144 "kind": "wax#waxDataItem", # The kind of object this is.
145 "id": "A String", # The item ID.
146 "name": "A String", # The name of the item.
147 }
148
149
150Returns:
151 An object of the form:
152
153 {
154 "blobOfData": "A String", # A blob of data stored in the item.
155 "sizeInBytes": 42, # The size (in bytes) of the blob of data.
156 "kind": "wax#waxDataItem", # The kind of object this is.
157 "id": "A String", # The item ID.
158 "name": "A String", # The name of the item.
159 }</pre>
160</div>
161
162<div class="method">
163 <code class="details" id="list">list(sessionId)</code>
164 <pre>Retrieves a list of items in a session.
165
166Args:
167 sessionId: string, The session ID. (required)
168
169Returns:
170 An object of the form:
171
172 {
173 "items": [ # The list of Wax items.
174 {
175 "blobOfData": "A String", # A blob of data stored in the item.
176 "sizeInBytes": 42, # The size (in bytes) of the blob of data.
177 "kind": "wax#waxDataItem", # The kind of object this is.
178 "id": "A String", # The item ID.
179 "name": "A String", # The name of the item.
180 },
181 ],
182 "kind": "wax#waxList", # The kind of object this is.
183 }</pre>
184</div>
185
186<div class="method">
187 <code class="details" id="patch">patch(sessionId, itemId, body)</code>
188 <pre>Updates an existing item. This method supports patch semantics.
189
190Args:
191 sessionId: string, The session ID. (required)
192 itemId: string, The item ID. (required)
193 body: object, The request body. (required)
194 The object takes the form of:
195
196{
197 "blobOfData": "A String", # A blob of data stored in the item.
198 "sizeInBytes": 42, # The size (in bytes) of the blob of data.
199 "kind": "wax#waxDataItem", # The kind of object this is.
200 "id": "A String", # The item ID.
201 "name": "A String", # The name of the item.
202 }
203
204
205Returns:
206 An object of the form:
207
208 {
209 "blobOfData": "A String", # A blob of data stored in the item.
210 "sizeInBytes": 42, # The size (in bytes) of the blob of data.
211 "kind": "wax#waxDataItem", # The kind of object this is.
212 "id": "A String", # The item ID.
213 "name": "A String", # The name of the item.
214 }</pre>
215</div>
216
217<div class="method">
218 <code class="details" id="update">update(sessionId, itemId, body)</code>
219 <pre>Updates an existing item.
220
221Args:
222 sessionId: string, The session ID. (required)
223 itemId: string, The item ID. (required)
224 body: object, The request body. (required)
225 The object takes the form of:
226
227{
228 "blobOfData": "A String", # A blob of data stored in the item.
229 "sizeInBytes": 42, # The size (in bytes) of the blob of data.
230 "kind": "wax#waxDataItem", # The kind of object this is.
231 "id": "A String", # The item ID.
232 "name": "A String", # The name of the item.
233 }
234
235
236Returns:
237 An object of the form:
238
239 {
240 "blobOfData": "A String", # A blob of data stored in the item.
241 "sizeInBytes": 42, # The size (in bytes) of the blob of data.
242 "kind": "wax#waxDataItem", # The kind of object this is.
243 "id": "A String", # The item ID.
244 "name": "A String", # The name of the item.
245 }</pre>
246</div>
247
248<div class="method">
249 <code class="details" id="watch">watch(sessionId, body)</code>
250 <pre>Subscribe to changes to any item in a session.
251
252Args:
253 sessionId: string, The session ID. (required)
254 body: object, The request body. (required)
255 The object takes the form of:
256
257{
258 "resourceUri": "A String", # The canonicalized ID of the watched resource.
259 "kind": "api#channel", # A channel watching an API resource
260 "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
261 "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
262 "params": { # Additional parameters controlling delivery channel behavior
263 "a_key": "A String", # Declares a new parameter by name.
264 },
265 "expiration": "A String", # The expiration instant for this channel if it is defined.
266 "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
267 "type": "A String", # The type of delivery mechanism used by this channel
268 "id": "A String", # A UUID for the channel
269 }
270
271
272Returns:
273 An object of the form:
274
275 {
276 "resourceUri": "A String", # The canonicalized ID of the watched resource.
277 "kind": "api#channel", # A channel watching an API resource
278 "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
279 "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
280 "params": { # Additional parameters controlling delivery channel behavior
281 "a_key": "A String", # Declares a new parameter by name.
282 },
283 "expiration": "A String", # The expiration instant for this channel if it is defined.
284 "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
285 "type": "A String", # The type of delivery mechanism used by this channel
286 "id": "A String", # A UUID for the channel
287 }</pre>
288</div>
289
290<div class="method">
291 <code class="details" id="watchToOneItem">watchToOneItem(sessionId, itemId, body)</code>
292 <pre>Subscribe to changes to one item in a session.
293
294Args:
295 sessionId: string, The session ID. (required)
296 itemId: string, The item ID. (required)
297 body: object, The request body. (required)
298 The object takes the form of:
299
300{
301 "resourceUri": "A String", # The canonicalized ID of the watched resource.
302 "kind": "api#channel", # A channel watching an API resource
303 "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
304 "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
305 "params": { # Additional parameters controlling delivery channel behavior
306 "a_key": "A String", # Declares a new parameter by name.
307 },
308 "expiration": "A String", # The expiration instant for this channel if it is defined.
309 "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
310 "type": "A String", # The type of delivery mechanism used by this channel
311 "id": "A String", # A UUID for the channel
312 }
313
314
315Returns:
316 An object of the form:
317
318 {
319 "resourceUri": "A String", # The canonicalized ID of the watched resource.
320 "kind": "api#channel", # A channel watching an API resource
321 "resourceId": "A String", # An opaque id that identifies the resource that is being watched. Stable across different API versions
322 "token": "A String", # An arbitrary string associated with the channel that is delivered to the target address with each event delivered over this channel.
323 "params": { # Additional parameters controlling delivery channel behavior
324 "a_key": "A String", # Declares a new parameter by name.
325 },
326 "expiration": "A String", # The expiration instant for this channel if it is defined.
327 "address": "A String", # The address of the receiving entity where events are delivered. Specific to the channel type.
328 "type": "A String", # The type of delivery mechanism used by this channel
329 "id": "A String", # A UUID for the channel
330 }</pre>
331</div>
332
333</body></html>