@capawesome/capacitor-pixlive 0.0.1

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.
Files changed (80) hide show
  1. package/CapawesomeCapacitorPixlive.podspec +30 -0
  2. package/Package.swift +28 -0
  3. package/README.md +1012 -0
  4. package/android/build.gradle +64 -0
  5. package/android/src/main/AndroidManifest.xml +8 -0
  6. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/Pixlive.java +704 -0
  7. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/PixliveHelper.java +112 -0
  8. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/PixlivePlugin.java +691 -0
  9. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/TouchInterceptorView.java +94 -0
  10. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/CustomException.java +20 -0
  11. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/CustomExceptions.java +29 -0
  12. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/ActivateContextOptions.java +29 -0
  13. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/CreateARViewOptions.java +68 -0
  14. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/EnableContextsWithTagsOptions.java +30 -0
  15. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/GetContextOptions.java +29 -0
  16. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/GetGPSPointsInBoundingBoxOptions.java +68 -0
  17. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/GetNearbyGPSPointsOptions.java +40 -0
  18. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/ResizeARViewOptions.java +68 -0
  19. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/SetARViewTouchEnabledOptions.java +26 -0
  20. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/SetARViewTouchHoleOptions.java +68 -0
  21. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/SetInterfaceLanguageOptions.java +29 -0
  22. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/SetNotificationsSupportOptions.java +26 -0
  23. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/SynchronizeOptions.java +30 -0
  24. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/SynchronizeWithToursAndContextsOptions.java +66 -0
  25. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/options/UpdateTagMappingOptions.java +30 -0
  26. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/results/GetContextResult.java +23 -0
  27. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/results/GetContextsResult.java +24 -0
  28. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/results/GetGPSPointsInBoundingBoxResult.java +24 -0
  29. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/results/GetNearbyBeaconsResult.java +24 -0
  30. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/results/GetNearbyGPSPointsResult.java +24 -0
  31. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/classes/results/GetVersionResult.java +24 -0
  32. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/interfaces/Callback.java +5 -0
  33. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/interfaces/EmptyCallback.java +5 -0
  34. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/interfaces/NonEmptyCallback.java +7 -0
  35. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/interfaces/NonEmptyResultCallback.java +7 -0
  36. package/android/src/main/java/io/capawesome/capacitorjs/plugins/pixlive/interfaces/Result.java +7 -0
  37. package/android/src/main/res/.gitkeep +0 -0
  38. package/dist/docs.json +2107 -0
  39. package/dist/esm/definitions.d.ts +825 -0
  40. package/dist/esm/definitions.js +2 -0
  41. package/dist/esm/definitions.js.map +1 -0
  42. package/dist/esm/index.d.ts +4 -0
  43. package/dist/esm/index.js +7 -0
  44. package/dist/esm/index.js.map +1 -0
  45. package/dist/esm/web.d.ts +31 -0
  46. package/dist/esm/web.js +85 -0
  47. package/dist/esm/web.js.map +1 -0
  48. package/dist/plugin.cjs.js +99 -0
  49. package/dist/plugin.cjs.js.map +1 -0
  50. package/dist/plugin.js +102 -0
  51. package/dist/plugin.js.map +1 -0
  52. package/ios/Plugin/CapacitorARViewController.swift +17 -0
  53. package/ios/Plugin/Classes/Options/ActivateContextOptions.swift +16 -0
  54. package/ios/Plugin/Classes/Options/CreateARViewOptions.swift +47 -0
  55. package/ios/Plugin/Classes/Options/EnableContextsWithTagsOptions.swift +16 -0
  56. package/ios/Plugin/Classes/Options/GetContextOptions.swift +16 -0
  57. package/ios/Plugin/Classes/Options/GetGPSPointsInBoundingBoxOptions.swift +43 -0
  58. package/ios/Plugin/Classes/Options/GetNearbyGPSPointsOptions.swift +25 -0
  59. package/ios/Plugin/Classes/Options/ResizeARViewOptions.swift +47 -0
  60. package/ios/Plugin/Classes/Options/SetARViewTouchEnabledOptions.swift +16 -0
  61. package/ios/Plugin/Classes/Options/SetARViewTouchHoleOptions.swift +43 -0
  62. package/ios/Plugin/Classes/Options/SetInterfaceLanguageOptions.swift +16 -0
  63. package/ios/Plugin/Classes/Options/SetNotificationsSupportOptions.swift +16 -0
  64. package/ios/Plugin/Classes/Options/SynchronizeOptions.swift +16 -0
  65. package/ios/Plugin/Classes/Options/SynchronizeWithToursAndContextsOptions.swift +34 -0
  66. package/ios/Plugin/Classes/Options/UpdateTagMappingOptions.swift +16 -0
  67. package/ios/Plugin/Classes/Results/GetContextResult.swift +16 -0
  68. package/ios/Plugin/Classes/Results/GetContextsResult.swift +16 -0
  69. package/ios/Plugin/Classes/Results/GetGPSPointsInBoundingBoxResult.swift +16 -0
  70. package/ios/Plugin/Classes/Results/GetNearbyBeaconsResult.swift +16 -0
  71. package/ios/Plugin/Classes/Results/GetNearbyGPSPointsResult.swift +16 -0
  72. package/ios/Plugin/Classes/Results/GetVersionResult.swift +16 -0
  73. package/ios/Plugin/Enums/CustomError.swift +86 -0
  74. package/ios/Plugin/Info.plist +24 -0
  75. package/ios/Plugin/Pixlive.swift +495 -0
  76. package/ios/Plugin/PixliveHelper.swift +91 -0
  77. package/ios/Plugin/PixlivePlugin.swift +503 -0
  78. package/ios/Plugin/Protocols/Result.swift +6 -0
  79. package/ios/Plugin/TouchForwarderView.swift +24 -0
  80. package/package.json +93 -0
package/dist/docs.json ADDED
@@ -0,0 +1,2107 @@
1
+ {
2
+ "api": {
3
+ "name": "PixlivePlugin",
4
+ "slug": "pixliveplugin",
5
+ "docs": "",
6
+ "tags": [
7
+ {
8
+ "text": "8.0.0",
9
+ "name": "since"
10
+ }
11
+ ],
12
+ "methods": [
13
+ {
14
+ "name": "initialize",
15
+ "signature": "() => Promise<void>",
16
+ "parameters": [],
17
+ "returns": "Promise<void>",
18
+ "tags": [
19
+ {
20
+ "name": "since",
21
+ "text": "8.0.0"
22
+ }
23
+ ],
24
+ "docs": "Initialize the PixLive SDK.\n\nThis must be called before any other method.\n\nOnly available on Android and iOS.",
25
+ "complexTypes": [],
26
+ "slug": "initialize"
27
+ },
28
+ {
29
+ "name": "checkPermissions",
30
+ "signature": "() => Promise<PermissionStatus>",
31
+ "parameters": [],
32
+ "returns": "Promise<PermissionStatus>",
33
+ "tags": [
34
+ {
35
+ "name": "since",
36
+ "text": "8.0.0"
37
+ }
38
+ ],
39
+ "docs": "Check the status of permissions.",
40
+ "complexTypes": [
41
+ "PermissionStatus"
42
+ ],
43
+ "slug": "checkpermissions"
44
+ },
45
+ {
46
+ "name": "requestPermissions",
47
+ "signature": "(options?: PixlivePluginPermission | undefined) => Promise<PermissionStatus>",
48
+ "parameters": [
49
+ {
50
+ "name": "options",
51
+ "docs": "",
52
+ "type": "PixlivePluginPermission | undefined"
53
+ }
54
+ ],
55
+ "returns": "Promise<PermissionStatus>",
56
+ "tags": [
57
+ {
58
+ "name": "since",
59
+ "text": "8.0.0"
60
+ }
61
+ ],
62
+ "docs": "Request permissions.",
63
+ "complexTypes": [
64
+ "PermissionStatus",
65
+ "PixlivePluginPermission"
66
+ ],
67
+ "slug": "requestpermissions"
68
+ },
69
+ {
70
+ "name": "synchronize",
71
+ "signature": "(options: SynchronizeOptions) => Promise<void>",
72
+ "parameters": [
73
+ {
74
+ "name": "options",
75
+ "docs": "",
76
+ "type": "SynchronizeOptions"
77
+ }
78
+ ],
79
+ "returns": "Promise<void>",
80
+ "tags": [
81
+ {
82
+ "name": "since",
83
+ "text": "8.0.0"
84
+ }
85
+ ],
86
+ "docs": "Sync content from PixLive Maker filtered by tags.\n\nOnly available on Android and iOS.",
87
+ "complexTypes": [
88
+ "SynchronizeOptions"
89
+ ],
90
+ "slug": "synchronize"
91
+ },
92
+ {
93
+ "name": "synchronizeWithToursAndContexts",
94
+ "signature": "(options: SynchronizeWithToursAndContextsOptions) => Promise<void>",
95
+ "parameters": [
96
+ {
97
+ "name": "options",
98
+ "docs": "",
99
+ "type": "SynchronizeWithToursAndContextsOptions"
100
+ }
101
+ ],
102
+ "returns": "Promise<void>",
103
+ "tags": [
104
+ {
105
+ "name": "since",
106
+ "text": "8.0.0"
107
+ }
108
+ ],
109
+ "docs": "Sync content filtered by tags, tour IDs, and context IDs.\n\nOnly available on Android and iOS.",
110
+ "complexTypes": [
111
+ "SynchronizeWithToursAndContextsOptions"
112
+ ],
113
+ "slug": "synchronizewithtoursandcontexts"
114
+ },
115
+ {
116
+ "name": "updateTagMapping",
117
+ "signature": "(options: UpdateTagMappingOptions) => Promise<void>",
118
+ "parameters": [
119
+ {
120
+ "name": "options",
121
+ "docs": "",
122
+ "type": "UpdateTagMappingOptions"
123
+ }
124
+ ],
125
+ "returns": "Promise<void>",
126
+ "tags": [
127
+ {
128
+ "name": "since",
129
+ "text": "8.0.0"
130
+ }
131
+ ],
132
+ "docs": "Update tag-to-context mappings for language filtering.\n\nOnly available on Android and iOS.",
133
+ "complexTypes": [
134
+ "UpdateTagMappingOptions"
135
+ ],
136
+ "slug": "updatetagmapping"
137
+ },
138
+ {
139
+ "name": "enableContextsWithTags",
140
+ "signature": "(options: EnableContextsWithTagsOptions) => Promise<void>",
141
+ "parameters": [
142
+ {
143
+ "name": "options",
144
+ "docs": "",
145
+ "type": "EnableContextsWithTagsOptions"
146
+ }
147
+ ],
148
+ "returns": "Promise<void>",
149
+ "tags": [
150
+ {
151
+ "name": "since",
152
+ "text": "8.0.0"
153
+ }
154
+ ],
155
+ "docs": "Enable only contexts matching specific tags.\n\nOnly available on Android and iOS.",
156
+ "complexTypes": [
157
+ "EnableContextsWithTagsOptions"
158
+ ],
159
+ "slug": "enablecontextswithtags"
160
+ },
161
+ {
162
+ "name": "getContexts",
163
+ "signature": "() => Promise<GetContextsResult>",
164
+ "parameters": [],
165
+ "returns": "Promise<GetContextsResult>",
166
+ "tags": [
167
+ {
168
+ "name": "since",
169
+ "text": "8.0.0"
170
+ }
171
+ ],
172
+ "docs": "Get all synchronized contexts.\n\nOnly available on Android and iOS.",
173
+ "complexTypes": [
174
+ "GetContextsResult"
175
+ ],
176
+ "slug": "getcontexts"
177
+ },
178
+ {
179
+ "name": "getContext",
180
+ "signature": "(options: GetContextOptions) => Promise<GetContextResult>",
181
+ "parameters": [
182
+ {
183
+ "name": "options",
184
+ "docs": "",
185
+ "type": "GetContextOptions"
186
+ }
187
+ ],
188
+ "returns": "Promise<GetContextResult>",
189
+ "tags": [
190
+ {
191
+ "name": "since",
192
+ "text": "8.0.0"
193
+ }
194
+ ],
195
+ "docs": "Get a single context by ID.\n\nOnly available on Android and iOS.",
196
+ "complexTypes": [
197
+ "GetContextResult",
198
+ "GetContextOptions"
199
+ ],
200
+ "slug": "getcontext"
201
+ },
202
+ {
203
+ "name": "activateContext",
204
+ "signature": "(options: ActivateContextOptions) => Promise<void>",
205
+ "parameters": [
206
+ {
207
+ "name": "options",
208
+ "docs": "",
209
+ "type": "ActivateContextOptions"
210
+ }
211
+ ],
212
+ "returns": "Promise<void>",
213
+ "tags": [
214
+ {
215
+ "name": "since",
216
+ "text": "8.0.0"
217
+ }
218
+ ],
219
+ "docs": "Programmatically trigger/activate a context.\n\nOnly available on Android and iOS.",
220
+ "complexTypes": [
221
+ "ActivateContextOptions"
222
+ ],
223
+ "slug": "activatecontext"
224
+ },
225
+ {
226
+ "name": "stopContext",
227
+ "signature": "() => Promise<void>",
228
+ "parameters": [],
229
+ "returns": "Promise<void>",
230
+ "tags": [
231
+ {
232
+ "name": "since",
233
+ "text": "8.0.0"
234
+ }
235
+ ],
236
+ "docs": "Stop the currently playing/active context.\n\nOnly available on Android and iOS.",
237
+ "complexTypes": [],
238
+ "slug": "stopcontext"
239
+ },
240
+ {
241
+ "name": "getNearbyGPSPoints",
242
+ "signature": "(options: GetNearbyGPSPointsOptions) => Promise<GetNearbyGPSPointsResult>",
243
+ "parameters": [
244
+ {
245
+ "name": "options",
246
+ "docs": "",
247
+ "type": "GetNearbyGPSPointsOptions"
248
+ }
249
+ ],
250
+ "returns": "Promise<GetNearbyGPSPointsResult>",
251
+ "tags": [
252
+ {
253
+ "name": "since",
254
+ "text": "8.0.0"
255
+ }
256
+ ],
257
+ "docs": "Get GPS points near a given location, sorted by distance.\n\nOnly available on Android and iOS.",
258
+ "complexTypes": [
259
+ "GetNearbyGPSPointsResult",
260
+ "GetNearbyGPSPointsOptions"
261
+ ],
262
+ "slug": "getnearbygpspoints"
263
+ },
264
+ {
265
+ "name": "getGPSPointsInBoundingBox",
266
+ "signature": "(options: GetGPSPointsInBoundingBoxOptions) => Promise<GetGPSPointsInBoundingBoxResult>",
267
+ "parameters": [
268
+ {
269
+ "name": "options",
270
+ "docs": "",
271
+ "type": "GetGPSPointsInBoundingBoxOptions"
272
+ }
273
+ ],
274
+ "returns": "Promise<GetGPSPointsInBoundingBoxResult>",
275
+ "tags": [
276
+ {
277
+ "name": "since",
278
+ "text": "8.0.0"
279
+ }
280
+ ],
281
+ "docs": "Get all GPS points within a geographic bounding box.\n\nOnly available on Android and iOS.",
282
+ "complexTypes": [
283
+ "GetGPSPointsInBoundingBoxResult",
284
+ "GetGPSPointsInBoundingBoxOptions"
285
+ ],
286
+ "slug": "getgpspointsinboundingbox"
287
+ },
288
+ {
289
+ "name": "getNearbyBeacons",
290
+ "signature": "() => Promise<GetNearbyBeaconsResult>",
291
+ "parameters": [],
292
+ "returns": "Promise<GetNearbyBeaconsResult>",
293
+ "tags": [
294
+ {
295
+ "name": "since",
296
+ "text": "8.0.0"
297
+ }
298
+ ],
299
+ "docs": "Get contexts associated with nearby detected beacons.\n\nOnly available on Android and iOS.",
300
+ "complexTypes": [
301
+ "GetNearbyBeaconsResult"
302
+ ],
303
+ "slug": "getnearbybeacons"
304
+ },
305
+ {
306
+ "name": "startNearbyGPSDetection",
307
+ "signature": "() => Promise<void>",
308
+ "parameters": [],
309
+ "returns": "Promise<void>",
310
+ "tags": [
311
+ {
312
+ "name": "since",
313
+ "text": "8.0.0"
314
+ }
315
+ ],
316
+ "docs": "Start background GPS proximity detection.\n\nOnly available on Android and iOS.",
317
+ "complexTypes": [],
318
+ "slug": "startnearbygpsdetection"
319
+ },
320
+ {
321
+ "name": "stopNearbyGPSDetection",
322
+ "signature": "() => Promise<void>",
323
+ "parameters": [],
324
+ "returns": "Promise<void>",
325
+ "tags": [
326
+ {
327
+ "name": "since",
328
+ "text": "8.0.0"
329
+ }
330
+ ],
331
+ "docs": "Stop background GPS proximity detection.\n\nOnly available on Android and iOS.",
332
+ "complexTypes": [],
333
+ "slug": "stopnearbygpsdetection"
334
+ },
335
+ {
336
+ "name": "startGPSNotifications",
337
+ "signature": "() => Promise<void>",
338
+ "parameters": [],
339
+ "returns": "Promise<void>",
340
+ "tags": [
341
+ {
342
+ "name": "since",
343
+ "text": "8.0.0"
344
+ }
345
+ ],
346
+ "docs": "Enable GPS-triggered local notifications.\n\nOnly available on Android and iOS.",
347
+ "complexTypes": [],
348
+ "slug": "startgpsnotifications"
349
+ },
350
+ {
351
+ "name": "stopGPSNotifications",
352
+ "signature": "() => Promise<void>",
353
+ "parameters": [],
354
+ "returns": "Promise<void>",
355
+ "tags": [
356
+ {
357
+ "name": "since",
358
+ "text": "8.0.0"
359
+ }
360
+ ],
361
+ "docs": "Disable GPS-triggered local notifications.\n\nOnly available on Android and iOS.",
362
+ "complexTypes": [],
363
+ "slug": "stopgpsnotifications"
364
+ },
365
+ {
366
+ "name": "setNotificationsSupport",
367
+ "signature": "(options: SetNotificationsSupportOptions) => Promise<void>",
368
+ "parameters": [
369
+ {
370
+ "name": "options",
371
+ "docs": "",
372
+ "type": "SetNotificationsSupportOptions"
373
+ }
374
+ ],
375
+ "returns": "Promise<void>",
376
+ "tags": [
377
+ {
378
+ "name": "since",
379
+ "text": "8.0.0"
380
+ }
381
+ ],
382
+ "docs": "Enable or disable notification support.\n\nOnly available on Android and iOS.",
383
+ "complexTypes": [
384
+ "SetNotificationsSupportOptions"
385
+ ],
386
+ "slug": "setnotificationssupport"
387
+ },
388
+ {
389
+ "name": "setInterfaceLanguage",
390
+ "signature": "(options: SetInterfaceLanguageOptions) => Promise<void>",
391
+ "parameters": [
392
+ {
393
+ "name": "options",
394
+ "docs": "",
395
+ "type": "SetInterfaceLanguageOptions"
396
+ }
397
+ ],
398
+ "returns": "Promise<void>",
399
+ "tags": [
400
+ {
401
+ "name": "since",
402
+ "text": "8.0.0"
403
+ }
404
+ ],
405
+ "docs": "Set the language for SDK UI elements.\n\nOnly available on Android and iOS.",
406
+ "complexTypes": [
407
+ "SetInterfaceLanguageOptions"
408
+ ],
409
+ "slug": "setinterfacelanguage"
410
+ },
411
+ {
412
+ "name": "createARView",
413
+ "signature": "(options: CreateARViewOptions) => Promise<void>",
414
+ "parameters": [
415
+ {
416
+ "name": "options",
417
+ "docs": "",
418
+ "type": "CreateARViewOptions"
419
+ }
420
+ ],
421
+ "returns": "Promise<void>",
422
+ "tags": [
423
+ {
424
+ "name": "since",
425
+ "text": "8.0.0"
426
+ }
427
+ ],
428
+ "docs": "Create the native AR camera view at specified screen coordinates.\n\nOnly available on Android and iOS.",
429
+ "complexTypes": [
430
+ "CreateARViewOptions"
431
+ ],
432
+ "slug": "createarview"
433
+ },
434
+ {
435
+ "name": "destroyARView",
436
+ "signature": "() => Promise<void>",
437
+ "parameters": [],
438
+ "returns": "Promise<void>",
439
+ "tags": [
440
+ {
441
+ "name": "since",
442
+ "text": "8.0.0"
443
+ }
444
+ ],
445
+ "docs": "Destroy the AR camera view.\n\nOnly available on Android and iOS.",
446
+ "complexTypes": [],
447
+ "slug": "destroyarview"
448
+ },
449
+ {
450
+ "name": "resizeARView",
451
+ "signature": "(options: ResizeARViewOptions) => Promise<void>",
452
+ "parameters": [
453
+ {
454
+ "name": "options",
455
+ "docs": "",
456
+ "type": "ResizeARViewOptions"
457
+ }
458
+ ],
459
+ "returns": "Promise<void>",
460
+ "tags": [
461
+ {
462
+ "name": "since",
463
+ "text": "8.0.0"
464
+ }
465
+ ],
466
+ "docs": "Resize the AR view.\n\nOnly available on Android and iOS.",
467
+ "complexTypes": [
468
+ "ResizeARViewOptions"
469
+ ],
470
+ "slug": "resizearview"
471
+ },
472
+ {
473
+ "name": "setARViewTouchEnabled",
474
+ "signature": "(options: SetARViewTouchEnabledOptions) => Promise<void>",
475
+ "parameters": [
476
+ {
477
+ "name": "options",
478
+ "docs": "",
479
+ "type": "SetARViewTouchEnabledOptions"
480
+ }
481
+ ],
482
+ "returns": "Promise<void>",
483
+ "tags": [
484
+ {
485
+ "name": "since",
486
+ "text": "8.0.0"
487
+ }
488
+ ],
489
+ "docs": "Enable or disable touch event interception on the AR view.\n\nOnly available on Android and iOS.",
490
+ "complexTypes": [
491
+ "SetARViewTouchEnabledOptions"
492
+ ],
493
+ "slug": "setarviewtouchenabled"
494
+ },
495
+ {
496
+ "name": "setARViewTouchHole",
497
+ "signature": "(options: SetARViewTouchHoleOptions) => Promise<void>",
498
+ "parameters": [
499
+ {
500
+ "name": "options",
501
+ "docs": "",
502
+ "type": "SetARViewTouchHoleOptions"
503
+ }
504
+ ],
505
+ "returns": "Promise<void>",
506
+ "tags": [
507
+ {
508
+ "name": "since",
509
+ "text": "8.0.0"
510
+ }
511
+ ],
512
+ "docs": "Define a rectangular region where touches pass through the AR view to the web layer.\n\nOnly available on Android and iOS.",
513
+ "complexTypes": [
514
+ "SetARViewTouchHoleOptions"
515
+ ],
516
+ "slug": "setarviewtouchhole"
517
+ },
518
+ {
519
+ "name": "getVersion",
520
+ "signature": "() => Promise<GetVersionResult>",
521
+ "parameters": [],
522
+ "returns": "Promise<GetVersionResult>",
523
+ "tags": [
524
+ {
525
+ "name": "since",
526
+ "text": "8.0.0"
527
+ }
528
+ ],
529
+ "docs": "Get the version of the sdk.",
530
+ "complexTypes": [
531
+ "GetVersionResult"
532
+ ],
533
+ "slug": "getversion"
534
+ },
535
+ {
536
+ "name": "addListener",
537
+ "signature": "(eventName: 'codeRecognize', listenerFunc: (event: CodeRecognizeEvent) => void) => Promise<PluginListenerHandle>",
538
+ "parameters": [
539
+ {
540
+ "name": "eventName",
541
+ "docs": "",
542
+ "type": "'codeRecognize'"
543
+ },
544
+ {
545
+ "name": "listenerFunc",
546
+ "docs": "",
547
+ "type": "(event: CodeRecognizeEvent) => void"
548
+ }
549
+ ],
550
+ "returns": "Promise<PluginListenerHandle>",
551
+ "tags": [
552
+ {
553
+ "name": "since",
554
+ "text": "8.0.0"
555
+ }
556
+ ],
557
+ "docs": "Called when a QR code or barcode is scanned by the AR camera.",
558
+ "complexTypes": [
559
+ "PluginListenerHandle",
560
+ "CodeRecognizeEvent"
561
+ ],
562
+ "slug": "addlistenercoderecognize-"
563
+ },
564
+ {
565
+ "name": "addListener",
566
+ "signature": "(eventName: 'enterContext', listenerFunc: (event: EnterContextEvent) => void) => Promise<PluginListenerHandle>",
567
+ "parameters": [
568
+ {
569
+ "name": "eventName",
570
+ "docs": "",
571
+ "type": "'enterContext'"
572
+ },
573
+ {
574
+ "name": "listenerFunc",
575
+ "docs": "",
576
+ "type": "(event: EnterContextEvent) => void"
577
+ }
578
+ ],
579
+ "returns": "Promise<PluginListenerHandle>",
580
+ "tags": [
581
+ {
582
+ "name": "since",
583
+ "text": "8.0.0"
584
+ }
585
+ ],
586
+ "docs": "Called when an AR context is detected/entered.",
587
+ "complexTypes": [
588
+ "PluginListenerHandle",
589
+ "EnterContextEvent"
590
+ ],
591
+ "slug": "addlistenerentercontext-"
592
+ },
593
+ {
594
+ "name": "addListener",
595
+ "signature": "(eventName: 'exitContext', listenerFunc: (event: ExitContextEvent) => void) => Promise<PluginListenerHandle>",
596
+ "parameters": [
597
+ {
598
+ "name": "eventName",
599
+ "docs": "",
600
+ "type": "'exitContext'"
601
+ },
602
+ {
603
+ "name": "listenerFunc",
604
+ "docs": "",
605
+ "type": "(event: ExitContextEvent) => void"
606
+ }
607
+ ],
608
+ "returns": "Promise<PluginListenerHandle>",
609
+ "tags": [
610
+ {
611
+ "name": "since",
612
+ "text": "8.0.0"
613
+ }
614
+ ],
615
+ "docs": "Called when an AR context is lost/exited.",
616
+ "complexTypes": [
617
+ "PluginListenerHandle",
618
+ "ExitContextEvent"
619
+ ],
620
+ "slug": "addlistenerexitcontext-"
621
+ },
622
+ {
623
+ "name": "addListener",
624
+ "signature": "(eventName: 'presentAnnotations', listenerFunc: () => void) => Promise<PluginListenerHandle>",
625
+ "parameters": [
626
+ {
627
+ "name": "eventName",
628
+ "docs": "",
629
+ "type": "'presentAnnotations'"
630
+ },
631
+ {
632
+ "name": "listenerFunc",
633
+ "docs": "",
634
+ "type": "() => void"
635
+ }
636
+ ],
637
+ "returns": "Promise<PluginListenerHandle>",
638
+ "tags": [
639
+ {
640
+ "name": "since",
641
+ "text": "8.0.0"
642
+ }
643
+ ],
644
+ "docs": "Called when AR content/annotations become visible on screen.",
645
+ "complexTypes": [
646
+ "PluginListenerHandle"
647
+ ],
648
+ "slug": "addlistenerpresentannotations-"
649
+ },
650
+ {
651
+ "name": "addListener",
652
+ "signature": "(eventName: 'hideAnnotations', listenerFunc: () => void) => Promise<PluginListenerHandle>",
653
+ "parameters": [
654
+ {
655
+ "name": "eventName",
656
+ "docs": "",
657
+ "type": "'hideAnnotations'"
658
+ },
659
+ {
660
+ "name": "listenerFunc",
661
+ "docs": "",
662
+ "type": "() => void"
663
+ }
664
+ ],
665
+ "returns": "Promise<PluginListenerHandle>",
666
+ "tags": [
667
+ {
668
+ "name": "since",
669
+ "text": "8.0.0"
670
+ }
671
+ ],
672
+ "docs": "Called when AR content/annotations are hidden.",
673
+ "complexTypes": [
674
+ "PluginListenerHandle"
675
+ ],
676
+ "slug": "addlistenerhideannotations-"
677
+ },
678
+ {
679
+ "name": "addListener",
680
+ "signature": "(eventName: 'eventFromContent', listenerFunc: (event: EventFromContentEvent) => void) => Promise<PluginListenerHandle>",
681
+ "parameters": [
682
+ {
683
+ "name": "eventName",
684
+ "docs": "",
685
+ "type": "'eventFromContent'"
686
+ },
687
+ {
688
+ "name": "listenerFunc",
689
+ "docs": "",
690
+ "type": "(event: EventFromContentEvent) => void"
691
+ }
692
+ ],
693
+ "returns": "Promise<PluginListenerHandle>",
694
+ "tags": [
695
+ {
696
+ "name": "since",
697
+ "text": "8.0.0"
698
+ }
699
+ ],
700
+ "docs": "Called when AR content dispatches a custom event.",
701
+ "complexTypes": [
702
+ "PluginListenerHandle",
703
+ "EventFromContentEvent"
704
+ ],
705
+ "slug": "addlistenereventfromcontent-"
706
+ },
707
+ {
708
+ "name": "addListener",
709
+ "signature": "(eventName: 'syncProgress', listenerFunc: (event: SyncProgressEvent) => void) => Promise<PluginListenerHandle>",
710
+ "parameters": [
711
+ {
712
+ "name": "eventName",
713
+ "docs": "",
714
+ "type": "'syncProgress'"
715
+ },
716
+ {
717
+ "name": "listenerFunc",
718
+ "docs": "",
719
+ "type": "(event: SyncProgressEvent) => void"
720
+ }
721
+ ],
722
+ "returns": "Promise<PluginListenerHandle>",
723
+ "tags": [
724
+ {
725
+ "name": "since",
726
+ "text": "8.0.0"
727
+ }
728
+ ],
729
+ "docs": "Called during synchronization with progress updates.",
730
+ "complexTypes": [
731
+ "PluginListenerHandle",
732
+ "SyncProgressEvent"
733
+ ],
734
+ "slug": "addlistenersyncprogress-"
735
+ },
736
+ {
737
+ "name": "addListener",
738
+ "signature": "(eventName: 'requireSync', listenerFunc: (event: RequireSyncEvent) => void) => Promise<PluginListenerHandle>",
739
+ "parameters": [
740
+ {
741
+ "name": "eventName",
742
+ "docs": "",
743
+ "type": "'requireSync'"
744
+ },
745
+ {
746
+ "name": "listenerFunc",
747
+ "docs": "",
748
+ "type": "(event: RequireSyncEvent) => void"
749
+ }
750
+ ],
751
+ "returns": "Promise<PluginListenerHandle>",
752
+ "tags": [
753
+ {
754
+ "name": "since",
755
+ "text": "8.0.0"
756
+ }
757
+ ],
758
+ "docs": "Called when the SDK requires synchronization with specific tags.",
759
+ "complexTypes": [
760
+ "PluginListenerHandle",
761
+ "RequireSyncEvent"
762
+ ],
763
+ "slug": "addlistenerrequiresync-"
764
+ },
765
+ {
766
+ "name": "removeAllListeners",
767
+ "signature": "() => Promise<void>",
768
+ "parameters": [],
769
+ "returns": "Promise<void>",
770
+ "tags": [
771
+ {
772
+ "name": "since",
773
+ "text": "8.0.0"
774
+ }
775
+ ],
776
+ "docs": "Remove all listeners for this plugin.",
777
+ "complexTypes": [],
778
+ "slug": "removealllisteners"
779
+ }
780
+ ],
781
+ "properties": []
782
+ },
783
+ "interfaces": [
784
+ {
785
+ "name": "PermissionStatus",
786
+ "slug": "permissionstatus",
787
+ "docs": "",
788
+ "tags": [
789
+ {
790
+ "text": "8.0.0",
791
+ "name": "since"
792
+ }
793
+ ],
794
+ "methods": [],
795
+ "properties": [
796
+ {
797
+ "name": "bluetooth",
798
+ "tags": [
799
+ {
800
+ "text": "8.0.0",
801
+ "name": "since"
802
+ }
803
+ ],
804
+ "docs": "Permission state of the Bluetooth permission.\n\nOnly available on iOS.",
805
+ "complexTypes": [
806
+ "PermissionState"
807
+ ],
808
+ "type": "PermissionState"
809
+ },
810
+ {
811
+ "name": "bluetoothConnect",
812
+ "tags": [
813
+ {
814
+ "text": "8.0.0",
815
+ "name": "since"
816
+ }
817
+ ],
818
+ "docs": "Permission state of the Bluetooth Connect permission.\n\nOnly available on Android.",
819
+ "complexTypes": [
820
+ "PermissionState"
821
+ ],
822
+ "type": "PermissionState"
823
+ },
824
+ {
825
+ "name": "bluetoothScan",
826
+ "tags": [
827
+ {
828
+ "text": "8.0.0",
829
+ "name": "since"
830
+ }
831
+ ],
832
+ "docs": "Permission state of the Bluetooth Scan permission.\n\nOnly available on Android.",
833
+ "complexTypes": [
834
+ "PermissionState"
835
+ ],
836
+ "type": "PermissionState"
837
+ },
838
+ {
839
+ "name": "camera",
840
+ "tags": [
841
+ {
842
+ "text": "8.0.0",
843
+ "name": "since"
844
+ }
845
+ ],
846
+ "docs": "Permission state of the Camera permission.",
847
+ "complexTypes": [
848
+ "PermissionState"
849
+ ],
850
+ "type": "PermissionState"
851
+ },
852
+ {
853
+ "name": "location",
854
+ "tags": [
855
+ {
856
+ "text": "8.0.0",
857
+ "name": "since"
858
+ }
859
+ ],
860
+ "docs": "Permission state of the Location permission.\n\nOnly available on Android and iOS.",
861
+ "complexTypes": [
862
+ "PermissionState"
863
+ ],
864
+ "type": "PermissionState"
865
+ },
866
+ {
867
+ "name": "notifications",
868
+ "tags": [
869
+ {
870
+ "text": "8.0.0",
871
+ "name": "since"
872
+ }
873
+ ],
874
+ "docs": "Permission state of the Notifications permission.",
875
+ "complexTypes": [
876
+ "PermissionState"
877
+ ],
878
+ "type": "PermissionState"
879
+ }
880
+ ]
881
+ },
882
+ {
883
+ "name": "PixlivePluginPermission",
884
+ "slug": "pixlivepluginpermission",
885
+ "docs": "",
886
+ "tags": [
887
+ {
888
+ "text": "8.0.0",
889
+ "name": "since"
890
+ }
891
+ ],
892
+ "methods": [],
893
+ "properties": [
894
+ {
895
+ "name": "permissions",
896
+ "tags": [
897
+ {
898
+ "text": "8.0.0",
899
+ "name": "since"
900
+ }
901
+ ],
902
+ "docs": "The permissions to request.",
903
+ "complexTypes": [
904
+ "PixlivePermissionType"
905
+ ],
906
+ "type": "PixlivePermissionType[]"
907
+ }
908
+ ]
909
+ },
910
+ {
911
+ "name": "SynchronizeOptions",
912
+ "slug": "synchronizeoptions",
913
+ "docs": "",
914
+ "tags": [
915
+ {
916
+ "text": "8.0.0",
917
+ "name": "since"
918
+ }
919
+ ],
920
+ "methods": [],
921
+ "properties": [
922
+ {
923
+ "name": "tags",
924
+ "tags": [
925
+ {
926
+ "text": "8.0.0",
927
+ "name": "since"
928
+ }
929
+ ],
930
+ "docs": "The tags to filter content by.",
931
+ "complexTypes": [],
932
+ "type": "string[][]"
933
+ }
934
+ ]
935
+ },
936
+ {
937
+ "name": "SynchronizeWithToursAndContextsOptions",
938
+ "slug": "synchronizewithtoursandcontextsoptions",
939
+ "docs": "",
940
+ "tags": [
941
+ {
942
+ "text": "8.0.0",
943
+ "name": "since"
944
+ }
945
+ ],
946
+ "methods": [],
947
+ "properties": [
948
+ {
949
+ "name": "tags",
950
+ "tags": [
951
+ {
952
+ "text": "8.0.0",
953
+ "name": "since"
954
+ }
955
+ ],
956
+ "docs": "The tags to filter content by.",
957
+ "complexTypes": [],
958
+ "type": "string[][]"
959
+ },
960
+ {
961
+ "name": "tourIds",
962
+ "tags": [
963
+ {
964
+ "text": "8.0.0",
965
+ "name": "since"
966
+ }
967
+ ],
968
+ "docs": "The tour IDs to sync.",
969
+ "complexTypes": [],
970
+ "type": "number[]"
971
+ },
972
+ {
973
+ "name": "contextIds",
974
+ "tags": [
975
+ {
976
+ "text": "8.0.0",
977
+ "name": "since"
978
+ }
979
+ ],
980
+ "docs": "The context IDs to sync.",
981
+ "complexTypes": [],
982
+ "type": "string[]"
983
+ }
984
+ ]
985
+ },
986
+ {
987
+ "name": "UpdateTagMappingOptions",
988
+ "slug": "updatetagmappingoptions",
989
+ "docs": "",
990
+ "tags": [
991
+ {
992
+ "text": "8.0.0",
993
+ "name": "since"
994
+ }
995
+ ],
996
+ "methods": [],
997
+ "properties": [
998
+ {
999
+ "name": "tags",
1000
+ "tags": [
1001
+ {
1002
+ "text": "8.0.0",
1003
+ "name": "since"
1004
+ }
1005
+ ],
1006
+ "docs": "The tags to map.",
1007
+ "complexTypes": [],
1008
+ "type": "string[]"
1009
+ }
1010
+ ]
1011
+ },
1012
+ {
1013
+ "name": "EnableContextsWithTagsOptions",
1014
+ "slug": "enablecontextswithtagsoptions",
1015
+ "docs": "",
1016
+ "tags": [
1017
+ {
1018
+ "text": "8.0.0",
1019
+ "name": "since"
1020
+ }
1021
+ ],
1022
+ "methods": [],
1023
+ "properties": [
1024
+ {
1025
+ "name": "tags",
1026
+ "tags": [
1027
+ {
1028
+ "text": "8.0.0",
1029
+ "name": "since"
1030
+ }
1031
+ ],
1032
+ "docs": "The tags to enable contexts for.",
1033
+ "complexTypes": [],
1034
+ "type": "string[]"
1035
+ }
1036
+ ]
1037
+ },
1038
+ {
1039
+ "name": "GetContextsResult",
1040
+ "slug": "getcontextsresult",
1041
+ "docs": "",
1042
+ "tags": [
1043
+ {
1044
+ "text": "8.0.0",
1045
+ "name": "since"
1046
+ }
1047
+ ],
1048
+ "methods": [],
1049
+ "properties": [
1050
+ {
1051
+ "name": "contexts",
1052
+ "tags": [
1053
+ {
1054
+ "text": "8.0.0",
1055
+ "name": "since"
1056
+ }
1057
+ ],
1058
+ "docs": "The list of synchronized contexts.",
1059
+ "complexTypes": [
1060
+ "Context"
1061
+ ],
1062
+ "type": "Context[]"
1063
+ }
1064
+ ]
1065
+ },
1066
+ {
1067
+ "name": "Context",
1068
+ "slug": "context",
1069
+ "docs": "",
1070
+ "tags": [
1071
+ {
1072
+ "text": "8.0.0",
1073
+ "name": "since"
1074
+ }
1075
+ ],
1076
+ "methods": [],
1077
+ "properties": [
1078
+ {
1079
+ "name": "contextId",
1080
+ "tags": [
1081
+ {
1082
+ "text": "8.0.0",
1083
+ "name": "since"
1084
+ }
1085
+ ],
1086
+ "docs": "The unique identifier of the context.",
1087
+ "complexTypes": [],
1088
+ "type": "string"
1089
+ },
1090
+ {
1091
+ "name": "name",
1092
+ "tags": [
1093
+ {
1094
+ "text": "8.0.0",
1095
+ "name": "since"
1096
+ }
1097
+ ],
1098
+ "docs": "The name of the context.",
1099
+ "complexTypes": [],
1100
+ "type": "string"
1101
+ },
1102
+ {
1103
+ "name": "description",
1104
+ "tags": [
1105
+ {
1106
+ "text": "8.0.0",
1107
+ "name": "since"
1108
+ }
1109
+ ],
1110
+ "docs": "The description of the context.",
1111
+ "complexTypes": [],
1112
+ "type": "string | null"
1113
+ },
1114
+ {
1115
+ "name": "lastUpdate",
1116
+ "tags": [
1117
+ {
1118
+ "text": "8.0.0",
1119
+ "name": "since"
1120
+ }
1121
+ ],
1122
+ "docs": "The last update timestamp.",
1123
+ "complexTypes": [],
1124
+ "type": "string"
1125
+ },
1126
+ {
1127
+ "name": "imageThumbnailURL",
1128
+ "tags": [
1129
+ {
1130
+ "text": "8.0.0",
1131
+ "name": "since"
1132
+ }
1133
+ ],
1134
+ "docs": "The URL of the thumbnail image.",
1135
+ "complexTypes": [],
1136
+ "type": "string | null"
1137
+ },
1138
+ {
1139
+ "name": "imageHiResURL",
1140
+ "tags": [
1141
+ {
1142
+ "text": "8.0.0",
1143
+ "name": "since"
1144
+ }
1145
+ ],
1146
+ "docs": "The URL of the high-resolution image.",
1147
+ "complexTypes": [],
1148
+ "type": "string | null"
1149
+ },
1150
+ {
1151
+ "name": "notificationTitle",
1152
+ "tags": [
1153
+ {
1154
+ "text": "8.0.0",
1155
+ "name": "since"
1156
+ }
1157
+ ],
1158
+ "docs": "The notification title.",
1159
+ "complexTypes": [],
1160
+ "type": "string | null"
1161
+ },
1162
+ {
1163
+ "name": "notificationMessage",
1164
+ "tags": [
1165
+ {
1166
+ "text": "8.0.0",
1167
+ "name": "since"
1168
+ }
1169
+ ],
1170
+ "docs": "The notification message.",
1171
+ "complexTypes": [],
1172
+ "type": "string | null"
1173
+ },
1174
+ {
1175
+ "name": "tags",
1176
+ "tags": [
1177
+ {
1178
+ "text": "8.0.0",
1179
+ "name": "since"
1180
+ }
1181
+ ],
1182
+ "docs": "The tags associated with the context.",
1183
+ "complexTypes": [],
1184
+ "type": "string[]"
1185
+ }
1186
+ ]
1187
+ },
1188
+ {
1189
+ "name": "GetContextResult",
1190
+ "slug": "getcontextresult",
1191
+ "docs": "",
1192
+ "tags": [
1193
+ {
1194
+ "text": "8.0.0",
1195
+ "name": "since"
1196
+ }
1197
+ ],
1198
+ "methods": [],
1199
+ "properties": [
1200
+ {
1201
+ "name": "context",
1202
+ "tags": [
1203
+ {
1204
+ "text": "8.0.0",
1205
+ "name": "since"
1206
+ }
1207
+ ],
1208
+ "docs": "The context.",
1209
+ "complexTypes": [
1210
+ "Context"
1211
+ ],
1212
+ "type": "Context"
1213
+ }
1214
+ ]
1215
+ },
1216
+ {
1217
+ "name": "GetContextOptions",
1218
+ "slug": "getcontextoptions",
1219
+ "docs": "",
1220
+ "tags": [
1221
+ {
1222
+ "text": "8.0.0",
1223
+ "name": "since"
1224
+ }
1225
+ ],
1226
+ "methods": [],
1227
+ "properties": [
1228
+ {
1229
+ "name": "contextId",
1230
+ "tags": [
1231
+ {
1232
+ "text": "8.0.0",
1233
+ "name": "since"
1234
+ },
1235
+ {
1236
+ "text": "\"12345\"",
1237
+ "name": "example"
1238
+ }
1239
+ ],
1240
+ "docs": "The ID of the context to retrieve.",
1241
+ "complexTypes": [],
1242
+ "type": "string"
1243
+ }
1244
+ ]
1245
+ },
1246
+ {
1247
+ "name": "ActivateContextOptions",
1248
+ "slug": "activatecontextoptions",
1249
+ "docs": "",
1250
+ "tags": [
1251
+ {
1252
+ "text": "8.0.0",
1253
+ "name": "since"
1254
+ }
1255
+ ],
1256
+ "methods": [],
1257
+ "properties": [
1258
+ {
1259
+ "name": "contextId",
1260
+ "tags": [
1261
+ {
1262
+ "text": "8.0.0",
1263
+ "name": "since"
1264
+ },
1265
+ {
1266
+ "text": "\"12345\"",
1267
+ "name": "example"
1268
+ }
1269
+ ],
1270
+ "docs": "The ID of the context to activate.",
1271
+ "complexTypes": [],
1272
+ "type": "string"
1273
+ }
1274
+ ]
1275
+ },
1276
+ {
1277
+ "name": "GetNearbyGPSPointsResult",
1278
+ "slug": "getnearbygpspointsresult",
1279
+ "docs": "",
1280
+ "tags": [
1281
+ {
1282
+ "text": "8.0.0",
1283
+ "name": "since"
1284
+ }
1285
+ ],
1286
+ "methods": [],
1287
+ "properties": [
1288
+ {
1289
+ "name": "points",
1290
+ "tags": [
1291
+ {
1292
+ "text": "8.0.0",
1293
+ "name": "since"
1294
+ }
1295
+ ],
1296
+ "docs": "The nearby GPS points sorted by distance.",
1297
+ "complexTypes": [
1298
+ "GPSPoint"
1299
+ ],
1300
+ "type": "GPSPoint[]"
1301
+ }
1302
+ ]
1303
+ },
1304
+ {
1305
+ "name": "GPSPoint",
1306
+ "slug": "gpspoint",
1307
+ "docs": "",
1308
+ "tags": [
1309
+ {
1310
+ "text": "8.0.0",
1311
+ "name": "since"
1312
+ }
1313
+ ],
1314
+ "methods": [],
1315
+ "properties": [
1316
+ {
1317
+ "name": "contextId",
1318
+ "tags": [
1319
+ {
1320
+ "text": "8.0.0",
1321
+ "name": "since"
1322
+ }
1323
+ ],
1324
+ "docs": "The ID of the associated context.",
1325
+ "complexTypes": [],
1326
+ "type": "string"
1327
+ },
1328
+ {
1329
+ "name": "category",
1330
+ "tags": [
1331
+ {
1332
+ "text": "8.0.0",
1333
+ "name": "since"
1334
+ }
1335
+ ],
1336
+ "docs": "The category of the GPS point.",
1337
+ "complexTypes": [],
1338
+ "type": "string"
1339
+ },
1340
+ {
1341
+ "name": "label",
1342
+ "tags": [
1343
+ {
1344
+ "text": "8.0.0",
1345
+ "name": "since"
1346
+ }
1347
+ ],
1348
+ "docs": "The label of the GPS point.",
1349
+ "complexTypes": [],
1350
+ "type": "string"
1351
+ },
1352
+ {
1353
+ "name": "latitude",
1354
+ "tags": [
1355
+ {
1356
+ "text": "8.0.0",
1357
+ "name": "since"
1358
+ }
1359
+ ],
1360
+ "docs": "The latitude of the GPS point.",
1361
+ "complexTypes": [],
1362
+ "type": "number"
1363
+ },
1364
+ {
1365
+ "name": "longitude",
1366
+ "tags": [
1367
+ {
1368
+ "text": "8.0.0",
1369
+ "name": "since"
1370
+ }
1371
+ ],
1372
+ "docs": "The longitude of the GPS point.",
1373
+ "complexTypes": [],
1374
+ "type": "number"
1375
+ },
1376
+ {
1377
+ "name": "detectionRadius",
1378
+ "tags": [
1379
+ {
1380
+ "text": "8.0.0",
1381
+ "name": "since"
1382
+ }
1383
+ ],
1384
+ "docs": "The detection radius in meters.",
1385
+ "complexTypes": [],
1386
+ "type": "number | null"
1387
+ },
1388
+ {
1389
+ "name": "distanceFromCurrentPosition",
1390
+ "tags": [
1391
+ {
1392
+ "text": "8.0.0",
1393
+ "name": "since"
1394
+ }
1395
+ ],
1396
+ "docs": "The distance from the current position in meters.",
1397
+ "complexTypes": [],
1398
+ "type": "number"
1399
+ }
1400
+ ]
1401
+ },
1402
+ {
1403
+ "name": "GetNearbyGPSPointsOptions",
1404
+ "slug": "getnearbygpspointsoptions",
1405
+ "docs": "",
1406
+ "tags": [
1407
+ {
1408
+ "text": "8.0.0",
1409
+ "name": "since"
1410
+ }
1411
+ ],
1412
+ "methods": [],
1413
+ "properties": [
1414
+ {
1415
+ "name": "latitude",
1416
+ "tags": [
1417
+ {
1418
+ "text": "8.0.0",
1419
+ "name": "since"
1420
+ }
1421
+ ],
1422
+ "docs": "The latitude of the reference location.",
1423
+ "complexTypes": [],
1424
+ "type": "number"
1425
+ },
1426
+ {
1427
+ "name": "longitude",
1428
+ "tags": [
1429
+ {
1430
+ "text": "8.0.0",
1431
+ "name": "since"
1432
+ }
1433
+ ],
1434
+ "docs": "The longitude of the reference location.",
1435
+ "complexTypes": [],
1436
+ "type": "number"
1437
+ }
1438
+ ]
1439
+ },
1440
+ {
1441
+ "name": "GetGPSPointsInBoundingBoxResult",
1442
+ "slug": "getgpspointsinboundingboxresult",
1443
+ "docs": "",
1444
+ "tags": [
1445
+ {
1446
+ "text": "8.0.0",
1447
+ "name": "since"
1448
+ }
1449
+ ],
1450
+ "methods": [],
1451
+ "properties": [
1452
+ {
1453
+ "name": "points",
1454
+ "tags": [
1455
+ {
1456
+ "text": "8.0.0",
1457
+ "name": "since"
1458
+ }
1459
+ ],
1460
+ "docs": "The GPS points within the bounding box.",
1461
+ "complexTypes": [
1462
+ "GPSPoint"
1463
+ ],
1464
+ "type": "GPSPoint[]"
1465
+ }
1466
+ ]
1467
+ },
1468
+ {
1469
+ "name": "GetGPSPointsInBoundingBoxOptions",
1470
+ "slug": "getgpspointsinboundingboxoptions",
1471
+ "docs": "",
1472
+ "tags": [
1473
+ {
1474
+ "text": "8.0.0",
1475
+ "name": "since"
1476
+ }
1477
+ ],
1478
+ "methods": [],
1479
+ "properties": [
1480
+ {
1481
+ "name": "minLatitude",
1482
+ "tags": [
1483
+ {
1484
+ "text": "8.0.0",
1485
+ "name": "since"
1486
+ }
1487
+ ],
1488
+ "docs": "The minimum latitude of the bounding box.",
1489
+ "complexTypes": [],
1490
+ "type": "number"
1491
+ },
1492
+ {
1493
+ "name": "minLongitude",
1494
+ "tags": [
1495
+ {
1496
+ "text": "8.0.0",
1497
+ "name": "since"
1498
+ }
1499
+ ],
1500
+ "docs": "The minimum longitude of the bounding box.",
1501
+ "complexTypes": [],
1502
+ "type": "number"
1503
+ },
1504
+ {
1505
+ "name": "maxLatitude",
1506
+ "tags": [
1507
+ {
1508
+ "text": "8.0.0",
1509
+ "name": "since"
1510
+ }
1511
+ ],
1512
+ "docs": "The maximum latitude of the bounding box.",
1513
+ "complexTypes": [],
1514
+ "type": "number"
1515
+ },
1516
+ {
1517
+ "name": "maxLongitude",
1518
+ "tags": [
1519
+ {
1520
+ "text": "8.0.0",
1521
+ "name": "since"
1522
+ }
1523
+ ],
1524
+ "docs": "The maximum longitude of the bounding box.",
1525
+ "complexTypes": [],
1526
+ "type": "number"
1527
+ }
1528
+ ]
1529
+ },
1530
+ {
1531
+ "name": "GetNearbyBeaconsResult",
1532
+ "slug": "getnearbybeaconsresult",
1533
+ "docs": "",
1534
+ "tags": [
1535
+ {
1536
+ "text": "8.0.0",
1537
+ "name": "since"
1538
+ }
1539
+ ],
1540
+ "methods": [],
1541
+ "properties": [
1542
+ {
1543
+ "name": "contexts",
1544
+ "tags": [
1545
+ {
1546
+ "text": "8.0.0",
1547
+ "name": "since"
1548
+ }
1549
+ ],
1550
+ "docs": "The contexts associated with nearby beacons.",
1551
+ "complexTypes": [
1552
+ "Context"
1553
+ ],
1554
+ "type": "Context[]"
1555
+ }
1556
+ ]
1557
+ },
1558
+ {
1559
+ "name": "SetNotificationsSupportOptions",
1560
+ "slug": "setnotificationssupportoptions",
1561
+ "docs": "",
1562
+ "tags": [
1563
+ {
1564
+ "text": "8.0.0",
1565
+ "name": "since"
1566
+ }
1567
+ ],
1568
+ "methods": [],
1569
+ "properties": [
1570
+ {
1571
+ "name": "enabled",
1572
+ "tags": [
1573
+ {
1574
+ "text": "8.0.0",
1575
+ "name": "since"
1576
+ }
1577
+ ],
1578
+ "docs": "Whether notifications support should be enabled.",
1579
+ "complexTypes": [],
1580
+ "type": "boolean"
1581
+ }
1582
+ ]
1583
+ },
1584
+ {
1585
+ "name": "SetInterfaceLanguageOptions",
1586
+ "slug": "setinterfacelanguageoptions",
1587
+ "docs": "",
1588
+ "tags": [
1589
+ {
1590
+ "text": "8.0.0",
1591
+ "name": "since"
1592
+ }
1593
+ ],
1594
+ "methods": [],
1595
+ "properties": [
1596
+ {
1597
+ "name": "language",
1598
+ "tags": [
1599
+ {
1600
+ "text": "8.0.0",
1601
+ "name": "since"
1602
+ },
1603
+ {
1604
+ "text": "\"en\"",
1605
+ "name": "example"
1606
+ }
1607
+ ],
1608
+ "docs": "The language code to set.",
1609
+ "complexTypes": [],
1610
+ "type": "string"
1611
+ }
1612
+ ]
1613
+ },
1614
+ {
1615
+ "name": "CreateARViewOptions",
1616
+ "slug": "createarviewoptions",
1617
+ "docs": "",
1618
+ "tags": [
1619
+ {
1620
+ "text": "8.0.0",
1621
+ "name": "since"
1622
+ }
1623
+ ],
1624
+ "methods": [],
1625
+ "properties": [
1626
+ {
1627
+ "name": "x",
1628
+ "tags": [
1629
+ {
1630
+ "text": "8.0.0",
1631
+ "name": "since"
1632
+ }
1633
+ ],
1634
+ "docs": "The x position of the AR view.",
1635
+ "complexTypes": [],
1636
+ "type": "number"
1637
+ },
1638
+ {
1639
+ "name": "y",
1640
+ "tags": [
1641
+ {
1642
+ "text": "8.0.0",
1643
+ "name": "since"
1644
+ }
1645
+ ],
1646
+ "docs": "The y position of the AR view.",
1647
+ "complexTypes": [],
1648
+ "type": "number"
1649
+ },
1650
+ {
1651
+ "name": "width",
1652
+ "tags": [
1653
+ {
1654
+ "text": "8.0.0",
1655
+ "name": "since"
1656
+ }
1657
+ ],
1658
+ "docs": "The width of the AR view.",
1659
+ "complexTypes": [],
1660
+ "type": "number"
1661
+ },
1662
+ {
1663
+ "name": "height",
1664
+ "tags": [
1665
+ {
1666
+ "text": "8.0.0",
1667
+ "name": "since"
1668
+ }
1669
+ ],
1670
+ "docs": "The height of the AR view.",
1671
+ "complexTypes": [],
1672
+ "type": "number"
1673
+ }
1674
+ ]
1675
+ },
1676
+ {
1677
+ "name": "ResizeARViewOptions",
1678
+ "slug": "resizearviewoptions",
1679
+ "docs": "",
1680
+ "tags": [
1681
+ {
1682
+ "text": "8.0.0",
1683
+ "name": "since"
1684
+ }
1685
+ ],
1686
+ "methods": [],
1687
+ "properties": [
1688
+ {
1689
+ "name": "x",
1690
+ "tags": [
1691
+ {
1692
+ "text": "8.0.0",
1693
+ "name": "since"
1694
+ }
1695
+ ],
1696
+ "docs": "The new x position of the AR view.",
1697
+ "complexTypes": [],
1698
+ "type": "number"
1699
+ },
1700
+ {
1701
+ "name": "y",
1702
+ "tags": [
1703
+ {
1704
+ "text": "8.0.0",
1705
+ "name": "since"
1706
+ }
1707
+ ],
1708
+ "docs": "The new y position of the AR view.",
1709
+ "complexTypes": [],
1710
+ "type": "number"
1711
+ },
1712
+ {
1713
+ "name": "width",
1714
+ "tags": [
1715
+ {
1716
+ "text": "8.0.0",
1717
+ "name": "since"
1718
+ }
1719
+ ],
1720
+ "docs": "The new width of the AR view.",
1721
+ "complexTypes": [],
1722
+ "type": "number"
1723
+ },
1724
+ {
1725
+ "name": "height",
1726
+ "tags": [
1727
+ {
1728
+ "text": "8.0.0",
1729
+ "name": "since"
1730
+ }
1731
+ ],
1732
+ "docs": "The new height of the AR view.",
1733
+ "complexTypes": [],
1734
+ "type": "number"
1735
+ }
1736
+ ]
1737
+ },
1738
+ {
1739
+ "name": "SetARViewTouchEnabledOptions",
1740
+ "slug": "setarviewtouchenabledoptions",
1741
+ "docs": "",
1742
+ "tags": [
1743
+ {
1744
+ "text": "8.0.0",
1745
+ "name": "since"
1746
+ }
1747
+ ],
1748
+ "methods": [],
1749
+ "properties": [
1750
+ {
1751
+ "name": "enabled",
1752
+ "tags": [
1753
+ {
1754
+ "text": "8.0.0",
1755
+ "name": "since"
1756
+ }
1757
+ ],
1758
+ "docs": "Whether touch events should be intercepted by the AR view.",
1759
+ "complexTypes": [],
1760
+ "type": "boolean"
1761
+ }
1762
+ ]
1763
+ },
1764
+ {
1765
+ "name": "SetARViewTouchHoleOptions",
1766
+ "slug": "setarviewtouchholeoptions",
1767
+ "docs": "",
1768
+ "tags": [
1769
+ {
1770
+ "text": "8.0.0",
1771
+ "name": "since"
1772
+ }
1773
+ ],
1774
+ "methods": [],
1775
+ "properties": [
1776
+ {
1777
+ "name": "top",
1778
+ "tags": [
1779
+ {
1780
+ "text": "8.0.0",
1781
+ "name": "since"
1782
+ }
1783
+ ],
1784
+ "docs": "The top coordinate of the touch hole region.",
1785
+ "complexTypes": [],
1786
+ "type": "number"
1787
+ },
1788
+ {
1789
+ "name": "bottom",
1790
+ "tags": [
1791
+ {
1792
+ "text": "8.0.0",
1793
+ "name": "since"
1794
+ }
1795
+ ],
1796
+ "docs": "The bottom coordinate of the touch hole region.",
1797
+ "complexTypes": [],
1798
+ "type": "number"
1799
+ },
1800
+ {
1801
+ "name": "left",
1802
+ "tags": [
1803
+ {
1804
+ "text": "8.0.0",
1805
+ "name": "since"
1806
+ }
1807
+ ],
1808
+ "docs": "The left coordinate of the touch hole region.",
1809
+ "complexTypes": [],
1810
+ "type": "number"
1811
+ },
1812
+ {
1813
+ "name": "right",
1814
+ "tags": [
1815
+ {
1816
+ "text": "8.0.0",
1817
+ "name": "since"
1818
+ }
1819
+ ],
1820
+ "docs": "The right coordinate of the touch hole region.",
1821
+ "complexTypes": [],
1822
+ "type": "number"
1823
+ }
1824
+ ]
1825
+ },
1826
+ {
1827
+ "name": "GetVersionResult",
1828
+ "slug": "getversionresult",
1829
+ "docs": "",
1830
+ "tags": [
1831
+ {
1832
+ "text": "8.0.0",
1833
+ "name": "since"
1834
+ }
1835
+ ],
1836
+ "methods": [],
1837
+ "properties": [
1838
+ {
1839
+ "name": "version",
1840
+ "tags": [
1841
+ {
1842
+ "text": "8.0.0",
1843
+ "name": "since"
1844
+ }
1845
+ ],
1846
+ "docs": "The version of the sdk.",
1847
+ "complexTypes": [],
1848
+ "type": "string"
1849
+ }
1850
+ ]
1851
+ },
1852
+ {
1853
+ "name": "PluginListenerHandle",
1854
+ "slug": "pluginlistenerhandle",
1855
+ "docs": "",
1856
+ "tags": [],
1857
+ "methods": [],
1858
+ "properties": [
1859
+ {
1860
+ "name": "remove",
1861
+ "tags": [],
1862
+ "docs": "",
1863
+ "complexTypes": [],
1864
+ "type": "() => Promise<void>"
1865
+ }
1866
+ ]
1867
+ },
1868
+ {
1869
+ "name": "CodeRecognizeEvent",
1870
+ "slug": "coderecognizeevent",
1871
+ "docs": "",
1872
+ "tags": [
1873
+ {
1874
+ "text": "8.0.0",
1875
+ "name": "since"
1876
+ }
1877
+ ],
1878
+ "methods": [],
1879
+ "properties": [
1880
+ {
1881
+ "name": "code",
1882
+ "tags": [
1883
+ {
1884
+ "text": "8.0.0",
1885
+ "name": "since"
1886
+ }
1887
+ ],
1888
+ "docs": "The scanned code value.",
1889
+ "complexTypes": [],
1890
+ "type": "string"
1891
+ },
1892
+ {
1893
+ "name": "type",
1894
+ "tags": [
1895
+ {
1896
+ "text": "8.0.0",
1897
+ "name": "since"
1898
+ }
1899
+ ],
1900
+ "docs": "The type of the scanned code.",
1901
+ "complexTypes": [],
1902
+ "type": "string"
1903
+ }
1904
+ ]
1905
+ },
1906
+ {
1907
+ "name": "EnterContextEvent",
1908
+ "slug": "entercontextevent",
1909
+ "docs": "",
1910
+ "tags": [
1911
+ {
1912
+ "text": "8.0.0",
1913
+ "name": "since"
1914
+ }
1915
+ ],
1916
+ "methods": [],
1917
+ "properties": [
1918
+ {
1919
+ "name": "contextId",
1920
+ "tags": [
1921
+ {
1922
+ "text": "8.0.0",
1923
+ "name": "since"
1924
+ }
1925
+ ],
1926
+ "docs": "The ID of the entered context.",
1927
+ "complexTypes": [],
1928
+ "type": "string"
1929
+ }
1930
+ ]
1931
+ },
1932
+ {
1933
+ "name": "ExitContextEvent",
1934
+ "slug": "exitcontextevent",
1935
+ "docs": "",
1936
+ "tags": [
1937
+ {
1938
+ "text": "8.0.0",
1939
+ "name": "since"
1940
+ }
1941
+ ],
1942
+ "methods": [],
1943
+ "properties": [
1944
+ {
1945
+ "name": "contextId",
1946
+ "tags": [
1947
+ {
1948
+ "text": "8.0.0",
1949
+ "name": "since"
1950
+ }
1951
+ ],
1952
+ "docs": "The ID of the exited context.",
1953
+ "complexTypes": [],
1954
+ "type": "string"
1955
+ }
1956
+ ]
1957
+ },
1958
+ {
1959
+ "name": "EventFromContentEvent",
1960
+ "slug": "eventfromcontentevent",
1961
+ "docs": "",
1962
+ "tags": [
1963
+ {
1964
+ "text": "8.0.0",
1965
+ "name": "since"
1966
+ }
1967
+ ],
1968
+ "methods": [],
1969
+ "properties": [
1970
+ {
1971
+ "name": "name",
1972
+ "tags": [
1973
+ {
1974
+ "text": "8.0.0",
1975
+ "name": "since"
1976
+ }
1977
+ ],
1978
+ "docs": "The name of the custom event.",
1979
+ "complexTypes": [],
1980
+ "type": "string"
1981
+ },
1982
+ {
1983
+ "name": "params",
1984
+ "tags": [
1985
+ {
1986
+ "text": "8.0.0",
1987
+ "name": "since"
1988
+ }
1989
+ ],
1990
+ "docs": "The parameters of the custom event.",
1991
+ "complexTypes": [],
1992
+ "type": "string"
1993
+ }
1994
+ ]
1995
+ },
1996
+ {
1997
+ "name": "SyncProgressEvent",
1998
+ "slug": "syncprogressevent",
1999
+ "docs": "",
2000
+ "tags": [
2001
+ {
2002
+ "text": "8.0.0",
2003
+ "name": "since"
2004
+ }
2005
+ ],
2006
+ "methods": [],
2007
+ "properties": [
2008
+ {
2009
+ "name": "progress",
2010
+ "tags": [
2011
+ {
2012
+ "text": "8.0.0",
2013
+ "name": "since"
2014
+ }
2015
+ ],
2016
+ "docs": "The sync progress value between 0.0 and 1.0.",
2017
+ "complexTypes": [],
2018
+ "type": "number"
2019
+ }
2020
+ ]
2021
+ },
2022
+ {
2023
+ "name": "RequireSyncEvent",
2024
+ "slug": "requiresyncevent",
2025
+ "docs": "",
2026
+ "tags": [
2027
+ {
2028
+ "text": "8.0.0",
2029
+ "name": "since"
2030
+ }
2031
+ ],
2032
+ "methods": [],
2033
+ "properties": [
2034
+ {
2035
+ "name": "tags",
2036
+ "tags": [
2037
+ {
2038
+ "text": "8.0.0",
2039
+ "name": "since"
2040
+ }
2041
+ ],
2042
+ "docs": "The tags that require synchronization.",
2043
+ "complexTypes": [],
2044
+ "type": "string[]"
2045
+ }
2046
+ ]
2047
+ }
2048
+ ],
2049
+ "enums": [],
2050
+ "typeAliases": [
2051
+ {
2052
+ "name": "PermissionState",
2053
+ "slug": "permissionstate",
2054
+ "docs": "",
2055
+ "types": [
2056
+ {
2057
+ "text": "'prompt'",
2058
+ "complexTypes": []
2059
+ },
2060
+ {
2061
+ "text": "'prompt-with-rationale'",
2062
+ "complexTypes": []
2063
+ },
2064
+ {
2065
+ "text": "'granted'",
2066
+ "complexTypes": []
2067
+ },
2068
+ {
2069
+ "text": "'denied'",
2070
+ "complexTypes": []
2071
+ }
2072
+ ]
2073
+ },
2074
+ {
2075
+ "name": "PixlivePermissionType",
2076
+ "slug": "pixlivepermissiontype",
2077
+ "docs": "",
2078
+ "types": [
2079
+ {
2080
+ "text": "'bluetooth'",
2081
+ "complexTypes": []
2082
+ },
2083
+ {
2084
+ "text": "'bluetoothConnect'",
2085
+ "complexTypes": []
2086
+ },
2087
+ {
2088
+ "text": "'bluetoothScan'",
2089
+ "complexTypes": []
2090
+ },
2091
+ {
2092
+ "text": "'camera'",
2093
+ "complexTypes": []
2094
+ },
2095
+ {
2096
+ "text": "'location'",
2097
+ "complexTypes": []
2098
+ },
2099
+ {
2100
+ "text": "'notifications'",
2101
+ "complexTypes": []
2102
+ }
2103
+ ]
2104
+ }
2105
+ ],
2106
+ "pluginConfigs": []
2107
+ }