1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="mirror_v1.html">Google Mirror API</a> . <a href="mirror_v1.contacts.html">contacts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(id)</a></code></p>
<p class="firstline">Deletes a contact.</p>
<p class="toc_element">
<code><a href="#get">get(id)</a></code></p>
<p class="firstline">Gets a single contact by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(body)</a></code></p>
<p class="firstline">Inserts a new contact.</p>
<p class="toc_element">
<code><a href="#list">list()</a></code></p>
<p class="firstline">Retrieves a list of contacts for the authenticated user.</p>
<p class="toc_element">
<code><a href="#patch">patch(id, body)</a></code></p>
<p class="firstline">Updates a contact in place. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(id, body)</a></code></p>
<p class="firstline">Updates a contact in place.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(id)</code>
<pre>Deletes a contact.
Args:
id: string, The ID of the contact. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(id)</code>
<pre>Gets a single contact by ID.
Args:
id: string, The ID of the contact. (required)
Returns:
An object of the form:
{ # A person or group that can be used as a creator or a contact.
"kind": "mirror#contact", # The type of resource. This is always mirror#contact.
"displayName": "A String", # The name to display for this contact.
"acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
"A String",
],
"imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
"A String",
],
"priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
"source": "A String", # The ID of the application that created this contact. This is populated by the API
"phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
"sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
# - ADD_CAPTION
"A String",
],
"type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
# - INDIVIDUAL - Represents a single person. This is the default.
# - GROUP - Represents more than a single person.
"acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
{ # A single menu command that is part of a Contact.
"type": "A String", # The type of operation this command corresponds to. Allowed values are:
# - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
# - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
},
],
"id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
"speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body)</code>
<pre>Inserts a new contact.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # A person or group that can be used as a creator or a contact.
"kind": "mirror#contact", # The type of resource. This is always mirror#contact.
"displayName": "A String", # The name to display for this contact.
"acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
"A String",
],
"imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
"A String",
],
"priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
"source": "A String", # The ID of the application that created this contact. This is populated by the API
"phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
"sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
# - ADD_CAPTION
"A String",
],
"type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
# - INDIVIDUAL - Represents a single person. This is the default.
# - GROUP - Represents more than a single person.
"acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
{ # A single menu command that is part of a Contact.
"type": "A String", # The type of operation this command corresponds to. Allowed values are:
# - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
# - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
},
],
"id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
"speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
}
Returns:
An object of the form:
{ # A person or group that can be used as a creator or a contact.
"kind": "mirror#contact", # The type of resource. This is always mirror#contact.
"displayName": "A String", # The name to display for this contact.
"acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
"A String",
],
"imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
"A String",
],
"priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
"source": "A String", # The ID of the application that created this contact. This is populated by the API
"phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
"sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
# - ADD_CAPTION
"A String",
],
"type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
# - INDIVIDUAL - Represents a single person. This is the default.
# - GROUP - Represents more than a single person.
"acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
{ # A single menu command that is part of a Contact.
"type": "A String", # The type of operation this command corresponds to. Allowed values are:
# - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
# - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
},
],
"id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
"speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list()</code>
<pre>Retrieves a list of contacts for the authenticated user.
Args:
Returns:
An object of the form:
{ # A list of Contacts representing contacts. This is the response from the server to GET requests on the contacts collection.
"items": [ # Contact list.
{ # A person or group that can be used as a creator or a contact.
"kind": "mirror#contact", # The type of resource. This is always mirror#contact.
"displayName": "A String", # The name to display for this contact.
"acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
"A String",
],
"imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
"A String",
],
"priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
"source": "A String", # The ID of the application that created this contact. This is populated by the API
"phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
"sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
# - ADD_CAPTION
"A String",
],
"type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
# - INDIVIDUAL - Represents a single person. This is the default.
# - GROUP - Represents more than a single person.
"acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
{ # A single menu command that is part of a Contact.
"type": "A String", # The type of operation this command corresponds to. Allowed values are:
# - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
# - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
},
],
"id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
"speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
},
],
"kind": "mirror#contacts", # The type of resource. This is always mirror#contacts.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(id, body)</code>
<pre>Updates a contact in place. This method supports patch semantics.
Args:
id: string, The ID of the contact. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A person or group that can be used as a creator or a contact.
"kind": "mirror#contact", # The type of resource. This is always mirror#contact.
"displayName": "A String", # The name to display for this contact.
"acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
"A String",
],
"imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
"A String",
],
"priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
"source": "A String", # The ID of the application that created this contact. This is populated by the API
"phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
"sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
# - ADD_CAPTION
"A String",
],
"type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
# - INDIVIDUAL - Represents a single person. This is the default.
# - GROUP - Represents more than a single person.
"acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
{ # A single menu command that is part of a Contact.
"type": "A String", # The type of operation this command corresponds to. Allowed values are:
# - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
# - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
},
],
"id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
"speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
}
Returns:
An object of the form:
{ # A person or group that can be used as a creator or a contact.
"kind": "mirror#contact", # The type of resource. This is always mirror#contact.
"displayName": "A String", # The name to display for this contact.
"acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
"A String",
],
"imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
"A String",
],
"priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
"source": "A String", # The ID of the application that created this contact. This is populated by the API
"phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
"sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
# - ADD_CAPTION
"A String",
],
"type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
# - INDIVIDUAL - Represents a single person. This is the default.
# - GROUP - Represents more than a single person.
"acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
{ # A single menu command that is part of a Contact.
"type": "A String", # The type of operation this command corresponds to. Allowed values are:
# - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
# - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
},
],
"id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
"speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(id, body)</code>
<pre>Updates a contact in place.
Args:
id: string, The ID of the contact. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A person or group that can be used as a creator or a contact.
"kind": "mirror#contact", # The type of resource. This is always mirror#contact.
"displayName": "A String", # The name to display for this contact.
"acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
"A String",
],
"imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
"A String",
],
"priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
"source": "A String", # The ID of the application that created this contact. This is populated by the API
"phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
"sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
# - ADD_CAPTION
"A String",
],
"type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
# - INDIVIDUAL - Represents a single person. This is the default.
# - GROUP - Represents more than a single person.
"acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
{ # A single menu command that is part of a Contact.
"type": "A String", # The type of operation this command corresponds to. Allowed values are:
# - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
# - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
},
],
"id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
"speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
}
Returns:
An object of the form:
{ # A person or group that can be used as a creator or a contact.
"kind": "mirror#contact", # The type of resource. This is always mirror#contact.
"displayName": "A String", # The name to display for this contact.
"acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items.
"A String",
],
"imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client.
"A String",
],
"priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities.
"source": "A String", # The ID of the application that created this contact. This is populated by the API
"phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number.
"sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are:
# - ADD_CAPTION
"A String",
],
"type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are:
# - INDIVIDUAL - Represents a single person. This is the default.
# - GROUP - Represents more than a single person.
"acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command.
{ # A single menu command that is part of a Contact.
"type": "A String", # The type of operation this command corresponds to. Allowed values are:
# - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command.
# - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command.
},
],
"id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token.
"speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic.
}</pre>
</div>
</body></html>
|
