@capgo/capacitor-contacts 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CapgoCapacitorContacts.podspec +17 -0
- package/LICENSE +21 -0
- package/Package.swift +28 -0
- package/README.md +884 -0
- package/android/build.gradle +57 -0
- package/android/src/main/AndroidManifest.xml +2 -0
- package/android/src/main/java/app/capgo/contacts/CapacitorContactsPlugin.java +770 -0
- package/android/src/main/res/.gitkeep +0 -0
- package/dist/docs.json +2437 -0
- package/dist/esm/definitions.d.ts +944 -0
- package/dist/esm/definitions.js +2 -0
- package/dist/esm/definitions.js.map +1 -0
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.js +7 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/web.d.ts +28 -0
- package/dist/esm/web.js +70 -0
- package/dist/esm/web.js.map +1 -0
- package/dist/plugin.cjs.js +84 -0
- package/dist/plugin.cjs.js.map +1 -0
- package/dist/plugin.js +87 -0
- package/dist/plugin.js.map +1 -0
- package/ios/Sources/CapacitorContactsPlugin/CapacitorContactsPlugin.swift +515 -0
- package/ios/Tests/CapacitorContactsPluginTests/CapacitorContactsPluginTests.swift +9 -0
- package/package.json +89 -0
package/dist/docs.json
ADDED
|
@@ -0,0 +1,2437 @@
|
|
|
1
|
+
{
|
|
2
|
+
"api": {
|
|
3
|
+
"name": "CapacitorContactsPlugin",
|
|
4
|
+
"slug": "capacitorcontactsplugin",
|
|
5
|
+
"docs": "Capacitor Contacts Plugin interface for managing device contacts.",
|
|
6
|
+
"tags": [
|
|
7
|
+
{
|
|
8
|
+
"text": "1.0.0",
|
|
9
|
+
"name": "since"
|
|
10
|
+
}
|
|
11
|
+
],
|
|
12
|
+
"methods": [
|
|
13
|
+
{
|
|
14
|
+
"name": "countContacts",
|
|
15
|
+
"signature": "() => Promise<CountContactsResult>",
|
|
16
|
+
"parameters": [],
|
|
17
|
+
"returns": "Promise<CountContactsResult>",
|
|
18
|
+
"tags": [
|
|
19
|
+
{
|
|
20
|
+
"name": "returns",
|
|
21
|
+
"text": "Promise that resolves with the total count of contacts"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"name": "since",
|
|
25
|
+
"text": "1.0.0"
|
|
26
|
+
}
|
|
27
|
+
],
|
|
28
|
+
"docs": "Count the total number of contacts on the device.",
|
|
29
|
+
"complexTypes": [
|
|
30
|
+
"CountContactsResult"
|
|
31
|
+
],
|
|
32
|
+
"slug": "countcontacts"
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
"name": "createContact",
|
|
36
|
+
"signature": "(options: CreateContactOptions) => Promise<CreateContactResult>",
|
|
37
|
+
"parameters": [
|
|
38
|
+
{
|
|
39
|
+
"name": "options",
|
|
40
|
+
"docs": "- The contact information to create",
|
|
41
|
+
"type": "CreateContactOptions"
|
|
42
|
+
}
|
|
43
|
+
],
|
|
44
|
+
"returns": "Promise<CreateContactResult>",
|
|
45
|
+
"tags": [
|
|
46
|
+
{
|
|
47
|
+
"name": "param",
|
|
48
|
+
"text": "options - The contact information to create"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "returns",
|
|
52
|
+
"text": "Promise that resolves with the ID of the newly created contact"
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"name": "since",
|
|
56
|
+
"text": "1.0.0"
|
|
57
|
+
}
|
|
58
|
+
],
|
|
59
|
+
"docs": "Create a new contact programmatically.",
|
|
60
|
+
"complexTypes": [
|
|
61
|
+
"CreateContactResult",
|
|
62
|
+
"CreateContactOptions"
|
|
63
|
+
],
|
|
64
|
+
"slug": "createcontact"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "createGroup",
|
|
68
|
+
"signature": "(options: CreateGroupOptions) => Promise<CreateGroupResult>",
|
|
69
|
+
"parameters": [
|
|
70
|
+
{
|
|
71
|
+
"name": "options",
|
|
72
|
+
"docs": "- The group information to create",
|
|
73
|
+
"type": "CreateGroupOptions"
|
|
74
|
+
}
|
|
75
|
+
],
|
|
76
|
+
"returns": "Promise<CreateGroupResult>",
|
|
77
|
+
"tags": [
|
|
78
|
+
{
|
|
79
|
+
"name": "param",
|
|
80
|
+
"text": "options - The group information to create"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"name": "returns",
|
|
84
|
+
"text": "Promise that resolves with the ID of the newly created group"
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"name": "since",
|
|
88
|
+
"text": "1.0.0"
|
|
89
|
+
}
|
|
90
|
+
],
|
|
91
|
+
"docs": "Create a new contact group.",
|
|
92
|
+
"complexTypes": [
|
|
93
|
+
"CreateGroupResult",
|
|
94
|
+
"CreateGroupOptions"
|
|
95
|
+
],
|
|
96
|
+
"slug": "creategroup"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "deleteContactById",
|
|
100
|
+
"signature": "(options: DeleteContactByIdOptions) => Promise<void>",
|
|
101
|
+
"parameters": [
|
|
102
|
+
{
|
|
103
|
+
"name": "options",
|
|
104
|
+
"docs": "- The ID of the contact to delete",
|
|
105
|
+
"type": "DeleteContactByIdOptions"
|
|
106
|
+
}
|
|
107
|
+
],
|
|
108
|
+
"returns": "Promise<void>",
|
|
109
|
+
"tags": [
|
|
110
|
+
{
|
|
111
|
+
"name": "param",
|
|
112
|
+
"text": "options - The ID of the contact to delete"
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"name": "returns",
|
|
116
|
+
"text": "Promise that resolves when the contact is deleted"
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"name": "since",
|
|
120
|
+
"text": "1.0.0"
|
|
121
|
+
}
|
|
122
|
+
],
|
|
123
|
+
"docs": "Delete a contact by ID.",
|
|
124
|
+
"complexTypes": [
|
|
125
|
+
"DeleteContactByIdOptions"
|
|
126
|
+
],
|
|
127
|
+
"slug": "deletecontactbyid"
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"name": "deleteGroupById",
|
|
131
|
+
"signature": "(options: DeleteGroupByIdOptions) => Promise<void>",
|
|
132
|
+
"parameters": [
|
|
133
|
+
{
|
|
134
|
+
"name": "options",
|
|
135
|
+
"docs": "- The ID of the group to delete",
|
|
136
|
+
"type": "DeleteGroupByIdOptions"
|
|
137
|
+
}
|
|
138
|
+
],
|
|
139
|
+
"returns": "Promise<void>",
|
|
140
|
+
"tags": [
|
|
141
|
+
{
|
|
142
|
+
"name": "param",
|
|
143
|
+
"text": "options - The ID of the group to delete"
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
"name": "returns",
|
|
147
|
+
"text": "Promise that resolves when the group is deleted"
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"name": "since",
|
|
151
|
+
"text": "1.0.0"
|
|
152
|
+
}
|
|
153
|
+
],
|
|
154
|
+
"docs": "Delete a group by ID.",
|
|
155
|
+
"complexTypes": [
|
|
156
|
+
"DeleteGroupByIdOptions"
|
|
157
|
+
],
|
|
158
|
+
"slug": "deletegroupbyid"
|
|
159
|
+
},
|
|
160
|
+
{
|
|
161
|
+
"name": "displayContactById",
|
|
162
|
+
"signature": "(options: DisplayContactByIdOptions) => Promise<void>",
|
|
163
|
+
"parameters": [
|
|
164
|
+
{
|
|
165
|
+
"name": "options",
|
|
166
|
+
"docs": "- The ID of the contact to display",
|
|
167
|
+
"type": "DisplayContactByIdOptions"
|
|
168
|
+
}
|
|
169
|
+
],
|
|
170
|
+
"returns": "Promise<void>",
|
|
171
|
+
"tags": [
|
|
172
|
+
{
|
|
173
|
+
"name": "param",
|
|
174
|
+
"text": "options - The ID of the contact to display"
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"name": "returns",
|
|
178
|
+
"text": "Promise that resolves when the viewer is closed"
|
|
179
|
+
},
|
|
180
|
+
{
|
|
181
|
+
"name": "since",
|
|
182
|
+
"text": "1.0.0"
|
|
183
|
+
}
|
|
184
|
+
],
|
|
185
|
+
"docs": "Display a contact using the native contact viewer.",
|
|
186
|
+
"complexTypes": [
|
|
187
|
+
"DisplayContactByIdOptions"
|
|
188
|
+
],
|
|
189
|
+
"slug": "displaycontactbyid"
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
"name": "displayCreateContact",
|
|
193
|
+
"signature": "(options?: DisplayCreateContactOptions | undefined) => Promise<DisplayCreateContactResult>",
|
|
194
|
+
"parameters": [
|
|
195
|
+
{
|
|
196
|
+
"name": "options",
|
|
197
|
+
"docs": "- Optional pre-filled contact information",
|
|
198
|
+
"type": "DisplayCreateContactOptions | undefined"
|
|
199
|
+
}
|
|
200
|
+
],
|
|
201
|
+
"returns": "Promise<DisplayCreateContactResult>",
|
|
202
|
+
"tags": [
|
|
203
|
+
{
|
|
204
|
+
"name": "param",
|
|
205
|
+
"text": "options - Optional pre-filled contact information"
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
"name": "returns",
|
|
209
|
+
"text": "Promise that resolves with the ID of the created contact, or undefined if cancelled"
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"name": "since",
|
|
213
|
+
"text": "1.0.0"
|
|
214
|
+
}
|
|
215
|
+
],
|
|
216
|
+
"docs": "Display the native create contact UI.",
|
|
217
|
+
"complexTypes": [
|
|
218
|
+
"DisplayCreateContactResult",
|
|
219
|
+
"DisplayCreateContactOptions"
|
|
220
|
+
],
|
|
221
|
+
"slug": "displaycreatecontact"
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
"name": "displayUpdateContactById",
|
|
225
|
+
"signature": "(options: DisplayUpdateContactByIdOptions) => Promise<void>",
|
|
226
|
+
"parameters": [
|
|
227
|
+
{
|
|
228
|
+
"name": "options",
|
|
229
|
+
"docs": "- The ID of the contact to update",
|
|
230
|
+
"type": "DisplayUpdateContactByIdOptions"
|
|
231
|
+
}
|
|
232
|
+
],
|
|
233
|
+
"returns": "Promise<void>",
|
|
234
|
+
"tags": [
|
|
235
|
+
{
|
|
236
|
+
"name": "param",
|
|
237
|
+
"text": "options - The ID of the contact to update"
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"name": "returns",
|
|
241
|
+
"text": "Promise that resolves when the update UI is closed"
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"name": "since",
|
|
245
|
+
"text": "1.0.0"
|
|
246
|
+
}
|
|
247
|
+
],
|
|
248
|
+
"docs": "Display the native update contact UI for a specific contact.",
|
|
249
|
+
"complexTypes": [
|
|
250
|
+
"DisplayUpdateContactByIdOptions"
|
|
251
|
+
],
|
|
252
|
+
"slug": "displayupdatecontactbyid"
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
"name": "getAccounts",
|
|
256
|
+
"signature": "() => Promise<GetAccountsResult>",
|
|
257
|
+
"parameters": [],
|
|
258
|
+
"returns": "Promise<GetAccountsResult>",
|
|
259
|
+
"tags": [
|
|
260
|
+
{
|
|
261
|
+
"name": "returns",
|
|
262
|
+
"text": "Promise that resolves with the list of accounts"
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
"name": "since",
|
|
266
|
+
"text": "1.0.0"
|
|
267
|
+
}
|
|
268
|
+
],
|
|
269
|
+
"docs": "Get all accounts available on the device.",
|
|
270
|
+
"complexTypes": [
|
|
271
|
+
"GetAccountsResult"
|
|
272
|
+
],
|
|
273
|
+
"slug": "getaccounts"
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"name": "getContactById",
|
|
277
|
+
"signature": "(options: GetContactByIdOptions) => Promise<GetContactByIdResult>",
|
|
278
|
+
"parameters": [
|
|
279
|
+
{
|
|
280
|
+
"name": "options",
|
|
281
|
+
"docs": "- The ID and optional fields to retrieve",
|
|
282
|
+
"type": "GetContactByIdOptions"
|
|
283
|
+
}
|
|
284
|
+
],
|
|
285
|
+
"returns": "Promise<GetContactByIdResult>",
|
|
286
|
+
"tags": [
|
|
287
|
+
{
|
|
288
|
+
"name": "param",
|
|
289
|
+
"text": "options - The ID and optional fields to retrieve"
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
"name": "returns",
|
|
293
|
+
"text": "Promise that resolves with the contact, or null if not found"
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"name": "since",
|
|
297
|
+
"text": "1.0.0"
|
|
298
|
+
}
|
|
299
|
+
],
|
|
300
|
+
"docs": "Get a specific contact by ID.",
|
|
301
|
+
"complexTypes": [
|
|
302
|
+
"GetContactByIdResult",
|
|
303
|
+
"GetContactByIdOptions"
|
|
304
|
+
],
|
|
305
|
+
"slug": "getcontactbyid"
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
"name": "getContacts",
|
|
309
|
+
"signature": "(options?: GetContactsOptions | undefined) => Promise<GetContactsResult>",
|
|
310
|
+
"parameters": [
|
|
311
|
+
{
|
|
312
|
+
"name": "options",
|
|
313
|
+
"docs": "- Optional filters and pagination options",
|
|
314
|
+
"type": "GetContactsOptions | undefined"
|
|
315
|
+
}
|
|
316
|
+
],
|
|
317
|
+
"returns": "Promise<GetContactsResult>",
|
|
318
|
+
"tags": [
|
|
319
|
+
{
|
|
320
|
+
"name": "param",
|
|
321
|
+
"text": "options - Optional filters and pagination options"
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"name": "returns",
|
|
325
|
+
"text": "Promise that resolves with the list of contacts"
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
"name": "since",
|
|
329
|
+
"text": "1.0.0"
|
|
330
|
+
}
|
|
331
|
+
],
|
|
332
|
+
"docs": "Get all contacts from the device.",
|
|
333
|
+
"complexTypes": [
|
|
334
|
+
"GetContactsResult",
|
|
335
|
+
"GetContactsOptions"
|
|
336
|
+
],
|
|
337
|
+
"slug": "getcontacts"
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
"name": "getGroupById",
|
|
341
|
+
"signature": "(options: GetGroupByIdOptions) => Promise<GetGroupByIdResult>",
|
|
342
|
+
"parameters": [
|
|
343
|
+
{
|
|
344
|
+
"name": "options",
|
|
345
|
+
"docs": "- The ID of the group to retrieve",
|
|
346
|
+
"type": "GetGroupByIdOptions"
|
|
347
|
+
}
|
|
348
|
+
],
|
|
349
|
+
"returns": "Promise<GetGroupByIdResult>",
|
|
350
|
+
"tags": [
|
|
351
|
+
{
|
|
352
|
+
"name": "param",
|
|
353
|
+
"text": "options - The ID of the group to retrieve"
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
"name": "returns",
|
|
357
|
+
"text": "Promise that resolves with the group, or null if not found"
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
"name": "since",
|
|
361
|
+
"text": "1.0.0"
|
|
362
|
+
}
|
|
363
|
+
],
|
|
364
|
+
"docs": "Get a specific group by ID.",
|
|
365
|
+
"complexTypes": [
|
|
366
|
+
"GetGroupByIdResult",
|
|
367
|
+
"GetGroupByIdOptions"
|
|
368
|
+
],
|
|
369
|
+
"slug": "getgroupbyid"
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
"name": "getGroups",
|
|
373
|
+
"signature": "() => Promise<GetGroupsResult>",
|
|
374
|
+
"parameters": [],
|
|
375
|
+
"returns": "Promise<GetGroupsResult>",
|
|
376
|
+
"tags": [
|
|
377
|
+
{
|
|
378
|
+
"name": "returns",
|
|
379
|
+
"text": "Promise that resolves with the list of groups"
|
|
380
|
+
},
|
|
381
|
+
{
|
|
382
|
+
"name": "since",
|
|
383
|
+
"text": "1.0.0"
|
|
384
|
+
}
|
|
385
|
+
],
|
|
386
|
+
"docs": "Get all contact groups.",
|
|
387
|
+
"complexTypes": [
|
|
388
|
+
"GetGroupsResult"
|
|
389
|
+
],
|
|
390
|
+
"slug": "getgroups"
|
|
391
|
+
},
|
|
392
|
+
{
|
|
393
|
+
"name": "isAvailable",
|
|
394
|
+
"signature": "() => Promise<IsAvailableResult>",
|
|
395
|
+
"parameters": [],
|
|
396
|
+
"returns": "Promise<IsAvailableResult>",
|
|
397
|
+
"tags": [
|
|
398
|
+
{
|
|
399
|
+
"name": "returns",
|
|
400
|
+
"text": "Promise that resolves with availability status"
|
|
401
|
+
},
|
|
402
|
+
{
|
|
403
|
+
"name": "since",
|
|
404
|
+
"text": "1.0.0"
|
|
405
|
+
}
|
|
406
|
+
],
|
|
407
|
+
"docs": "Check if contacts are available on the device.",
|
|
408
|
+
"complexTypes": [
|
|
409
|
+
"IsAvailableResult"
|
|
410
|
+
],
|
|
411
|
+
"slug": "isavailable"
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"name": "isSupported",
|
|
415
|
+
"signature": "() => Promise<IsSupportedResult>",
|
|
416
|
+
"parameters": [],
|
|
417
|
+
"returns": "Promise<IsSupportedResult>",
|
|
418
|
+
"tags": [
|
|
419
|
+
{
|
|
420
|
+
"name": "returns",
|
|
421
|
+
"text": "Promise that resolves with support status"
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"name": "since",
|
|
425
|
+
"text": "1.0.0"
|
|
426
|
+
}
|
|
427
|
+
],
|
|
428
|
+
"docs": "Check if the plugin is supported on the current platform.",
|
|
429
|
+
"complexTypes": [
|
|
430
|
+
"IsSupportedResult"
|
|
431
|
+
],
|
|
432
|
+
"slug": "issupported"
|
|
433
|
+
},
|
|
434
|
+
{
|
|
435
|
+
"name": "openSettings",
|
|
436
|
+
"signature": "() => Promise<void>",
|
|
437
|
+
"parameters": [],
|
|
438
|
+
"returns": "Promise<void>",
|
|
439
|
+
"tags": [
|
|
440
|
+
{
|
|
441
|
+
"name": "returns",
|
|
442
|
+
"text": "Promise that resolves when the settings are opened"
|
|
443
|
+
},
|
|
444
|
+
{
|
|
445
|
+
"name": "since",
|
|
446
|
+
"text": "1.0.0"
|
|
447
|
+
}
|
|
448
|
+
],
|
|
449
|
+
"docs": "Open the device's contacts settings.",
|
|
450
|
+
"complexTypes": [],
|
|
451
|
+
"slug": "opensettings"
|
|
452
|
+
},
|
|
453
|
+
{
|
|
454
|
+
"name": "pickContact",
|
|
455
|
+
"signature": "(options?: PickContactsOptions | undefined) => Promise<PickContactResult>",
|
|
456
|
+
"parameters": [
|
|
457
|
+
{
|
|
458
|
+
"name": "options",
|
|
459
|
+
"docs": "- Optional fields to retrieve and picker configuration",
|
|
460
|
+
"type": "PickContactsOptions | undefined"
|
|
461
|
+
}
|
|
462
|
+
],
|
|
463
|
+
"returns": "Promise<PickContactsResult>",
|
|
464
|
+
"tags": [
|
|
465
|
+
{
|
|
466
|
+
"name": "param",
|
|
467
|
+
"text": "options - Optional fields to retrieve and picker configuration"
|
|
468
|
+
},
|
|
469
|
+
{
|
|
470
|
+
"name": "returns",
|
|
471
|
+
"text": "Promise that resolves with the selected contact(s)"
|
|
472
|
+
},
|
|
473
|
+
{
|
|
474
|
+
"name": "since",
|
|
475
|
+
"text": "1.0.0"
|
|
476
|
+
}
|
|
477
|
+
],
|
|
478
|
+
"docs": "Pick a single contact using the native contact picker.",
|
|
479
|
+
"complexTypes": [
|
|
480
|
+
"PickContactsResult",
|
|
481
|
+
"PickContactOptions",
|
|
482
|
+
"PickContactResult"
|
|
483
|
+
],
|
|
484
|
+
"slug": "pickcontact"
|
|
485
|
+
},
|
|
486
|
+
{
|
|
487
|
+
"name": "pickContacts",
|
|
488
|
+
"signature": "(options?: PickContactsOptions | undefined) => Promise<PickContactsResult>",
|
|
489
|
+
"parameters": [
|
|
490
|
+
{
|
|
491
|
+
"name": "options",
|
|
492
|
+
"docs": "- Optional fields to retrieve and picker configuration",
|
|
493
|
+
"type": "PickContactsOptions | undefined"
|
|
494
|
+
}
|
|
495
|
+
],
|
|
496
|
+
"returns": "Promise<PickContactsResult>",
|
|
497
|
+
"tags": [
|
|
498
|
+
{
|
|
499
|
+
"name": "param",
|
|
500
|
+
"text": "options - Optional fields to retrieve and picker configuration"
|
|
501
|
+
},
|
|
502
|
+
{
|
|
503
|
+
"name": "returns",
|
|
504
|
+
"text": "Promise that resolves with the selected contacts"
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
"name": "since",
|
|
508
|
+
"text": "1.0.0"
|
|
509
|
+
}
|
|
510
|
+
],
|
|
511
|
+
"docs": "Pick one or more contacts using the native contact picker.",
|
|
512
|
+
"complexTypes": [
|
|
513
|
+
"PickContactsResult",
|
|
514
|
+
"PickContactsOptions"
|
|
515
|
+
],
|
|
516
|
+
"slug": "pickcontacts"
|
|
517
|
+
},
|
|
518
|
+
{
|
|
519
|
+
"name": "updateContactById",
|
|
520
|
+
"signature": "(options: UpdateContactByIdOptions) => Promise<void>",
|
|
521
|
+
"parameters": [
|
|
522
|
+
{
|
|
523
|
+
"name": "options",
|
|
524
|
+
"docs": "- The ID and updated contact information",
|
|
525
|
+
"type": "UpdateContactByIdOptions"
|
|
526
|
+
}
|
|
527
|
+
],
|
|
528
|
+
"returns": "Promise<void>",
|
|
529
|
+
"tags": [
|
|
530
|
+
{
|
|
531
|
+
"name": "param",
|
|
532
|
+
"text": "options - The ID and updated contact information"
|
|
533
|
+
},
|
|
534
|
+
{
|
|
535
|
+
"name": "returns",
|
|
536
|
+
"text": "Promise that resolves when the contact is updated"
|
|
537
|
+
},
|
|
538
|
+
{
|
|
539
|
+
"name": "since",
|
|
540
|
+
"text": "1.0.0"
|
|
541
|
+
}
|
|
542
|
+
],
|
|
543
|
+
"docs": "Update an existing contact by ID.",
|
|
544
|
+
"complexTypes": [
|
|
545
|
+
"UpdateContactByIdOptions"
|
|
546
|
+
],
|
|
547
|
+
"slug": "updatecontactbyid"
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
"name": "checkPermissions",
|
|
551
|
+
"signature": "() => Promise<PermissionStatus>",
|
|
552
|
+
"parameters": [],
|
|
553
|
+
"returns": "Promise<PermissionStatus>",
|
|
554
|
+
"tags": [
|
|
555
|
+
{
|
|
556
|
+
"name": "returns",
|
|
557
|
+
"text": "Promise that resolves with the current permission status"
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"name": "since",
|
|
561
|
+
"text": "1.0.0"
|
|
562
|
+
}
|
|
563
|
+
],
|
|
564
|
+
"docs": "Check the current permission status for contacts.",
|
|
565
|
+
"complexTypes": [
|
|
566
|
+
"PermissionStatus"
|
|
567
|
+
],
|
|
568
|
+
"slug": "checkpermissions"
|
|
569
|
+
},
|
|
570
|
+
{
|
|
571
|
+
"name": "requestPermissions",
|
|
572
|
+
"signature": "(options?: RequestPermissionsOptions | undefined) => Promise<PermissionStatus>",
|
|
573
|
+
"parameters": [
|
|
574
|
+
{
|
|
575
|
+
"name": "options",
|
|
576
|
+
"docs": "- Optional specific permissions to request",
|
|
577
|
+
"type": "RequestPermissionsOptions | undefined"
|
|
578
|
+
}
|
|
579
|
+
],
|
|
580
|
+
"returns": "Promise<PermissionStatus>",
|
|
581
|
+
"tags": [
|
|
582
|
+
{
|
|
583
|
+
"name": "param",
|
|
584
|
+
"text": "options - Optional specific permissions to request"
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
"name": "returns",
|
|
588
|
+
"text": "Promise that resolves with the updated permission status"
|
|
589
|
+
},
|
|
590
|
+
{
|
|
591
|
+
"name": "since",
|
|
592
|
+
"text": "1.0.0"
|
|
593
|
+
}
|
|
594
|
+
],
|
|
595
|
+
"docs": "Request permissions to access contacts.",
|
|
596
|
+
"complexTypes": [
|
|
597
|
+
"PermissionStatus",
|
|
598
|
+
"RequestPermissionsOptions"
|
|
599
|
+
],
|
|
600
|
+
"slug": "requestpermissions"
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
"name": "getPluginVersion",
|
|
604
|
+
"signature": "() => Promise<{ version: string; }>",
|
|
605
|
+
"parameters": [],
|
|
606
|
+
"returns": "Promise<{ version: string; }>",
|
|
607
|
+
"tags": [
|
|
608
|
+
{
|
|
609
|
+
"name": "returns",
|
|
610
|
+
"text": "Promise that resolves with the plugin version"
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
"name": "since",
|
|
614
|
+
"text": "1.0.0"
|
|
615
|
+
}
|
|
616
|
+
],
|
|
617
|
+
"docs": "Get the native Capacitor plugin version.",
|
|
618
|
+
"complexTypes": [],
|
|
619
|
+
"slug": "getpluginversion"
|
|
620
|
+
}
|
|
621
|
+
],
|
|
622
|
+
"properties": []
|
|
623
|
+
},
|
|
624
|
+
"interfaces": [
|
|
625
|
+
{
|
|
626
|
+
"name": "CountContactsResult",
|
|
627
|
+
"slug": "countcontactsresult",
|
|
628
|
+
"docs": "Result from counting contacts.",
|
|
629
|
+
"tags": [
|
|
630
|
+
{
|
|
631
|
+
"text": "1.0.0",
|
|
632
|
+
"name": "since"
|
|
633
|
+
}
|
|
634
|
+
],
|
|
635
|
+
"methods": [],
|
|
636
|
+
"properties": [
|
|
637
|
+
{
|
|
638
|
+
"name": "count",
|
|
639
|
+
"tags": [
|
|
640
|
+
{
|
|
641
|
+
"text": "1.0.0",
|
|
642
|
+
"name": "since"
|
|
643
|
+
}
|
|
644
|
+
],
|
|
645
|
+
"docs": "Total number of contacts.",
|
|
646
|
+
"complexTypes": [],
|
|
647
|
+
"type": "number"
|
|
648
|
+
}
|
|
649
|
+
]
|
|
650
|
+
},
|
|
651
|
+
{
|
|
652
|
+
"name": "CreateContactResult",
|
|
653
|
+
"slug": "createcontactresult",
|
|
654
|
+
"docs": "Result from creating a contact.",
|
|
655
|
+
"tags": [
|
|
656
|
+
{
|
|
657
|
+
"text": "1.0.0",
|
|
658
|
+
"name": "since"
|
|
659
|
+
}
|
|
660
|
+
],
|
|
661
|
+
"methods": [],
|
|
662
|
+
"properties": [
|
|
663
|
+
{
|
|
664
|
+
"name": "id",
|
|
665
|
+
"tags": [
|
|
666
|
+
{
|
|
667
|
+
"text": "1.0.0",
|
|
668
|
+
"name": "since"
|
|
669
|
+
}
|
|
670
|
+
],
|
|
671
|
+
"docs": "The ID of the newly created contact.",
|
|
672
|
+
"complexTypes": [],
|
|
673
|
+
"type": "string"
|
|
674
|
+
}
|
|
675
|
+
]
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
"name": "CreateContactOptions",
|
|
679
|
+
"slug": "createcontactoptions",
|
|
680
|
+
"docs": "Options for creating a contact.",
|
|
681
|
+
"tags": [
|
|
682
|
+
{
|
|
683
|
+
"text": "1.0.0",
|
|
684
|
+
"name": "since"
|
|
685
|
+
}
|
|
686
|
+
],
|
|
687
|
+
"methods": [],
|
|
688
|
+
"properties": [
|
|
689
|
+
{
|
|
690
|
+
"name": "contact",
|
|
691
|
+
"tags": [
|
|
692
|
+
{
|
|
693
|
+
"text": "1.0.0",
|
|
694
|
+
"name": "since"
|
|
695
|
+
}
|
|
696
|
+
],
|
|
697
|
+
"docs": "Contact information to create. The 'id' field will be generated automatically.",
|
|
698
|
+
"complexTypes": [
|
|
699
|
+
"Omit",
|
|
700
|
+
"Contact"
|
|
701
|
+
],
|
|
702
|
+
"type": "Omit<Contact, 'id'>"
|
|
703
|
+
}
|
|
704
|
+
]
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
"name": "Contact",
|
|
708
|
+
"slug": "contact",
|
|
709
|
+
"docs": "Contact information.",
|
|
710
|
+
"tags": [
|
|
711
|
+
{
|
|
712
|
+
"text": "1.0.0",
|
|
713
|
+
"name": "since"
|
|
714
|
+
}
|
|
715
|
+
],
|
|
716
|
+
"methods": [],
|
|
717
|
+
"properties": [
|
|
718
|
+
{
|
|
719
|
+
"name": "id",
|
|
720
|
+
"tags": [
|
|
721
|
+
{
|
|
722
|
+
"text": "1.0.0",
|
|
723
|
+
"name": "since"
|
|
724
|
+
}
|
|
725
|
+
],
|
|
726
|
+
"docs": "Unique identifier for the contact.",
|
|
727
|
+
"complexTypes": [],
|
|
728
|
+
"type": "string | undefined"
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
"name": "account",
|
|
732
|
+
"tags": [
|
|
733
|
+
{
|
|
734
|
+
"text": "1.0.0",
|
|
735
|
+
"name": "since"
|
|
736
|
+
}
|
|
737
|
+
],
|
|
738
|
+
"docs": "Account information for the contact.",
|
|
739
|
+
"complexTypes": [
|
|
740
|
+
"Account"
|
|
741
|
+
],
|
|
742
|
+
"type": "Account"
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
"name": "birthday",
|
|
746
|
+
"tags": [
|
|
747
|
+
{
|
|
748
|
+
"text": "1.0.0",
|
|
749
|
+
"name": "since"
|
|
750
|
+
}
|
|
751
|
+
],
|
|
752
|
+
"docs": "Birthday information for the contact.",
|
|
753
|
+
"complexTypes": [
|
|
754
|
+
"Birthday"
|
|
755
|
+
],
|
|
756
|
+
"type": "Birthday"
|
|
757
|
+
},
|
|
758
|
+
{
|
|
759
|
+
"name": "emailAddresses",
|
|
760
|
+
"tags": [
|
|
761
|
+
{
|
|
762
|
+
"text": "1.0.0",
|
|
763
|
+
"name": "since"
|
|
764
|
+
}
|
|
765
|
+
],
|
|
766
|
+
"docs": "Email addresses for the contact.",
|
|
767
|
+
"complexTypes": [
|
|
768
|
+
"EmailAddress"
|
|
769
|
+
],
|
|
770
|
+
"type": "EmailAddress[] | undefined"
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
"name": "familyName",
|
|
774
|
+
"tags": [
|
|
775
|
+
{
|
|
776
|
+
"text": "1.0.0",
|
|
777
|
+
"name": "since"
|
|
778
|
+
}
|
|
779
|
+
],
|
|
780
|
+
"docs": "Family name (last name) of the contact.",
|
|
781
|
+
"complexTypes": [],
|
|
782
|
+
"type": "string | undefined"
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
"name": "fullName",
|
|
786
|
+
"tags": [
|
|
787
|
+
{
|
|
788
|
+
"text": "1.0.0",
|
|
789
|
+
"name": "since"
|
|
790
|
+
}
|
|
791
|
+
],
|
|
792
|
+
"docs": "Full name of the contact.",
|
|
793
|
+
"complexTypes": [],
|
|
794
|
+
"type": "string | undefined"
|
|
795
|
+
},
|
|
796
|
+
{
|
|
797
|
+
"name": "givenName",
|
|
798
|
+
"tags": [
|
|
799
|
+
{
|
|
800
|
+
"text": "1.0.0",
|
|
801
|
+
"name": "since"
|
|
802
|
+
}
|
|
803
|
+
],
|
|
804
|
+
"docs": "Given name (first name) of the contact.",
|
|
805
|
+
"complexTypes": [],
|
|
806
|
+
"type": "string | undefined"
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"name": "groupIds",
|
|
810
|
+
"tags": [
|
|
811
|
+
{
|
|
812
|
+
"text": "1.0.0",
|
|
813
|
+
"name": "since"
|
|
814
|
+
}
|
|
815
|
+
],
|
|
816
|
+
"docs": "Group IDs the contact belongs to.",
|
|
817
|
+
"complexTypes": [],
|
|
818
|
+
"type": "string[] | undefined"
|
|
819
|
+
},
|
|
820
|
+
{
|
|
821
|
+
"name": "jobTitle",
|
|
822
|
+
"tags": [
|
|
823
|
+
{
|
|
824
|
+
"text": "1.0.0",
|
|
825
|
+
"name": "since"
|
|
826
|
+
}
|
|
827
|
+
],
|
|
828
|
+
"docs": "Job title of the contact.",
|
|
829
|
+
"complexTypes": [],
|
|
830
|
+
"type": "string | undefined"
|
|
831
|
+
},
|
|
832
|
+
{
|
|
833
|
+
"name": "middleName",
|
|
834
|
+
"tags": [
|
|
835
|
+
{
|
|
836
|
+
"text": "1.0.0",
|
|
837
|
+
"name": "since"
|
|
838
|
+
}
|
|
839
|
+
],
|
|
840
|
+
"docs": "Middle name of the contact.",
|
|
841
|
+
"complexTypes": [],
|
|
842
|
+
"type": "string | undefined"
|
|
843
|
+
},
|
|
844
|
+
{
|
|
845
|
+
"name": "namePrefix",
|
|
846
|
+
"tags": [
|
|
847
|
+
{
|
|
848
|
+
"text": "1.0.0",
|
|
849
|
+
"name": "since"
|
|
850
|
+
}
|
|
851
|
+
],
|
|
852
|
+
"docs": "Name prefix (e.g., \"Dr.\", \"Mr.\", \"Ms.\") of the contact.",
|
|
853
|
+
"complexTypes": [],
|
|
854
|
+
"type": "string | undefined"
|
|
855
|
+
},
|
|
856
|
+
{
|
|
857
|
+
"name": "nameSuffix",
|
|
858
|
+
"tags": [
|
|
859
|
+
{
|
|
860
|
+
"text": "1.0.0",
|
|
861
|
+
"name": "since"
|
|
862
|
+
}
|
|
863
|
+
],
|
|
864
|
+
"docs": "Name suffix (e.g., \"Jr.\", \"Sr.\", \"III\") of the contact.",
|
|
865
|
+
"complexTypes": [],
|
|
866
|
+
"type": "string | undefined"
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
"name": "note",
|
|
870
|
+
"tags": [
|
|
871
|
+
{
|
|
872
|
+
"text": "1.0.0",
|
|
873
|
+
"name": "since"
|
|
874
|
+
}
|
|
875
|
+
],
|
|
876
|
+
"docs": "Notes about the contact.",
|
|
877
|
+
"complexTypes": [],
|
|
878
|
+
"type": "string | undefined"
|
|
879
|
+
},
|
|
880
|
+
{
|
|
881
|
+
"name": "organizationName",
|
|
882
|
+
"tags": [
|
|
883
|
+
{
|
|
884
|
+
"text": "1.0.0",
|
|
885
|
+
"name": "since"
|
|
886
|
+
}
|
|
887
|
+
],
|
|
888
|
+
"docs": "Organization name of the contact.",
|
|
889
|
+
"complexTypes": [],
|
|
890
|
+
"type": "string | undefined"
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
"name": "phoneNumbers",
|
|
894
|
+
"tags": [
|
|
895
|
+
{
|
|
896
|
+
"text": "1.0.0",
|
|
897
|
+
"name": "since"
|
|
898
|
+
}
|
|
899
|
+
],
|
|
900
|
+
"docs": "Phone numbers for the contact.",
|
|
901
|
+
"complexTypes": [
|
|
902
|
+
"PhoneNumber"
|
|
903
|
+
],
|
|
904
|
+
"type": "PhoneNumber[] | undefined"
|
|
905
|
+
},
|
|
906
|
+
{
|
|
907
|
+
"name": "photo",
|
|
908
|
+
"tags": [
|
|
909
|
+
{
|
|
910
|
+
"text": "1.0.0",
|
|
911
|
+
"name": "since"
|
|
912
|
+
}
|
|
913
|
+
],
|
|
914
|
+
"docs": "Base64-encoded photo of the contact.",
|
|
915
|
+
"complexTypes": [],
|
|
916
|
+
"type": "string | undefined"
|
|
917
|
+
},
|
|
918
|
+
{
|
|
919
|
+
"name": "postalAddresses",
|
|
920
|
+
"tags": [
|
|
921
|
+
{
|
|
922
|
+
"text": "1.0.0",
|
|
923
|
+
"name": "since"
|
|
924
|
+
}
|
|
925
|
+
],
|
|
926
|
+
"docs": "Postal addresses for the contact.",
|
|
927
|
+
"complexTypes": [
|
|
928
|
+
"PostalAddress"
|
|
929
|
+
],
|
|
930
|
+
"type": "PostalAddress[] | undefined"
|
|
931
|
+
},
|
|
932
|
+
{
|
|
933
|
+
"name": "urlAddresses",
|
|
934
|
+
"tags": [
|
|
935
|
+
{
|
|
936
|
+
"text": "1.0.0",
|
|
937
|
+
"name": "since"
|
|
938
|
+
}
|
|
939
|
+
],
|
|
940
|
+
"docs": "URL addresses for the contact.",
|
|
941
|
+
"complexTypes": [
|
|
942
|
+
"UrlAddress"
|
|
943
|
+
],
|
|
944
|
+
"type": "UrlAddress[] | undefined"
|
|
945
|
+
}
|
|
946
|
+
]
|
|
947
|
+
},
|
|
948
|
+
{
|
|
949
|
+
"name": "Account",
|
|
950
|
+
"slug": "account",
|
|
951
|
+
"docs": "Account information for a contact.",
|
|
952
|
+
"tags": [
|
|
953
|
+
{
|
|
954
|
+
"text": "1.0.0",
|
|
955
|
+
"name": "since"
|
|
956
|
+
}
|
|
957
|
+
],
|
|
958
|
+
"methods": [],
|
|
959
|
+
"properties": [
|
|
960
|
+
{
|
|
961
|
+
"name": "name",
|
|
962
|
+
"tags": [
|
|
963
|
+
{
|
|
964
|
+
"text": "1.0.0",
|
|
965
|
+
"name": "since"
|
|
966
|
+
}
|
|
967
|
+
],
|
|
968
|
+
"docs": "The name of the account.",
|
|
969
|
+
"complexTypes": [],
|
|
970
|
+
"type": "string"
|
|
971
|
+
},
|
|
972
|
+
{
|
|
973
|
+
"name": "type",
|
|
974
|
+
"tags": [
|
|
975
|
+
{
|
|
976
|
+
"text": "1.0.0",
|
|
977
|
+
"name": "since"
|
|
978
|
+
}
|
|
979
|
+
],
|
|
980
|
+
"docs": "The type of the account.",
|
|
981
|
+
"complexTypes": [],
|
|
982
|
+
"type": "string | undefined"
|
|
983
|
+
}
|
|
984
|
+
]
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
"name": "Birthday",
|
|
988
|
+
"slug": "birthday",
|
|
989
|
+
"docs": "Birthday information for a contact.",
|
|
990
|
+
"tags": [
|
|
991
|
+
{
|
|
992
|
+
"text": "1.0.0",
|
|
993
|
+
"name": "since"
|
|
994
|
+
}
|
|
995
|
+
],
|
|
996
|
+
"methods": [],
|
|
997
|
+
"properties": [
|
|
998
|
+
{
|
|
999
|
+
"name": "day",
|
|
1000
|
+
"tags": [
|
|
1001
|
+
{
|
|
1002
|
+
"text": "1.0.0",
|
|
1003
|
+
"name": "since"
|
|
1004
|
+
}
|
|
1005
|
+
],
|
|
1006
|
+
"docs": "The day of the month (1-31).",
|
|
1007
|
+
"complexTypes": [],
|
|
1008
|
+
"type": "number | undefined"
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
"name": "month",
|
|
1012
|
+
"tags": [
|
|
1013
|
+
{
|
|
1014
|
+
"text": "1.0.0",
|
|
1015
|
+
"name": "since"
|
|
1016
|
+
}
|
|
1017
|
+
],
|
|
1018
|
+
"docs": "The month (1-12).",
|
|
1019
|
+
"complexTypes": [],
|
|
1020
|
+
"type": "number | undefined"
|
|
1021
|
+
},
|
|
1022
|
+
{
|
|
1023
|
+
"name": "year",
|
|
1024
|
+
"tags": [
|
|
1025
|
+
{
|
|
1026
|
+
"text": "1.0.0",
|
|
1027
|
+
"name": "since"
|
|
1028
|
+
}
|
|
1029
|
+
],
|
|
1030
|
+
"docs": "The year.",
|
|
1031
|
+
"complexTypes": [],
|
|
1032
|
+
"type": "number | undefined"
|
|
1033
|
+
}
|
|
1034
|
+
]
|
|
1035
|
+
},
|
|
1036
|
+
{
|
|
1037
|
+
"name": "EmailAddress",
|
|
1038
|
+
"slug": "emailaddress",
|
|
1039
|
+
"docs": "Email address information for a contact.",
|
|
1040
|
+
"tags": [
|
|
1041
|
+
{
|
|
1042
|
+
"text": "1.0.0",
|
|
1043
|
+
"name": "since"
|
|
1044
|
+
}
|
|
1045
|
+
],
|
|
1046
|
+
"methods": [],
|
|
1047
|
+
"properties": [
|
|
1048
|
+
{
|
|
1049
|
+
"name": "value",
|
|
1050
|
+
"tags": [
|
|
1051
|
+
{
|
|
1052
|
+
"text": "1.0.0",
|
|
1053
|
+
"name": "since"
|
|
1054
|
+
}
|
|
1055
|
+
],
|
|
1056
|
+
"docs": "The email address value.",
|
|
1057
|
+
"complexTypes": [],
|
|
1058
|
+
"type": "string"
|
|
1059
|
+
},
|
|
1060
|
+
{
|
|
1061
|
+
"name": "type",
|
|
1062
|
+
"tags": [
|
|
1063
|
+
{
|
|
1064
|
+
"text": "1.0.0",
|
|
1065
|
+
"name": "since"
|
|
1066
|
+
}
|
|
1067
|
+
],
|
|
1068
|
+
"docs": "The type of email address.",
|
|
1069
|
+
"complexTypes": [
|
|
1070
|
+
"EmailAddressType"
|
|
1071
|
+
],
|
|
1072
|
+
"type": "EmailAddressType"
|
|
1073
|
+
},
|
|
1074
|
+
{
|
|
1075
|
+
"name": "label",
|
|
1076
|
+
"tags": [
|
|
1077
|
+
{
|
|
1078
|
+
"text": "1.0.0",
|
|
1079
|
+
"name": "since"
|
|
1080
|
+
}
|
|
1081
|
+
],
|
|
1082
|
+
"docs": "Custom label for the email address.",
|
|
1083
|
+
"complexTypes": [],
|
|
1084
|
+
"type": "string | undefined"
|
|
1085
|
+
},
|
|
1086
|
+
{
|
|
1087
|
+
"name": "isPrimary",
|
|
1088
|
+
"tags": [
|
|
1089
|
+
{
|
|
1090
|
+
"text": "1.0.0",
|
|
1091
|
+
"name": "since"
|
|
1092
|
+
}
|
|
1093
|
+
],
|
|
1094
|
+
"docs": "Whether this is the primary email address.",
|
|
1095
|
+
"complexTypes": [],
|
|
1096
|
+
"type": "boolean | undefined"
|
|
1097
|
+
}
|
|
1098
|
+
]
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
"name": "PhoneNumber",
|
|
1102
|
+
"slug": "phonenumber",
|
|
1103
|
+
"docs": "Phone number information for a contact.",
|
|
1104
|
+
"tags": [
|
|
1105
|
+
{
|
|
1106
|
+
"text": "1.0.0",
|
|
1107
|
+
"name": "since"
|
|
1108
|
+
}
|
|
1109
|
+
],
|
|
1110
|
+
"methods": [],
|
|
1111
|
+
"properties": [
|
|
1112
|
+
{
|
|
1113
|
+
"name": "value",
|
|
1114
|
+
"tags": [
|
|
1115
|
+
{
|
|
1116
|
+
"text": "1.0.0",
|
|
1117
|
+
"name": "since"
|
|
1118
|
+
}
|
|
1119
|
+
],
|
|
1120
|
+
"docs": "The phone number value.",
|
|
1121
|
+
"complexTypes": [],
|
|
1122
|
+
"type": "string"
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
"name": "type",
|
|
1126
|
+
"tags": [
|
|
1127
|
+
{
|
|
1128
|
+
"text": "1.0.0",
|
|
1129
|
+
"name": "since"
|
|
1130
|
+
}
|
|
1131
|
+
],
|
|
1132
|
+
"docs": "The type of phone number.",
|
|
1133
|
+
"complexTypes": [
|
|
1134
|
+
"PhoneNumberType"
|
|
1135
|
+
],
|
|
1136
|
+
"type": "PhoneNumberType"
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
"name": "label",
|
|
1140
|
+
"tags": [
|
|
1141
|
+
{
|
|
1142
|
+
"text": "1.0.0",
|
|
1143
|
+
"name": "since"
|
|
1144
|
+
}
|
|
1145
|
+
],
|
|
1146
|
+
"docs": "Custom label for the phone number.",
|
|
1147
|
+
"complexTypes": [],
|
|
1148
|
+
"type": "string | undefined"
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"name": "isPrimary",
|
|
1152
|
+
"tags": [
|
|
1153
|
+
{
|
|
1154
|
+
"text": "1.0.0",
|
|
1155
|
+
"name": "since"
|
|
1156
|
+
}
|
|
1157
|
+
],
|
|
1158
|
+
"docs": "Whether this is the primary phone number.",
|
|
1159
|
+
"complexTypes": [],
|
|
1160
|
+
"type": "boolean | undefined"
|
|
1161
|
+
}
|
|
1162
|
+
]
|
|
1163
|
+
},
|
|
1164
|
+
{
|
|
1165
|
+
"name": "PostalAddress",
|
|
1166
|
+
"slug": "postaladdress",
|
|
1167
|
+
"docs": "Postal address information for a contact.",
|
|
1168
|
+
"tags": [
|
|
1169
|
+
{
|
|
1170
|
+
"text": "1.0.0",
|
|
1171
|
+
"name": "since"
|
|
1172
|
+
}
|
|
1173
|
+
],
|
|
1174
|
+
"methods": [],
|
|
1175
|
+
"properties": [
|
|
1176
|
+
{
|
|
1177
|
+
"name": "city",
|
|
1178
|
+
"tags": [
|
|
1179
|
+
{
|
|
1180
|
+
"text": "1.0.0",
|
|
1181
|
+
"name": "since"
|
|
1182
|
+
}
|
|
1183
|
+
],
|
|
1184
|
+
"docs": "The city name.",
|
|
1185
|
+
"complexTypes": [],
|
|
1186
|
+
"type": "string | undefined"
|
|
1187
|
+
},
|
|
1188
|
+
{
|
|
1189
|
+
"name": "country",
|
|
1190
|
+
"tags": [
|
|
1191
|
+
{
|
|
1192
|
+
"text": "1.0.0",
|
|
1193
|
+
"name": "since"
|
|
1194
|
+
}
|
|
1195
|
+
],
|
|
1196
|
+
"docs": "The country name.",
|
|
1197
|
+
"complexTypes": [],
|
|
1198
|
+
"type": "string | undefined"
|
|
1199
|
+
},
|
|
1200
|
+
{
|
|
1201
|
+
"name": "formatted",
|
|
1202
|
+
"tags": [
|
|
1203
|
+
{
|
|
1204
|
+
"text": "1.0.0",
|
|
1205
|
+
"name": "since"
|
|
1206
|
+
}
|
|
1207
|
+
],
|
|
1208
|
+
"docs": "The formatted address string.",
|
|
1209
|
+
"complexTypes": [],
|
|
1210
|
+
"type": "string | undefined"
|
|
1211
|
+
},
|
|
1212
|
+
{
|
|
1213
|
+
"name": "isoCountryCode",
|
|
1214
|
+
"tags": [
|
|
1215
|
+
{
|
|
1216
|
+
"text": "1.0.0",
|
|
1217
|
+
"name": "since"
|
|
1218
|
+
}
|
|
1219
|
+
],
|
|
1220
|
+
"docs": "The ISO country code.",
|
|
1221
|
+
"complexTypes": [],
|
|
1222
|
+
"type": "string | undefined"
|
|
1223
|
+
},
|
|
1224
|
+
{
|
|
1225
|
+
"name": "isPrimary",
|
|
1226
|
+
"tags": [
|
|
1227
|
+
{
|
|
1228
|
+
"text": "1.0.0",
|
|
1229
|
+
"name": "since"
|
|
1230
|
+
}
|
|
1231
|
+
],
|
|
1232
|
+
"docs": "Whether this is the primary postal address.",
|
|
1233
|
+
"complexTypes": [],
|
|
1234
|
+
"type": "boolean | undefined"
|
|
1235
|
+
},
|
|
1236
|
+
{
|
|
1237
|
+
"name": "label",
|
|
1238
|
+
"tags": [
|
|
1239
|
+
{
|
|
1240
|
+
"text": "1.0.0",
|
|
1241
|
+
"name": "since"
|
|
1242
|
+
}
|
|
1243
|
+
],
|
|
1244
|
+
"docs": "Custom label for the postal address.",
|
|
1245
|
+
"complexTypes": [],
|
|
1246
|
+
"type": "string | undefined"
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"name": "neighborhood",
|
|
1250
|
+
"tags": [
|
|
1251
|
+
{
|
|
1252
|
+
"text": "1.0.0",
|
|
1253
|
+
"name": "since"
|
|
1254
|
+
}
|
|
1255
|
+
],
|
|
1256
|
+
"docs": "The neighborhood name.",
|
|
1257
|
+
"complexTypes": [],
|
|
1258
|
+
"type": "string | undefined"
|
|
1259
|
+
},
|
|
1260
|
+
{
|
|
1261
|
+
"name": "postalCode",
|
|
1262
|
+
"tags": [
|
|
1263
|
+
{
|
|
1264
|
+
"text": "1.0.0",
|
|
1265
|
+
"name": "since"
|
|
1266
|
+
}
|
|
1267
|
+
],
|
|
1268
|
+
"docs": "The postal code.",
|
|
1269
|
+
"complexTypes": [],
|
|
1270
|
+
"type": "string | undefined"
|
|
1271
|
+
},
|
|
1272
|
+
{
|
|
1273
|
+
"name": "state",
|
|
1274
|
+
"tags": [
|
|
1275
|
+
{
|
|
1276
|
+
"text": "1.0.0",
|
|
1277
|
+
"name": "since"
|
|
1278
|
+
}
|
|
1279
|
+
],
|
|
1280
|
+
"docs": "The state or province name.",
|
|
1281
|
+
"complexTypes": [],
|
|
1282
|
+
"type": "string | undefined"
|
|
1283
|
+
},
|
|
1284
|
+
{
|
|
1285
|
+
"name": "street",
|
|
1286
|
+
"tags": [
|
|
1287
|
+
{
|
|
1288
|
+
"text": "1.0.0",
|
|
1289
|
+
"name": "since"
|
|
1290
|
+
}
|
|
1291
|
+
],
|
|
1292
|
+
"docs": "The street address.",
|
|
1293
|
+
"complexTypes": [],
|
|
1294
|
+
"type": "string | undefined"
|
|
1295
|
+
},
|
|
1296
|
+
{
|
|
1297
|
+
"name": "type",
|
|
1298
|
+
"tags": [
|
|
1299
|
+
{
|
|
1300
|
+
"text": "1.0.0",
|
|
1301
|
+
"name": "since"
|
|
1302
|
+
}
|
|
1303
|
+
],
|
|
1304
|
+
"docs": "The type of postal address.",
|
|
1305
|
+
"complexTypes": [
|
|
1306
|
+
"PostalAddressType"
|
|
1307
|
+
],
|
|
1308
|
+
"type": "PostalAddressType"
|
|
1309
|
+
}
|
|
1310
|
+
]
|
|
1311
|
+
},
|
|
1312
|
+
{
|
|
1313
|
+
"name": "UrlAddress",
|
|
1314
|
+
"slug": "urladdress",
|
|
1315
|
+
"docs": "URL address information for a contact.",
|
|
1316
|
+
"tags": [
|
|
1317
|
+
{
|
|
1318
|
+
"text": "1.0.0",
|
|
1319
|
+
"name": "since"
|
|
1320
|
+
}
|
|
1321
|
+
],
|
|
1322
|
+
"methods": [],
|
|
1323
|
+
"properties": [
|
|
1324
|
+
{
|
|
1325
|
+
"name": "value",
|
|
1326
|
+
"tags": [
|
|
1327
|
+
{
|
|
1328
|
+
"text": "1.0.0",
|
|
1329
|
+
"name": "since"
|
|
1330
|
+
}
|
|
1331
|
+
],
|
|
1332
|
+
"docs": "The URL value.",
|
|
1333
|
+
"complexTypes": [],
|
|
1334
|
+
"type": "string"
|
|
1335
|
+
},
|
|
1336
|
+
{
|
|
1337
|
+
"name": "type",
|
|
1338
|
+
"tags": [
|
|
1339
|
+
{
|
|
1340
|
+
"text": "1.0.0",
|
|
1341
|
+
"name": "since"
|
|
1342
|
+
}
|
|
1343
|
+
],
|
|
1344
|
+
"docs": "The type of URL.",
|
|
1345
|
+
"complexTypes": [
|
|
1346
|
+
"UrlAddressType"
|
|
1347
|
+
],
|
|
1348
|
+
"type": "UrlAddressType"
|
|
1349
|
+
},
|
|
1350
|
+
{
|
|
1351
|
+
"name": "label",
|
|
1352
|
+
"tags": [
|
|
1353
|
+
{
|
|
1354
|
+
"text": "1.0.0",
|
|
1355
|
+
"name": "since"
|
|
1356
|
+
}
|
|
1357
|
+
],
|
|
1358
|
+
"docs": "Custom label for the URL.",
|
|
1359
|
+
"complexTypes": [],
|
|
1360
|
+
"type": "string | undefined"
|
|
1361
|
+
}
|
|
1362
|
+
]
|
|
1363
|
+
},
|
|
1364
|
+
{
|
|
1365
|
+
"name": "CreateGroupResult",
|
|
1366
|
+
"slug": "creategroupresult",
|
|
1367
|
+
"docs": "Result from creating a group.",
|
|
1368
|
+
"tags": [
|
|
1369
|
+
{
|
|
1370
|
+
"text": "1.0.0",
|
|
1371
|
+
"name": "since"
|
|
1372
|
+
}
|
|
1373
|
+
],
|
|
1374
|
+
"methods": [],
|
|
1375
|
+
"properties": [
|
|
1376
|
+
{
|
|
1377
|
+
"name": "id",
|
|
1378
|
+
"tags": [
|
|
1379
|
+
{
|
|
1380
|
+
"text": "1.0.0",
|
|
1381
|
+
"name": "since"
|
|
1382
|
+
}
|
|
1383
|
+
],
|
|
1384
|
+
"docs": "The ID of the newly created group.",
|
|
1385
|
+
"complexTypes": [],
|
|
1386
|
+
"type": "string"
|
|
1387
|
+
}
|
|
1388
|
+
]
|
|
1389
|
+
},
|
|
1390
|
+
{
|
|
1391
|
+
"name": "CreateGroupOptions",
|
|
1392
|
+
"slug": "creategroupoptions",
|
|
1393
|
+
"docs": "Options for creating a group.",
|
|
1394
|
+
"tags": [
|
|
1395
|
+
{
|
|
1396
|
+
"text": "1.0.0",
|
|
1397
|
+
"name": "since"
|
|
1398
|
+
}
|
|
1399
|
+
],
|
|
1400
|
+
"methods": [],
|
|
1401
|
+
"properties": [
|
|
1402
|
+
{
|
|
1403
|
+
"name": "group",
|
|
1404
|
+
"tags": [
|
|
1405
|
+
{
|
|
1406
|
+
"text": "1.0.0",
|
|
1407
|
+
"name": "since"
|
|
1408
|
+
}
|
|
1409
|
+
],
|
|
1410
|
+
"docs": "Group information to create. The 'id' field will be generated automatically.",
|
|
1411
|
+
"complexTypes": [
|
|
1412
|
+
"Omit",
|
|
1413
|
+
"Group"
|
|
1414
|
+
],
|
|
1415
|
+
"type": "Omit<Group, 'id'>"
|
|
1416
|
+
}
|
|
1417
|
+
]
|
|
1418
|
+
},
|
|
1419
|
+
{
|
|
1420
|
+
"name": "Group",
|
|
1421
|
+
"slug": "group",
|
|
1422
|
+
"docs": "Contact group information.",
|
|
1423
|
+
"tags": [
|
|
1424
|
+
{
|
|
1425
|
+
"text": "1.0.0",
|
|
1426
|
+
"name": "since"
|
|
1427
|
+
}
|
|
1428
|
+
],
|
|
1429
|
+
"methods": [],
|
|
1430
|
+
"properties": [
|
|
1431
|
+
{
|
|
1432
|
+
"name": "id",
|
|
1433
|
+
"tags": [
|
|
1434
|
+
{
|
|
1435
|
+
"text": "1.0.0",
|
|
1436
|
+
"name": "since"
|
|
1437
|
+
}
|
|
1438
|
+
],
|
|
1439
|
+
"docs": "Unique identifier for the group.",
|
|
1440
|
+
"complexTypes": [],
|
|
1441
|
+
"type": "string"
|
|
1442
|
+
},
|
|
1443
|
+
{
|
|
1444
|
+
"name": "name",
|
|
1445
|
+
"tags": [
|
|
1446
|
+
{
|
|
1447
|
+
"text": "1.0.0",
|
|
1448
|
+
"name": "since"
|
|
1449
|
+
}
|
|
1450
|
+
],
|
|
1451
|
+
"docs": "Name of the group.",
|
|
1452
|
+
"complexTypes": [],
|
|
1453
|
+
"type": "string"
|
|
1454
|
+
}
|
|
1455
|
+
]
|
|
1456
|
+
},
|
|
1457
|
+
{
|
|
1458
|
+
"name": "DeleteContactByIdOptions",
|
|
1459
|
+
"slug": "deletecontactbyidoptions",
|
|
1460
|
+
"docs": "Options for deleting a contact by ID.",
|
|
1461
|
+
"tags": [
|
|
1462
|
+
{
|
|
1463
|
+
"text": "1.0.0",
|
|
1464
|
+
"name": "since"
|
|
1465
|
+
}
|
|
1466
|
+
],
|
|
1467
|
+
"methods": [],
|
|
1468
|
+
"properties": [
|
|
1469
|
+
{
|
|
1470
|
+
"name": "id",
|
|
1471
|
+
"tags": [
|
|
1472
|
+
{
|
|
1473
|
+
"text": "1.0.0",
|
|
1474
|
+
"name": "since"
|
|
1475
|
+
}
|
|
1476
|
+
],
|
|
1477
|
+
"docs": "The ID of the contact to delete.",
|
|
1478
|
+
"complexTypes": [],
|
|
1479
|
+
"type": "string"
|
|
1480
|
+
}
|
|
1481
|
+
]
|
|
1482
|
+
},
|
|
1483
|
+
{
|
|
1484
|
+
"name": "DeleteGroupByIdOptions",
|
|
1485
|
+
"slug": "deletegroupbyidoptions",
|
|
1486
|
+
"docs": "Options for deleting a group by ID.",
|
|
1487
|
+
"tags": [
|
|
1488
|
+
{
|
|
1489
|
+
"text": "1.0.0",
|
|
1490
|
+
"name": "since"
|
|
1491
|
+
}
|
|
1492
|
+
],
|
|
1493
|
+
"methods": [],
|
|
1494
|
+
"properties": [
|
|
1495
|
+
{
|
|
1496
|
+
"name": "id",
|
|
1497
|
+
"tags": [
|
|
1498
|
+
{
|
|
1499
|
+
"text": "1.0.0",
|
|
1500
|
+
"name": "since"
|
|
1501
|
+
}
|
|
1502
|
+
],
|
|
1503
|
+
"docs": "The ID of the group to delete.",
|
|
1504
|
+
"complexTypes": [],
|
|
1505
|
+
"type": "string"
|
|
1506
|
+
}
|
|
1507
|
+
]
|
|
1508
|
+
},
|
|
1509
|
+
{
|
|
1510
|
+
"name": "DisplayContactByIdOptions",
|
|
1511
|
+
"slug": "displaycontactbyidoptions",
|
|
1512
|
+
"docs": "Options for displaying a contact by ID.",
|
|
1513
|
+
"tags": [
|
|
1514
|
+
{
|
|
1515
|
+
"text": "1.0.0",
|
|
1516
|
+
"name": "since"
|
|
1517
|
+
}
|
|
1518
|
+
],
|
|
1519
|
+
"methods": [],
|
|
1520
|
+
"properties": [
|
|
1521
|
+
{
|
|
1522
|
+
"name": "id",
|
|
1523
|
+
"tags": [
|
|
1524
|
+
{
|
|
1525
|
+
"text": "1.0.0",
|
|
1526
|
+
"name": "since"
|
|
1527
|
+
}
|
|
1528
|
+
],
|
|
1529
|
+
"docs": "The ID of the contact to display.",
|
|
1530
|
+
"complexTypes": [],
|
|
1531
|
+
"type": "string"
|
|
1532
|
+
}
|
|
1533
|
+
]
|
|
1534
|
+
},
|
|
1535
|
+
{
|
|
1536
|
+
"name": "DisplayCreateContactResult",
|
|
1537
|
+
"slug": "displaycreatecontactresult",
|
|
1538
|
+
"docs": "Result from displaying the native create contact UI.",
|
|
1539
|
+
"tags": [
|
|
1540
|
+
{
|
|
1541
|
+
"text": "1.0.0",
|
|
1542
|
+
"name": "since"
|
|
1543
|
+
}
|
|
1544
|
+
],
|
|
1545
|
+
"methods": [],
|
|
1546
|
+
"properties": [
|
|
1547
|
+
{
|
|
1548
|
+
"name": "id",
|
|
1549
|
+
"tags": [
|
|
1550
|
+
{
|
|
1551
|
+
"text": "1.0.0",
|
|
1552
|
+
"name": "since"
|
|
1553
|
+
}
|
|
1554
|
+
],
|
|
1555
|
+
"docs": "The ID of the created contact, if one was created. Undefined if the user cancelled.",
|
|
1556
|
+
"complexTypes": [],
|
|
1557
|
+
"type": "string | undefined"
|
|
1558
|
+
}
|
|
1559
|
+
]
|
|
1560
|
+
},
|
|
1561
|
+
{
|
|
1562
|
+
"name": "DisplayCreateContactOptions",
|
|
1563
|
+
"slug": "displaycreatecontactoptions",
|
|
1564
|
+
"docs": "Options for displaying the native create contact UI.",
|
|
1565
|
+
"tags": [
|
|
1566
|
+
{
|
|
1567
|
+
"text": "1.0.0",
|
|
1568
|
+
"name": "since"
|
|
1569
|
+
}
|
|
1570
|
+
],
|
|
1571
|
+
"methods": [],
|
|
1572
|
+
"properties": [
|
|
1573
|
+
{
|
|
1574
|
+
"name": "contact",
|
|
1575
|
+
"tags": [
|
|
1576
|
+
{
|
|
1577
|
+
"text": "1.0.0",
|
|
1578
|
+
"name": "since"
|
|
1579
|
+
}
|
|
1580
|
+
],
|
|
1581
|
+
"docs": "Optional pre-filled contact information for the create UI.",
|
|
1582
|
+
"complexTypes": [
|
|
1583
|
+
"Omit",
|
|
1584
|
+
"Contact"
|
|
1585
|
+
],
|
|
1586
|
+
"type": "Omit<Contact, 'id'>"
|
|
1587
|
+
}
|
|
1588
|
+
]
|
|
1589
|
+
},
|
|
1590
|
+
{
|
|
1591
|
+
"name": "DisplayUpdateContactByIdOptions",
|
|
1592
|
+
"slug": "displayupdatecontactbyidoptions",
|
|
1593
|
+
"docs": "Options for displaying the native update contact UI.",
|
|
1594
|
+
"tags": [
|
|
1595
|
+
{
|
|
1596
|
+
"text": "1.0.0",
|
|
1597
|
+
"name": "since"
|
|
1598
|
+
}
|
|
1599
|
+
],
|
|
1600
|
+
"methods": [],
|
|
1601
|
+
"properties": [
|
|
1602
|
+
{
|
|
1603
|
+
"name": "id",
|
|
1604
|
+
"tags": [
|
|
1605
|
+
{
|
|
1606
|
+
"text": "1.0.0",
|
|
1607
|
+
"name": "since"
|
|
1608
|
+
}
|
|
1609
|
+
],
|
|
1610
|
+
"docs": "The ID of the contact to update.",
|
|
1611
|
+
"complexTypes": [],
|
|
1612
|
+
"type": "string"
|
|
1613
|
+
}
|
|
1614
|
+
]
|
|
1615
|
+
},
|
|
1616
|
+
{
|
|
1617
|
+
"name": "GetAccountsResult",
|
|
1618
|
+
"slug": "getaccountsresult",
|
|
1619
|
+
"docs": "Result from getting accounts.",
|
|
1620
|
+
"tags": [
|
|
1621
|
+
{
|
|
1622
|
+
"text": "1.0.0",
|
|
1623
|
+
"name": "since"
|
|
1624
|
+
}
|
|
1625
|
+
],
|
|
1626
|
+
"methods": [],
|
|
1627
|
+
"properties": [
|
|
1628
|
+
{
|
|
1629
|
+
"name": "accounts",
|
|
1630
|
+
"tags": [
|
|
1631
|
+
{
|
|
1632
|
+
"text": "1.0.0",
|
|
1633
|
+
"name": "since"
|
|
1634
|
+
}
|
|
1635
|
+
],
|
|
1636
|
+
"docs": "List of accounts available on the device.",
|
|
1637
|
+
"complexTypes": [
|
|
1638
|
+
"Account"
|
|
1639
|
+
],
|
|
1640
|
+
"type": "Account[]"
|
|
1641
|
+
}
|
|
1642
|
+
]
|
|
1643
|
+
},
|
|
1644
|
+
{
|
|
1645
|
+
"name": "GetContactByIdResult",
|
|
1646
|
+
"slug": "getcontactbyidresult",
|
|
1647
|
+
"docs": "Result from getting a contact by ID.",
|
|
1648
|
+
"tags": [
|
|
1649
|
+
{
|
|
1650
|
+
"text": "1.0.0",
|
|
1651
|
+
"name": "since"
|
|
1652
|
+
}
|
|
1653
|
+
],
|
|
1654
|
+
"methods": [],
|
|
1655
|
+
"properties": [
|
|
1656
|
+
{
|
|
1657
|
+
"name": "contact",
|
|
1658
|
+
"tags": [
|
|
1659
|
+
{
|
|
1660
|
+
"text": "1.0.0",
|
|
1661
|
+
"name": "since"
|
|
1662
|
+
}
|
|
1663
|
+
],
|
|
1664
|
+
"docs": "The contact, or null if not found.",
|
|
1665
|
+
"complexTypes": [
|
|
1666
|
+
"Contact"
|
|
1667
|
+
],
|
|
1668
|
+
"type": "Contact | null"
|
|
1669
|
+
}
|
|
1670
|
+
]
|
|
1671
|
+
},
|
|
1672
|
+
{
|
|
1673
|
+
"name": "GetContactByIdOptions",
|
|
1674
|
+
"slug": "getcontactbyidoptions",
|
|
1675
|
+
"docs": "Options for getting a contact by ID.",
|
|
1676
|
+
"tags": [
|
|
1677
|
+
{
|
|
1678
|
+
"text": "1.0.0",
|
|
1679
|
+
"name": "since"
|
|
1680
|
+
}
|
|
1681
|
+
],
|
|
1682
|
+
"methods": [],
|
|
1683
|
+
"properties": [
|
|
1684
|
+
{
|
|
1685
|
+
"name": "id",
|
|
1686
|
+
"tags": [
|
|
1687
|
+
{
|
|
1688
|
+
"text": "1.0.0",
|
|
1689
|
+
"name": "since"
|
|
1690
|
+
}
|
|
1691
|
+
],
|
|
1692
|
+
"docs": "The ID of the contact to retrieve.",
|
|
1693
|
+
"complexTypes": [],
|
|
1694
|
+
"type": "string"
|
|
1695
|
+
},
|
|
1696
|
+
{
|
|
1697
|
+
"name": "fields",
|
|
1698
|
+
"tags": [
|
|
1699
|
+
{
|
|
1700
|
+
"text": "1.0.0",
|
|
1701
|
+
"name": "since"
|
|
1702
|
+
}
|
|
1703
|
+
],
|
|
1704
|
+
"docs": "Optional list of specific fields to retrieve. If not specified, all fields are returned.",
|
|
1705
|
+
"complexTypes": [
|
|
1706
|
+
"ContactField"
|
|
1707
|
+
],
|
|
1708
|
+
"type": "(keyof Contact)[] | undefined"
|
|
1709
|
+
}
|
|
1710
|
+
]
|
|
1711
|
+
},
|
|
1712
|
+
{
|
|
1713
|
+
"name": "GetContactsResult",
|
|
1714
|
+
"slug": "getcontactsresult",
|
|
1715
|
+
"docs": "Result from getting contacts.",
|
|
1716
|
+
"tags": [
|
|
1717
|
+
{
|
|
1718
|
+
"text": "1.0.0",
|
|
1719
|
+
"name": "since"
|
|
1720
|
+
}
|
|
1721
|
+
],
|
|
1722
|
+
"methods": [],
|
|
1723
|
+
"properties": [
|
|
1724
|
+
{
|
|
1725
|
+
"name": "contacts",
|
|
1726
|
+
"tags": [
|
|
1727
|
+
{
|
|
1728
|
+
"text": "1.0.0",
|
|
1729
|
+
"name": "since"
|
|
1730
|
+
}
|
|
1731
|
+
],
|
|
1732
|
+
"docs": "List of contacts.",
|
|
1733
|
+
"complexTypes": [
|
|
1734
|
+
"Contact"
|
|
1735
|
+
],
|
|
1736
|
+
"type": "Contact[]"
|
|
1737
|
+
}
|
|
1738
|
+
]
|
|
1739
|
+
},
|
|
1740
|
+
{
|
|
1741
|
+
"name": "GetContactsOptions",
|
|
1742
|
+
"slug": "getcontactsoptions",
|
|
1743
|
+
"docs": "Options for getting contacts.",
|
|
1744
|
+
"tags": [
|
|
1745
|
+
{
|
|
1746
|
+
"text": "1.0.0",
|
|
1747
|
+
"name": "since"
|
|
1748
|
+
}
|
|
1749
|
+
],
|
|
1750
|
+
"methods": [],
|
|
1751
|
+
"properties": [
|
|
1752
|
+
{
|
|
1753
|
+
"name": "fields",
|
|
1754
|
+
"tags": [
|
|
1755
|
+
{
|
|
1756
|
+
"text": "1.0.0",
|
|
1757
|
+
"name": "since"
|
|
1758
|
+
}
|
|
1759
|
+
],
|
|
1760
|
+
"docs": "Optional list of specific fields to retrieve. If not specified, all fields are returned.",
|
|
1761
|
+
"complexTypes": [
|
|
1762
|
+
"ContactField"
|
|
1763
|
+
],
|
|
1764
|
+
"type": "(keyof Contact)[] | undefined"
|
|
1765
|
+
},
|
|
1766
|
+
{
|
|
1767
|
+
"name": "limit",
|
|
1768
|
+
"tags": [
|
|
1769
|
+
{
|
|
1770
|
+
"text": "1.0.0",
|
|
1771
|
+
"name": "since"
|
|
1772
|
+
}
|
|
1773
|
+
],
|
|
1774
|
+
"docs": "Maximum number of contacts to return.",
|
|
1775
|
+
"complexTypes": [],
|
|
1776
|
+
"type": "number | undefined"
|
|
1777
|
+
},
|
|
1778
|
+
{
|
|
1779
|
+
"name": "offset",
|
|
1780
|
+
"tags": [
|
|
1781
|
+
{
|
|
1782
|
+
"text": "1.0.0",
|
|
1783
|
+
"name": "since"
|
|
1784
|
+
}
|
|
1785
|
+
],
|
|
1786
|
+
"docs": "Number of contacts to skip before starting to return results.",
|
|
1787
|
+
"complexTypes": [],
|
|
1788
|
+
"type": "number | undefined"
|
|
1789
|
+
}
|
|
1790
|
+
]
|
|
1791
|
+
},
|
|
1792
|
+
{
|
|
1793
|
+
"name": "GetGroupByIdResult",
|
|
1794
|
+
"slug": "getgroupbyidresult",
|
|
1795
|
+
"docs": "Result from getting a group by ID.",
|
|
1796
|
+
"tags": [
|
|
1797
|
+
{
|
|
1798
|
+
"text": "1.0.0",
|
|
1799
|
+
"name": "since"
|
|
1800
|
+
}
|
|
1801
|
+
],
|
|
1802
|
+
"methods": [],
|
|
1803
|
+
"properties": [
|
|
1804
|
+
{
|
|
1805
|
+
"name": "group",
|
|
1806
|
+
"tags": [
|
|
1807
|
+
{
|
|
1808
|
+
"text": "1.0.0",
|
|
1809
|
+
"name": "since"
|
|
1810
|
+
}
|
|
1811
|
+
],
|
|
1812
|
+
"docs": "The group, or null if not found.",
|
|
1813
|
+
"complexTypes": [
|
|
1814
|
+
"Group"
|
|
1815
|
+
],
|
|
1816
|
+
"type": "Group | null"
|
|
1817
|
+
}
|
|
1818
|
+
]
|
|
1819
|
+
},
|
|
1820
|
+
{
|
|
1821
|
+
"name": "GetGroupByIdOptions",
|
|
1822
|
+
"slug": "getgroupbyidoptions",
|
|
1823
|
+
"docs": "Options for getting a group by ID.",
|
|
1824
|
+
"tags": [
|
|
1825
|
+
{
|
|
1826
|
+
"text": "1.0.0",
|
|
1827
|
+
"name": "since"
|
|
1828
|
+
}
|
|
1829
|
+
],
|
|
1830
|
+
"methods": [],
|
|
1831
|
+
"properties": [
|
|
1832
|
+
{
|
|
1833
|
+
"name": "id",
|
|
1834
|
+
"tags": [
|
|
1835
|
+
{
|
|
1836
|
+
"text": "1.0.0",
|
|
1837
|
+
"name": "since"
|
|
1838
|
+
}
|
|
1839
|
+
],
|
|
1840
|
+
"docs": "The ID of the group to retrieve.",
|
|
1841
|
+
"complexTypes": [],
|
|
1842
|
+
"type": "string"
|
|
1843
|
+
}
|
|
1844
|
+
]
|
|
1845
|
+
},
|
|
1846
|
+
{
|
|
1847
|
+
"name": "GetGroupsResult",
|
|
1848
|
+
"slug": "getgroupsresult",
|
|
1849
|
+
"docs": "Result from getting groups.",
|
|
1850
|
+
"tags": [
|
|
1851
|
+
{
|
|
1852
|
+
"text": "1.0.0",
|
|
1853
|
+
"name": "since"
|
|
1854
|
+
}
|
|
1855
|
+
],
|
|
1856
|
+
"methods": [],
|
|
1857
|
+
"properties": [
|
|
1858
|
+
{
|
|
1859
|
+
"name": "groups",
|
|
1860
|
+
"tags": [
|
|
1861
|
+
{
|
|
1862
|
+
"text": "1.0.0",
|
|
1863
|
+
"name": "since"
|
|
1864
|
+
}
|
|
1865
|
+
],
|
|
1866
|
+
"docs": "List of groups.",
|
|
1867
|
+
"complexTypes": [
|
|
1868
|
+
"Group"
|
|
1869
|
+
],
|
|
1870
|
+
"type": "Group[]"
|
|
1871
|
+
}
|
|
1872
|
+
]
|
|
1873
|
+
},
|
|
1874
|
+
{
|
|
1875
|
+
"name": "IsAvailableResult",
|
|
1876
|
+
"slug": "isavailableresult",
|
|
1877
|
+
"docs": "Result from checking if contacts are available on the device.",
|
|
1878
|
+
"tags": [
|
|
1879
|
+
{
|
|
1880
|
+
"text": "1.0.0",
|
|
1881
|
+
"name": "since"
|
|
1882
|
+
}
|
|
1883
|
+
],
|
|
1884
|
+
"methods": [],
|
|
1885
|
+
"properties": [
|
|
1886
|
+
{
|
|
1887
|
+
"name": "isAvailable",
|
|
1888
|
+
"tags": [
|
|
1889
|
+
{
|
|
1890
|
+
"text": "1.0.0",
|
|
1891
|
+
"name": "since"
|
|
1892
|
+
}
|
|
1893
|
+
],
|
|
1894
|
+
"docs": "Whether contacts are available on this device.",
|
|
1895
|
+
"complexTypes": [],
|
|
1896
|
+
"type": "boolean"
|
|
1897
|
+
}
|
|
1898
|
+
]
|
|
1899
|
+
},
|
|
1900
|
+
{
|
|
1901
|
+
"name": "IsSupportedResult",
|
|
1902
|
+
"slug": "issupportedresult",
|
|
1903
|
+
"docs": "Result from checking if the plugin is supported on the platform.",
|
|
1904
|
+
"tags": [
|
|
1905
|
+
{
|
|
1906
|
+
"text": "1.0.0",
|
|
1907
|
+
"name": "since"
|
|
1908
|
+
}
|
|
1909
|
+
],
|
|
1910
|
+
"methods": [],
|
|
1911
|
+
"properties": [
|
|
1912
|
+
{
|
|
1913
|
+
"name": "isSupported",
|
|
1914
|
+
"tags": [
|
|
1915
|
+
{
|
|
1916
|
+
"text": "1.0.0",
|
|
1917
|
+
"name": "since"
|
|
1918
|
+
}
|
|
1919
|
+
],
|
|
1920
|
+
"docs": "Whether the plugin is supported on this platform.",
|
|
1921
|
+
"complexTypes": [],
|
|
1922
|
+
"type": "boolean"
|
|
1923
|
+
}
|
|
1924
|
+
]
|
|
1925
|
+
},
|
|
1926
|
+
{
|
|
1927
|
+
"name": "PickContactsResult",
|
|
1928
|
+
"slug": "pickcontactsresult",
|
|
1929
|
+
"docs": "Result from picking contacts.",
|
|
1930
|
+
"tags": [
|
|
1931
|
+
{
|
|
1932
|
+
"text": "1.0.0",
|
|
1933
|
+
"name": "since"
|
|
1934
|
+
}
|
|
1935
|
+
],
|
|
1936
|
+
"methods": [],
|
|
1937
|
+
"properties": [
|
|
1938
|
+
{
|
|
1939
|
+
"name": "contacts",
|
|
1940
|
+
"tags": [
|
|
1941
|
+
{
|
|
1942
|
+
"text": "1.0.0",
|
|
1943
|
+
"name": "since"
|
|
1944
|
+
}
|
|
1945
|
+
],
|
|
1946
|
+
"docs": "List of selected contacts.",
|
|
1947
|
+
"complexTypes": [
|
|
1948
|
+
"Contact"
|
|
1949
|
+
],
|
|
1950
|
+
"type": "Contact[]"
|
|
1951
|
+
}
|
|
1952
|
+
]
|
|
1953
|
+
},
|
|
1954
|
+
{
|
|
1955
|
+
"name": "PickContactsOptions",
|
|
1956
|
+
"slug": "pickcontactsoptions",
|
|
1957
|
+
"docs": "Options for picking contacts using the native contact picker.",
|
|
1958
|
+
"tags": [
|
|
1959
|
+
{
|
|
1960
|
+
"text": "1.0.0",
|
|
1961
|
+
"name": "since"
|
|
1962
|
+
}
|
|
1963
|
+
],
|
|
1964
|
+
"methods": [],
|
|
1965
|
+
"properties": [
|
|
1966
|
+
{
|
|
1967
|
+
"name": "fields",
|
|
1968
|
+
"tags": [
|
|
1969
|
+
{
|
|
1970
|
+
"text": "1.0.0",
|
|
1971
|
+
"name": "since"
|
|
1972
|
+
}
|
|
1973
|
+
],
|
|
1974
|
+
"docs": "Optional list of specific fields to retrieve. If not specified, all fields are returned.",
|
|
1975
|
+
"complexTypes": [
|
|
1976
|
+
"ContactField"
|
|
1977
|
+
],
|
|
1978
|
+
"type": "(keyof Contact)[] | undefined"
|
|
1979
|
+
},
|
|
1980
|
+
{
|
|
1981
|
+
"name": "multiple",
|
|
1982
|
+
"tags": [
|
|
1983
|
+
{
|
|
1984
|
+
"text": "1.0.0",
|
|
1985
|
+
"name": "since"
|
|
1986
|
+
}
|
|
1987
|
+
],
|
|
1988
|
+
"docs": "Whether to allow selecting multiple contacts. Default is false.",
|
|
1989
|
+
"complexTypes": [],
|
|
1990
|
+
"type": "boolean | undefined"
|
|
1991
|
+
}
|
|
1992
|
+
]
|
|
1993
|
+
},
|
|
1994
|
+
{
|
|
1995
|
+
"name": "UpdateContactByIdOptions",
|
|
1996
|
+
"slug": "updatecontactbyidoptions",
|
|
1997
|
+
"docs": "Options for updating a contact by ID.",
|
|
1998
|
+
"tags": [
|
|
1999
|
+
{
|
|
2000
|
+
"text": "1.0.0",
|
|
2001
|
+
"name": "since"
|
|
2002
|
+
}
|
|
2003
|
+
],
|
|
2004
|
+
"methods": [],
|
|
2005
|
+
"properties": [
|
|
2006
|
+
{
|
|
2007
|
+
"name": "id",
|
|
2008
|
+
"tags": [
|
|
2009
|
+
{
|
|
2010
|
+
"text": "1.0.0",
|
|
2011
|
+
"name": "since"
|
|
2012
|
+
}
|
|
2013
|
+
],
|
|
2014
|
+
"docs": "The ID of the contact to update.",
|
|
2015
|
+
"complexTypes": [],
|
|
2016
|
+
"type": "string"
|
|
2017
|
+
},
|
|
2018
|
+
{
|
|
2019
|
+
"name": "contact",
|
|
2020
|
+
"tags": [
|
|
2021
|
+
{
|
|
2022
|
+
"text": "1.0.0",
|
|
2023
|
+
"name": "since"
|
|
2024
|
+
}
|
|
2025
|
+
],
|
|
2026
|
+
"docs": "Updated contact information.",
|
|
2027
|
+
"complexTypes": [
|
|
2028
|
+
"Omit",
|
|
2029
|
+
"Contact"
|
|
2030
|
+
],
|
|
2031
|
+
"type": "Omit<Contact, 'id'>"
|
|
2032
|
+
}
|
|
2033
|
+
]
|
|
2034
|
+
},
|
|
2035
|
+
{
|
|
2036
|
+
"name": "PermissionStatus",
|
|
2037
|
+
"slug": "permissionstatus",
|
|
2038
|
+
"docs": "Status of contacts permissions.",
|
|
2039
|
+
"tags": [
|
|
2040
|
+
{
|
|
2041
|
+
"text": "1.0.0",
|
|
2042
|
+
"name": "since"
|
|
2043
|
+
}
|
|
2044
|
+
],
|
|
2045
|
+
"methods": [],
|
|
2046
|
+
"properties": [
|
|
2047
|
+
{
|
|
2048
|
+
"name": "readContacts",
|
|
2049
|
+
"tags": [
|
|
2050
|
+
{
|
|
2051
|
+
"text": "1.0.0",
|
|
2052
|
+
"name": "since"
|
|
2053
|
+
}
|
|
2054
|
+
],
|
|
2055
|
+
"docs": "Permission state for reading contacts.",
|
|
2056
|
+
"complexTypes": [
|
|
2057
|
+
"ContactsPermissionState"
|
|
2058
|
+
],
|
|
2059
|
+
"type": "ContactsPermissionState"
|
|
2060
|
+
},
|
|
2061
|
+
{
|
|
2062
|
+
"name": "writeContacts",
|
|
2063
|
+
"tags": [
|
|
2064
|
+
{
|
|
2065
|
+
"text": "1.0.0",
|
|
2066
|
+
"name": "since"
|
|
2067
|
+
}
|
|
2068
|
+
],
|
|
2069
|
+
"docs": "Permission state for writing contacts.",
|
|
2070
|
+
"complexTypes": [
|
|
2071
|
+
"ContactsPermissionState"
|
|
2072
|
+
],
|
|
2073
|
+
"type": "ContactsPermissionState"
|
|
2074
|
+
}
|
|
2075
|
+
]
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
"name": "RequestPermissionsOptions",
|
|
2079
|
+
"slug": "requestpermissionsoptions",
|
|
2080
|
+
"docs": "Options for requesting contacts permissions.",
|
|
2081
|
+
"tags": [
|
|
2082
|
+
{
|
|
2083
|
+
"text": "1.0.0",
|
|
2084
|
+
"name": "since"
|
|
2085
|
+
}
|
|
2086
|
+
],
|
|
2087
|
+
"methods": [],
|
|
2088
|
+
"properties": [
|
|
2089
|
+
{
|
|
2090
|
+
"name": "permissions",
|
|
2091
|
+
"tags": [
|
|
2092
|
+
{
|
|
2093
|
+
"text": "1.0.0",
|
|
2094
|
+
"name": "since"
|
|
2095
|
+
}
|
|
2096
|
+
],
|
|
2097
|
+
"docs": "Specific permissions to request. If not provided, all permissions will be requested.",
|
|
2098
|
+
"complexTypes": [
|
|
2099
|
+
"ContactsPermissionType"
|
|
2100
|
+
],
|
|
2101
|
+
"type": "ContactsPermissionType[] | undefined"
|
|
2102
|
+
}
|
|
2103
|
+
]
|
|
2104
|
+
}
|
|
2105
|
+
],
|
|
2106
|
+
"enums": [],
|
|
2107
|
+
"typeAliases": [
|
|
2108
|
+
{
|
|
2109
|
+
"name": "Omit",
|
|
2110
|
+
"slug": "omit",
|
|
2111
|
+
"docs": "Construct a type with the properties of T except for those in type K.",
|
|
2112
|
+
"types": [
|
|
2113
|
+
{
|
|
2114
|
+
"text": "Pick<T, Exclude<keyof T, K>>",
|
|
2115
|
+
"complexTypes": [
|
|
2116
|
+
"Pick",
|
|
2117
|
+
"T",
|
|
2118
|
+
"Exclude",
|
|
2119
|
+
"K"
|
|
2120
|
+
]
|
|
2121
|
+
}
|
|
2122
|
+
]
|
|
2123
|
+
},
|
|
2124
|
+
{
|
|
2125
|
+
"name": "Pick",
|
|
2126
|
+
"slug": "pick",
|
|
2127
|
+
"docs": "From T, pick a set of properties whose keys are in the union K",
|
|
2128
|
+
"types": [
|
|
2129
|
+
{
|
|
2130
|
+
"text": "{\r\n [P in K]: T[P];\r\n}",
|
|
2131
|
+
"complexTypes": [
|
|
2132
|
+
"K",
|
|
2133
|
+
"T",
|
|
2134
|
+
"P"
|
|
2135
|
+
]
|
|
2136
|
+
}
|
|
2137
|
+
]
|
|
2138
|
+
},
|
|
2139
|
+
{
|
|
2140
|
+
"name": "Exclude",
|
|
2141
|
+
"slug": "exclude",
|
|
2142
|
+
"docs": "Exclude from T those types that are assignable to U",
|
|
2143
|
+
"types": [
|
|
2144
|
+
{
|
|
2145
|
+
"text": "T extends U ? never : T",
|
|
2146
|
+
"complexTypes": [
|
|
2147
|
+
"T",
|
|
2148
|
+
"U"
|
|
2149
|
+
]
|
|
2150
|
+
}
|
|
2151
|
+
]
|
|
2152
|
+
},
|
|
2153
|
+
{
|
|
2154
|
+
"name": "EmailAddressType",
|
|
2155
|
+
"slug": "emailaddresstype",
|
|
2156
|
+
"docs": "Type of email address.",
|
|
2157
|
+
"types": [
|
|
2158
|
+
{
|
|
2159
|
+
"text": "'CUSTOM'",
|
|
2160
|
+
"complexTypes": []
|
|
2161
|
+
},
|
|
2162
|
+
{
|
|
2163
|
+
"text": "'HOME'",
|
|
2164
|
+
"complexTypes": []
|
|
2165
|
+
},
|
|
2166
|
+
{
|
|
2167
|
+
"text": "'ICLOUD'",
|
|
2168
|
+
"complexTypes": []
|
|
2169
|
+
},
|
|
2170
|
+
{
|
|
2171
|
+
"text": "'OTHER'",
|
|
2172
|
+
"complexTypes": []
|
|
2173
|
+
},
|
|
2174
|
+
{
|
|
2175
|
+
"text": "'WORK'",
|
|
2176
|
+
"complexTypes": []
|
|
2177
|
+
}
|
|
2178
|
+
]
|
|
2179
|
+
},
|
|
2180
|
+
{
|
|
2181
|
+
"name": "PhoneNumberType",
|
|
2182
|
+
"slug": "phonenumbertype",
|
|
2183
|
+
"docs": "Type of phone number.",
|
|
2184
|
+
"types": [
|
|
2185
|
+
{
|
|
2186
|
+
"text": "'ASSISTANT'",
|
|
2187
|
+
"complexTypes": []
|
|
2188
|
+
},
|
|
2189
|
+
{
|
|
2190
|
+
"text": "'CALLBACK'",
|
|
2191
|
+
"complexTypes": []
|
|
2192
|
+
},
|
|
2193
|
+
{
|
|
2194
|
+
"text": "'CAR'",
|
|
2195
|
+
"complexTypes": []
|
|
2196
|
+
},
|
|
2197
|
+
{
|
|
2198
|
+
"text": "'COMPANY_MAIN'",
|
|
2199
|
+
"complexTypes": []
|
|
2200
|
+
},
|
|
2201
|
+
{
|
|
2202
|
+
"text": "'CUSTOM'",
|
|
2203
|
+
"complexTypes": []
|
|
2204
|
+
},
|
|
2205
|
+
{
|
|
2206
|
+
"text": "'FAX_HOME'",
|
|
2207
|
+
"complexTypes": []
|
|
2208
|
+
},
|
|
2209
|
+
{
|
|
2210
|
+
"text": "'FAX_WORK'",
|
|
2211
|
+
"complexTypes": []
|
|
2212
|
+
},
|
|
2213
|
+
{
|
|
2214
|
+
"text": "'HOME'",
|
|
2215
|
+
"complexTypes": []
|
|
2216
|
+
},
|
|
2217
|
+
{
|
|
2218
|
+
"text": "'HOME_FAX'",
|
|
2219
|
+
"complexTypes": []
|
|
2220
|
+
},
|
|
2221
|
+
{
|
|
2222
|
+
"text": "'ISDN'",
|
|
2223
|
+
"complexTypes": []
|
|
2224
|
+
},
|
|
2225
|
+
{
|
|
2226
|
+
"text": "'MAIN'",
|
|
2227
|
+
"complexTypes": []
|
|
2228
|
+
},
|
|
2229
|
+
{
|
|
2230
|
+
"text": "'MMS'",
|
|
2231
|
+
"complexTypes": []
|
|
2232
|
+
},
|
|
2233
|
+
{
|
|
2234
|
+
"text": "'MOBILE'",
|
|
2235
|
+
"complexTypes": []
|
|
2236
|
+
},
|
|
2237
|
+
{
|
|
2238
|
+
"text": "'OTHER'",
|
|
2239
|
+
"complexTypes": []
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"text": "'OTHER_FAX'",
|
|
2243
|
+
"complexTypes": []
|
|
2244
|
+
},
|
|
2245
|
+
{
|
|
2246
|
+
"text": "'PAGER'",
|
|
2247
|
+
"complexTypes": []
|
|
2248
|
+
},
|
|
2249
|
+
{
|
|
2250
|
+
"text": "'RADIO'",
|
|
2251
|
+
"complexTypes": []
|
|
2252
|
+
},
|
|
2253
|
+
{
|
|
2254
|
+
"text": "'TELEX'",
|
|
2255
|
+
"complexTypes": []
|
|
2256
|
+
},
|
|
2257
|
+
{
|
|
2258
|
+
"text": "'TTY_TDD'",
|
|
2259
|
+
"complexTypes": []
|
|
2260
|
+
},
|
|
2261
|
+
{
|
|
2262
|
+
"text": "'WORK'",
|
|
2263
|
+
"complexTypes": []
|
|
2264
|
+
},
|
|
2265
|
+
{
|
|
2266
|
+
"text": "'WORK_MOBILE'",
|
|
2267
|
+
"complexTypes": []
|
|
2268
|
+
},
|
|
2269
|
+
{
|
|
2270
|
+
"text": "'WORK_PAGER'",
|
|
2271
|
+
"complexTypes": []
|
|
2272
|
+
}
|
|
2273
|
+
]
|
|
2274
|
+
},
|
|
2275
|
+
{
|
|
2276
|
+
"name": "PostalAddressType",
|
|
2277
|
+
"slug": "postaladdresstype",
|
|
2278
|
+
"docs": "Type of postal address.",
|
|
2279
|
+
"types": [
|
|
2280
|
+
{
|
|
2281
|
+
"text": "'CUSTOM'",
|
|
2282
|
+
"complexTypes": []
|
|
2283
|
+
},
|
|
2284
|
+
{
|
|
2285
|
+
"text": "'HOME'",
|
|
2286
|
+
"complexTypes": []
|
|
2287
|
+
},
|
|
2288
|
+
{
|
|
2289
|
+
"text": "'OTHER'",
|
|
2290
|
+
"complexTypes": []
|
|
2291
|
+
},
|
|
2292
|
+
{
|
|
2293
|
+
"text": "'WORK'",
|
|
2294
|
+
"complexTypes": []
|
|
2295
|
+
}
|
|
2296
|
+
]
|
|
2297
|
+
},
|
|
2298
|
+
{
|
|
2299
|
+
"name": "UrlAddressType",
|
|
2300
|
+
"slug": "urladdresstype",
|
|
2301
|
+
"docs": "Type of URL address.",
|
|
2302
|
+
"types": [
|
|
2303
|
+
{
|
|
2304
|
+
"text": "'BLOG'",
|
|
2305
|
+
"complexTypes": []
|
|
2306
|
+
},
|
|
2307
|
+
{
|
|
2308
|
+
"text": "'CUSTOM'",
|
|
2309
|
+
"complexTypes": []
|
|
2310
|
+
},
|
|
2311
|
+
{
|
|
2312
|
+
"text": "'FTP'",
|
|
2313
|
+
"complexTypes": []
|
|
2314
|
+
},
|
|
2315
|
+
{
|
|
2316
|
+
"text": "'HOME'",
|
|
2317
|
+
"complexTypes": []
|
|
2318
|
+
},
|
|
2319
|
+
{
|
|
2320
|
+
"text": "'HOMEPAGE'",
|
|
2321
|
+
"complexTypes": []
|
|
2322
|
+
},
|
|
2323
|
+
{
|
|
2324
|
+
"text": "'OTHER'",
|
|
2325
|
+
"complexTypes": []
|
|
2326
|
+
},
|
|
2327
|
+
{
|
|
2328
|
+
"text": "'PROFILE'",
|
|
2329
|
+
"complexTypes": []
|
|
2330
|
+
},
|
|
2331
|
+
{
|
|
2332
|
+
"text": "'SCHOOL'",
|
|
2333
|
+
"complexTypes": []
|
|
2334
|
+
},
|
|
2335
|
+
{
|
|
2336
|
+
"text": "'WORK'",
|
|
2337
|
+
"complexTypes": []
|
|
2338
|
+
}
|
|
2339
|
+
]
|
|
2340
|
+
},
|
|
2341
|
+
{
|
|
2342
|
+
"name": "ContactField",
|
|
2343
|
+
"slug": "contactfield",
|
|
2344
|
+
"docs": "Field names available in a Contact object.",
|
|
2345
|
+
"types": [
|
|
2346
|
+
{
|
|
2347
|
+
"text": "keyof Contact",
|
|
2348
|
+
"complexTypes": [
|
|
2349
|
+
"Contact"
|
|
2350
|
+
]
|
|
2351
|
+
}
|
|
2352
|
+
]
|
|
2353
|
+
},
|
|
2354
|
+
{
|
|
2355
|
+
"name": "PickContactOptions",
|
|
2356
|
+
"slug": "pickcontactoptions",
|
|
2357
|
+
"docs": "Alias for PickContactsOptions.",
|
|
2358
|
+
"types": [
|
|
2359
|
+
{
|
|
2360
|
+
"text": "PickContactsOptions",
|
|
2361
|
+
"complexTypes": [
|
|
2362
|
+
"PickContactsOptions"
|
|
2363
|
+
]
|
|
2364
|
+
}
|
|
2365
|
+
]
|
|
2366
|
+
},
|
|
2367
|
+
{
|
|
2368
|
+
"name": "PickContactResult",
|
|
2369
|
+
"slug": "pickcontactresult",
|
|
2370
|
+
"docs": "Alias for PickContactsResult.",
|
|
2371
|
+
"types": [
|
|
2372
|
+
{
|
|
2373
|
+
"text": "PickContactsResult",
|
|
2374
|
+
"complexTypes": [
|
|
2375
|
+
"PickContactsResult"
|
|
2376
|
+
]
|
|
2377
|
+
}
|
|
2378
|
+
]
|
|
2379
|
+
},
|
|
2380
|
+
{
|
|
2381
|
+
"name": "ContactsPermissionState",
|
|
2382
|
+
"slug": "contactspermissionstate",
|
|
2383
|
+
"docs": "Permission state for contacts access, including the 'limited' state for iOS 18+.",
|
|
2384
|
+
"types": [
|
|
2385
|
+
{
|
|
2386
|
+
"text": "PermissionState",
|
|
2387
|
+
"complexTypes": [
|
|
2388
|
+
"PermissionState"
|
|
2389
|
+
]
|
|
2390
|
+
},
|
|
2391
|
+
{
|
|
2392
|
+
"text": "'limited'",
|
|
2393
|
+
"complexTypes": []
|
|
2394
|
+
}
|
|
2395
|
+
]
|
|
2396
|
+
},
|
|
2397
|
+
{
|
|
2398
|
+
"name": "PermissionState",
|
|
2399
|
+
"slug": "permissionstate",
|
|
2400
|
+
"docs": "",
|
|
2401
|
+
"types": [
|
|
2402
|
+
{
|
|
2403
|
+
"text": "'prompt'",
|
|
2404
|
+
"complexTypes": []
|
|
2405
|
+
},
|
|
2406
|
+
{
|
|
2407
|
+
"text": "'prompt-with-rationale'",
|
|
2408
|
+
"complexTypes": []
|
|
2409
|
+
},
|
|
2410
|
+
{
|
|
2411
|
+
"text": "'granted'",
|
|
2412
|
+
"complexTypes": []
|
|
2413
|
+
},
|
|
2414
|
+
{
|
|
2415
|
+
"text": "'denied'",
|
|
2416
|
+
"complexTypes": []
|
|
2417
|
+
}
|
|
2418
|
+
]
|
|
2419
|
+
},
|
|
2420
|
+
{
|
|
2421
|
+
"name": "ContactsPermissionType",
|
|
2422
|
+
"slug": "contactspermissiontype",
|
|
2423
|
+
"docs": "Type of contacts permission to request.",
|
|
2424
|
+
"types": [
|
|
2425
|
+
{
|
|
2426
|
+
"text": "'readContacts'",
|
|
2427
|
+
"complexTypes": []
|
|
2428
|
+
},
|
|
2429
|
+
{
|
|
2430
|
+
"text": "'writeContacts'",
|
|
2431
|
+
"complexTypes": []
|
|
2432
|
+
}
|
|
2433
|
+
]
|
|
2434
|
+
}
|
|
2435
|
+
],
|
|
2436
|
+
"pluginConfigs": []
|
|
2437
|
+
}
|