@capawesome/capacitor-pixlive 0.1.2 → 0.1.3
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/README.md +104 -103
- package/dist/docs.json +144 -132
- package/dist/esm/definitions.d.ts +139 -133
- package/dist/esm/definitions.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -118,7 +118,7 @@ This must be called before any other method.
|
|
|
118
118
|
|
|
119
119
|
Only available on Android and iOS.
|
|
120
120
|
|
|
121
|
-
**Since:**
|
|
121
|
+
**Since:** 0.0.1
|
|
122
122
|
|
|
123
123
|
--------------------
|
|
124
124
|
|
|
@@ -133,7 +133,7 @@ Check the status of permissions.
|
|
|
133
133
|
|
|
134
134
|
**Returns:** <code>Promise<<a href="#permissionstatus">PermissionStatus</a>></code>
|
|
135
135
|
|
|
136
|
-
**Since:**
|
|
136
|
+
**Since:** 0.0.1
|
|
137
137
|
|
|
138
138
|
--------------------
|
|
139
139
|
|
|
@@ -152,7 +152,7 @@ Request permissions.
|
|
|
152
152
|
|
|
153
153
|
**Returns:** <code>Promise<<a href="#permissionstatus">PermissionStatus</a>></code>
|
|
154
154
|
|
|
155
|
-
**Since:**
|
|
155
|
+
**Since:** 0.0.1
|
|
156
156
|
|
|
157
157
|
--------------------
|
|
158
158
|
|
|
@@ -171,7 +171,7 @@ Only available on Android and iOS.
|
|
|
171
171
|
| ------------- | ----------------------------------------------------------------- |
|
|
172
172
|
| **`options`** | <code><a href="#synchronizeoptions">SynchronizeOptions</a></code> |
|
|
173
173
|
|
|
174
|
-
**Since:**
|
|
174
|
+
**Since:** 0.0.1
|
|
175
175
|
|
|
176
176
|
--------------------
|
|
177
177
|
|
|
@@ -190,7 +190,7 @@ Only available on Android and iOS.
|
|
|
190
190
|
| ------------- | --------------------------------------------------------------------------------------------------------- |
|
|
191
191
|
| **`options`** | <code><a href="#synchronizewithtoursandcontextsoptions">SynchronizeWithToursAndContextsOptions</a></code> |
|
|
192
192
|
|
|
193
|
-
**Since:**
|
|
193
|
+
**Since:** 0.0.1
|
|
194
194
|
|
|
195
195
|
--------------------
|
|
196
196
|
|
|
@@ -209,7 +209,7 @@ Only available on Android and iOS.
|
|
|
209
209
|
| ------------- | --------------------------------------------------------------------------- |
|
|
210
210
|
| **`options`** | <code><a href="#updatetagmappingoptions">UpdateTagMappingOptions</a></code> |
|
|
211
211
|
|
|
212
|
-
**Since:**
|
|
212
|
+
**Since:** 0.0.1
|
|
213
213
|
|
|
214
214
|
--------------------
|
|
215
215
|
|
|
@@ -228,7 +228,7 @@ Only available on Android and iOS.
|
|
|
228
228
|
| ------------- | --------------------------------------------------------------------------------------- |
|
|
229
229
|
| **`options`** | <code><a href="#enablecontextswithtagsoptions">EnableContextsWithTagsOptions</a></code> |
|
|
230
230
|
|
|
231
|
-
**Since:**
|
|
231
|
+
**Since:** 0.0.1
|
|
232
232
|
|
|
233
233
|
--------------------
|
|
234
234
|
|
|
@@ -245,7 +245,7 @@ Only available on Android and iOS.
|
|
|
245
245
|
|
|
246
246
|
**Returns:** <code>Promise<<a href="#getcontextsresult">GetContextsResult</a>></code>
|
|
247
247
|
|
|
248
|
-
**Since:**
|
|
248
|
+
**Since:** 0.0.1
|
|
249
249
|
|
|
250
250
|
--------------------
|
|
251
251
|
|
|
@@ -266,7 +266,7 @@ Only available on Android and iOS.
|
|
|
266
266
|
|
|
267
267
|
**Returns:** <code>Promise<<a href="#getcontextresult">GetContextResult</a>></code>
|
|
268
268
|
|
|
269
|
-
**Since:**
|
|
269
|
+
**Since:** 0.0.1
|
|
270
270
|
|
|
271
271
|
--------------------
|
|
272
272
|
|
|
@@ -285,7 +285,7 @@ Only available on Android and iOS.
|
|
|
285
285
|
| ------------- | ------------------------------------------------------------------------- |
|
|
286
286
|
| **`options`** | <code><a href="#activatecontextoptions">ActivateContextOptions</a></code> |
|
|
287
287
|
|
|
288
|
-
**Since:**
|
|
288
|
+
**Since:** 0.0.1
|
|
289
289
|
|
|
290
290
|
--------------------
|
|
291
291
|
|
|
@@ -300,7 +300,7 @@ Stop the currently playing/active context.
|
|
|
300
300
|
|
|
301
301
|
Only available on Android and iOS.
|
|
302
302
|
|
|
303
|
-
**Since:**
|
|
303
|
+
**Since:** 0.0.1
|
|
304
304
|
|
|
305
305
|
--------------------
|
|
306
306
|
|
|
@@ -321,7 +321,7 @@ Only available on Android and iOS.
|
|
|
321
321
|
|
|
322
322
|
**Returns:** <code>Promise<<a href="#getnearbygpspointsresult">GetNearbyGPSPointsResult</a>></code>
|
|
323
323
|
|
|
324
|
-
**Since:**
|
|
324
|
+
**Since:** 0.0.1
|
|
325
325
|
|
|
326
326
|
--------------------
|
|
327
327
|
|
|
@@ -342,7 +342,7 @@ Only available on Android and iOS.
|
|
|
342
342
|
|
|
343
343
|
**Returns:** <code>Promise<<a href="#getgpspointsinboundingboxresult">GetGPSPointsInBoundingBoxResult</a>></code>
|
|
344
344
|
|
|
345
|
-
**Since:**
|
|
345
|
+
**Since:** 0.0.1
|
|
346
346
|
|
|
347
347
|
--------------------
|
|
348
348
|
|
|
@@ -359,7 +359,7 @@ Only available on Android and iOS.
|
|
|
359
359
|
|
|
360
360
|
**Returns:** <code>Promise<<a href="#getnearbybeaconsresult">GetNearbyBeaconsResult</a>></code>
|
|
361
361
|
|
|
362
|
-
**Since:**
|
|
362
|
+
**Since:** 0.0.1
|
|
363
363
|
|
|
364
364
|
--------------------
|
|
365
365
|
|
|
@@ -374,7 +374,7 @@ Start background GPS proximity detection.
|
|
|
374
374
|
|
|
375
375
|
Only available on Android and iOS.
|
|
376
376
|
|
|
377
|
-
**Since:**
|
|
377
|
+
**Since:** 0.0.1
|
|
378
378
|
|
|
379
379
|
--------------------
|
|
380
380
|
|
|
@@ -389,7 +389,7 @@ Stop background GPS proximity detection.
|
|
|
389
389
|
|
|
390
390
|
Only available on Android and iOS.
|
|
391
391
|
|
|
392
|
-
**Since:**
|
|
392
|
+
**Since:** 0.0.1
|
|
393
393
|
|
|
394
394
|
--------------------
|
|
395
395
|
|
|
@@ -404,7 +404,7 @@ Enable GPS-triggered local notifications.
|
|
|
404
404
|
|
|
405
405
|
Only available on Android and iOS.
|
|
406
406
|
|
|
407
|
-
**Since:**
|
|
407
|
+
**Since:** 0.0.1
|
|
408
408
|
|
|
409
409
|
--------------------
|
|
410
410
|
|
|
@@ -419,7 +419,7 @@ Disable GPS-triggered local notifications.
|
|
|
419
419
|
|
|
420
420
|
Only available on Android and iOS.
|
|
421
421
|
|
|
422
|
-
**Since:**
|
|
422
|
+
**Since:** 0.0.1
|
|
423
423
|
|
|
424
424
|
--------------------
|
|
425
425
|
|
|
@@ -438,7 +438,7 @@ Only available on Android and iOS.
|
|
|
438
438
|
| ------------- | ----------------------------------------------------------------------------------------- |
|
|
439
439
|
| **`options`** | <code><a href="#setnotificationssupportoptions">SetNotificationsSupportOptions</a></code> |
|
|
440
440
|
|
|
441
|
-
**Since:**
|
|
441
|
+
**Since:** 0.0.1
|
|
442
442
|
|
|
443
443
|
--------------------
|
|
444
444
|
|
|
@@ -457,7 +457,7 @@ Only available on Android and iOS.
|
|
|
457
457
|
| ------------- | ----------------------------------------------------------------------------------- |
|
|
458
458
|
| **`options`** | <code><a href="#setinterfacelanguageoptions">SetInterfaceLanguageOptions</a></code> |
|
|
459
459
|
|
|
460
|
-
**Since:**
|
|
460
|
+
**Since:** 0.0.1
|
|
461
461
|
|
|
462
462
|
--------------------
|
|
463
463
|
|
|
@@ -476,7 +476,7 @@ Only available on Android and iOS.
|
|
|
476
476
|
| ------------- | ------------------------------------------------------------------- |
|
|
477
477
|
| **`options`** | <code><a href="#createarviewoptions">CreateARViewOptions</a></code> |
|
|
478
478
|
|
|
479
|
-
**Since:**
|
|
479
|
+
**Since:** 0.0.1
|
|
480
480
|
|
|
481
481
|
--------------------
|
|
482
482
|
|
|
@@ -491,7 +491,7 @@ Destroy the AR camera view.
|
|
|
491
491
|
|
|
492
492
|
Only available on Android and iOS.
|
|
493
493
|
|
|
494
|
-
**Since:**
|
|
494
|
+
**Since:** 0.0.1
|
|
495
495
|
|
|
496
496
|
--------------------
|
|
497
497
|
|
|
@@ -510,7 +510,7 @@ Only available on Android and iOS.
|
|
|
510
510
|
| ------------- | ------------------------------------------------------------------- |
|
|
511
511
|
| **`options`** | <code><a href="#resizearviewoptions">ResizeARViewOptions</a></code> |
|
|
512
512
|
|
|
513
|
-
**Since:**
|
|
513
|
+
**Since:** 0.0.1
|
|
514
514
|
|
|
515
515
|
--------------------
|
|
516
516
|
|
|
@@ -529,7 +529,7 @@ Only available on Android and iOS.
|
|
|
529
529
|
| ------------- | ------------------------------------------------------------------------------------- |
|
|
530
530
|
| **`options`** | <code><a href="#setarviewtouchenabledoptions">SetARViewTouchEnabledOptions</a></code> |
|
|
531
531
|
|
|
532
|
-
**Since:**
|
|
532
|
+
**Since:** 0.0.1
|
|
533
533
|
|
|
534
534
|
--------------------
|
|
535
535
|
|
|
@@ -548,7 +548,7 @@ Only available on Android and iOS.
|
|
|
548
548
|
| ------------- | ------------------------------------------------------------------------------- |
|
|
549
549
|
| **`options`** | <code><a href="#setarviewtouchholeoptions">SetARViewTouchHoleOptions</a></code> |
|
|
550
550
|
|
|
551
|
-
**Since:**
|
|
551
|
+
**Since:** 0.0.1
|
|
552
552
|
|
|
553
553
|
--------------------
|
|
554
554
|
|
|
@@ -563,7 +563,7 @@ Get the version of the sdk.
|
|
|
563
563
|
|
|
564
564
|
**Returns:** <code>Promise<<a href="#getversionresult">GetVersionResult</a>></code>
|
|
565
565
|
|
|
566
|
-
**Since:**
|
|
566
|
+
**Since:** 0.0.1
|
|
567
567
|
|
|
568
568
|
--------------------
|
|
569
569
|
|
|
@@ -583,7 +583,7 @@ Called when a QR code or barcode is scanned by the AR camera.
|
|
|
583
583
|
|
|
584
584
|
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
585
585
|
|
|
586
|
-
**Since:**
|
|
586
|
+
**Since:** 0.0.1
|
|
587
587
|
|
|
588
588
|
--------------------
|
|
589
589
|
|
|
@@ -603,7 +603,7 @@ Called when an AR context is detected/entered.
|
|
|
603
603
|
|
|
604
604
|
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
605
605
|
|
|
606
|
-
**Since:**
|
|
606
|
+
**Since:** 0.0.1
|
|
607
607
|
|
|
608
608
|
--------------------
|
|
609
609
|
|
|
@@ -623,7 +623,7 @@ Called when an AR context is lost/exited.
|
|
|
623
623
|
|
|
624
624
|
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
625
625
|
|
|
626
|
-
**Since:**
|
|
626
|
+
**Since:** 0.0.1
|
|
627
627
|
|
|
628
628
|
--------------------
|
|
629
629
|
|
|
@@ -643,7 +643,7 @@ Called when AR content/annotations become visible on screen.
|
|
|
643
643
|
|
|
644
644
|
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
645
645
|
|
|
646
|
-
**Since:**
|
|
646
|
+
**Since:** 0.0.1
|
|
647
647
|
|
|
648
648
|
--------------------
|
|
649
649
|
|
|
@@ -663,7 +663,7 @@ Called when AR content/annotations are hidden.
|
|
|
663
663
|
|
|
664
664
|
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
665
665
|
|
|
666
|
-
**Since:**
|
|
666
|
+
**Since:** 0.0.1
|
|
667
667
|
|
|
668
668
|
--------------------
|
|
669
669
|
|
|
@@ -683,7 +683,7 @@ Called when AR content dispatches a custom event.
|
|
|
683
683
|
|
|
684
684
|
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
685
685
|
|
|
686
|
-
**Since:**
|
|
686
|
+
**Since:** 0.0.1
|
|
687
687
|
|
|
688
688
|
--------------------
|
|
689
689
|
|
|
@@ -703,7 +703,7 @@ Called during synchronization with progress updates.
|
|
|
703
703
|
|
|
704
704
|
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
705
705
|
|
|
706
|
-
**Since:**
|
|
706
|
+
**Since:** 0.0.1
|
|
707
707
|
|
|
708
708
|
--------------------
|
|
709
709
|
|
|
@@ -723,7 +723,7 @@ Called when the SDK requires synchronization with specific tags.
|
|
|
723
723
|
|
|
724
724
|
**Returns:** <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>></code>
|
|
725
725
|
|
|
726
|
-
**Since:**
|
|
726
|
+
**Since:** 0.0.1
|
|
727
727
|
|
|
728
728
|
--------------------
|
|
729
729
|
|
|
@@ -736,7 +736,7 @@ removeAllListeners() => Promise<void>
|
|
|
736
736
|
|
|
737
737
|
Remove all listeners for this plugin.
|
|
738
738
|
|
|
739
|
-
**Since:**
|
|
739
|
+
**Since:** 0.0.1
|
|
740
740
|
|
|
741
741
|
--------------------
|
|
742
742
|
|
|
@@ -748,202 +748,203 @@ Remove all listeners for this plugin.
|
|
|
748
748
|
|
|
749
749
|
| Prop | Type | Description | Since |
|
|
750
750
|
| ---------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ----- |
|
|
751
|
-
| **`bluetooth`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Bluetooth permission. Only available on iOS. |
|
|
752
|
-
| **`bluetoothConnect`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Bluetooth Connect permission. Only available on Android. |
|
|
753
|
-
| **`bluetoothScan`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Bluetooth Scan permission. Only available on Android. |
|
|
754
|
-
| **`camera`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Camera permission. |
|
|
755
|
-
| **`location`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Location permission. Only available on Android and iOS. |
|
|
756
|
-
| **`notifications`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Notifications permission. |
|
|
751
|
+
| **`bluetooth`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Bluetooth permission. Only available on iOS. | 0.0.1 |
|
|
752
|
+
| **`bluetoothConnect`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Bluetooth Connect permission. Only available on Android. | 0.0.1 |
|
|
753
|
+
| **`bluetoothScan`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Bluetooth Scan permission. Only available on Android. | 0.0.1 |
|
|
754
|
+
| **`camera`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Camera permission. | 0.0.1 |
|
|
755
|
+
| **`location`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Location permission. Only available on Android and iOS. | 0.0.1 |
|
|
756
|
+
| **`notifications`** | <code><a href="#permissionstate">PermissionState</a></code> | Permission state of the Notifications permission. | 0.0.1 |
|
|
757
757
|
|
|
758
758
|
|
|
759
759
|
#### PixlivePluginPermission
|
|
760
760
|
|
|
761
761
|
| Prop | Type | Description | Since |
|
|
762
762
|
| ----------------- | ------------------------------------ | --------------------------- | ----- |
|
|
763
|
-
| **`permissions`** | <code>PixlivePermissionType[]</code> | The permissions to request. |
|
|
763
|
+
| **`permissions`** | <code>PixlivePermissionType[]</code> | The permissions to request. | 0.0.1 |
|
|
764
764
|
|
|
765
765
|
|
|
766
766
|
#### SynchronizeOptions
|
|
767
767
|
|
|
768
768
|
| Prop | Type | Description | Since |
|
|
769
769
|
| ---------- | ----------------------- | ------------------------------ | ----- |
|
|
770
|
-
| **`tags`** | <code>string[][]</code> | The tags to filter content by. |
|
|
770
|
+
| **`tags`** | <code>string[][]</code> | The tags to filter content by. | 0.0.1 |
|
|
771
771
|
|
|
772
772
|
|
|
773
773
|
#### SynchronizeWithToursAndContextsOptions
|
|
774
774
|
|
|
775
775
|
| Prop | Type | Description | Since |
|
|
776
776
|
| ---------------- | ----------------------- | ------------------------------ | ----- |
|
|
777
|
-
| **`tags`** | <code>string[][]</code> | The tags to filter content by. |
|
|
778
|
-
| **`tourIds`** | <code>number[]</code> | The tour IDs to sync. |
|
|
779
|
-
| **`contextIds`** | <code>string[]</code> | The context IDs to sync. |
|
|
777
|
+
| **`tags`** | <code>string[][]</code> | The tags to filter content by. | 0.0.1 |
|
|
778
|
+
| **`tourIds`** | <code>number[]</code> | The tour IDs to sync. | 0.0.1 |
|
|
779
|
+
| **`contextIds`** | <code>string[]</code> | The context IDs to sync. | 0.0.1 |
|
|
780
780
|
|
|
781
781
|
|
|
782
782
|
#### UpdateTagMappingOptions
|
|
783
783
|
|
|
784
784
|
| Prop | Type | Description | Since |
|
|
785
785
|
| ---------- | --------------------- | ---------------- | ----- |
|
|
786
|
-
| **`tags`** | <code>string[]</code> | The tags to map. |
|
|
786
|
+
| **`tags`** | <code>string[]</code> | The tags to map. | 0.0.1 |
|
|
787
787
|
|
|
788
788
|
|
|
789
789
|
#### EnableContextsWithTagsOptions
|
|
790
790
|
|
|
791
791
|
| Prop | Type | Description | Since |
|
|
792
792
|
| ---------- | --------------------- | -------------------------------- | ----- |
|
|
793
|
-
| **`tags`** | <code>string[]</code> | The tags to enable contexts for. |
|
|
793
|
+
| **`tags`** | <code>string[]</code> | The tags to enable contexts for. | 0.0.1 |
|
|
794
794
|
|
|
795
795
|
|
|
796
796
|
#### GetContextsResult
|
|
797
797
|
|
|
798
798
|
| Prop | Type | Description | Since |
|
|
799
799
|
| -------------- | ---------------------- | ---------------------------------- | ----- |
|
|
800
|
-
| **`contexts`** | <code>Context[]</code> | The list of synchronized contexts. |
|
|
800
|
+
| **`contexts`** | <code>Context[]</code> | The list of synchronized contexts. | 0.0.1 |
|
|
801
801
|
|
|
802
802
|
|
|
803
803
|
#### Context
|
|
804
804
|
|
|
805
|
-
| Prop | Type | Description
|
|
806
|
-
| ------------------------- | --------------------------- |
|
|
807
|
-
| **`contextId`** | <code>string</code> | The unique identifier of the context.
|
|
808
|
-
| **`name`** | <code>string</code> | The name of the context.
|
|
809
|
-
| **`description`** | <code>string \| null</code> | The description of the context.
|
|
810
|
-
| **`lastUpdate`** | <code>string</code> | The last update timestamp.
|
|
811
|
-
| **`imageThumbnailURL`** | <code>string \| null</code> | The URL of the thumbnail image.
|
|
812
|
-
| **`imageHiResURL`** | <code>string \| null</code> | The URL of the high-resolution image.
|
|
813
|
-
| **`notificationTitle`** | <code>string \| null</code> | The notification title.
|
|
814
|
-
| **`notificationMessage`** | <code>string \| null</code> | The notification message.
|
|
815
|
-
| **`tags`** | <code>string[]</code> | The tags associated with the context.
|
|
805
|
+
| Prop | Type | Description | Since |
|
|
806
|
+
| ------------------------- | --------------------------- | ---------------------------------------- | ----- |
|
|
807
|
+
| **`contextId`** | <code>string</code> | The unique identifier of the context. | 0.0.1 |
|
|
808
|
+
| **`name`** | <code>string</code> | The name of the context. | 0.0.1 |
|
|
809
|
+
| **`description`** | <code>string \| null</code> | The description of the context. | 0.0.1 |
|
|
810
|
+
| **`lastUpdate`** | <code>string</code> | The last update timestamp. | 0.0.1 |
|
|
811
|
+
| **`imageThumbnailURL`** | <code>string \| null</code> | The URL of the thumbnail image. | 0.0.1 |
|
|
812
|
+
| **`imageHiResURL`** | <code>string \| null</code> | The URL of the high-resolution image. | 0.0.1 |
|
|
813
|
+
| **`notificationTitle`** | <code>string \| null</code> | The notification title. | 0.0.1 |
|
|
814
|
+
| **`notificationMessage`** | <code>string \| null</code> | The notification message. | 0.0.1 |
|
|
815
|
+
| **`tags`** | <code>string[]</code> | The tags associated with the context. | 0.0.1 |
|
|
816
|
+
| **`languages`** | <code>string[]</code> | The languages provided for this context. | 0.1.3 |
|
|
816
817
|
|
|
817
818
|
|
|
818
819
|
#### GetContextResult
|
|
819
820
|
|
|
820
821
|
| Prop | Type | Description | Since |
|
|
821
822
|
| ------------- | ------------------------------------------- | ------------ | ----- |
|
|
822
|
-
| **`context`** | <code><a href="#context">Context</a></code> | The context. |
|
|
823
|
+
| **`context`** | <code><a href="#context">Context</a></code> | The context. | 0.0.1 |
|
|
823
824
|
|
|
824
825
|
|
|
825
826
|
#### GetContextOptions
|
|
826
827
|
|
|
827
828
|
| Prop | Type | Description | Since |
|
|
828
829
|
| --------------- | ------------------- | ---------------------------------- | ----- |
|
|
829
|
-
| **`contextId`** | <code>string</code> | The ID of the context to retrieve. |
|
|
830
|
+
| **`contextId`** | <code>string</code> | The ID of the context to retrieve. | 0.0.1 |
|
|
830
831
|
|
|
831
832
|
|
|
832
833
|
#### ActivateContextOptions
|
|
833
834
|
|
|
834
835
|
| Prop | Type | Description | Since |
|
|
835
836
|
| --------------- | ------------------- | ---------------------------------- | ----- |
|
|
836
|
-
| **`contextId`** | <code>string</code> | The ID of the context to activate. |
|
|
837
|
+
| **`contextId`** | <code>string</code> | The ID of the context to activate. | 0.0.1 |
|
|
837
838
|
|
|
838
839
|
|
|
839
840
|
#### GetNearbyGPSPointsResult
|
|
840
841
|
|
|
841
842
|
| Prop | Type | Description | Since |
|
|
842
843
|
| ------------ | ----------------------- | ----------------------------------------- | ----- |
|
|
843
|
-
| **`points`** | <code>GPSPoint[]</code> | The nearby GPS points sorted by distance. |
|
|
844
|
+
| **`points`** | <code>GPSPoint[]</code> | The nearby GPS points sorted by distance. | 0.0.1 |
|
|
844
845
|
|
|
845
846
|
|
|
846
847
|
#### GPSPoint
|
|
847
848
|
|
|
848
849
|
| Prop | Type | Description | Since |
|
|
849
850
|
| --------------------------------- | --------------------------- | ------------------------------------------------- | ----- |
|
|
850
|
-
| **`contextId`** | <code>string</code> | The ID of the associated context. |
|
|
851
|
-
| **`category`** | <code>string</code> | The category of the GPS point. |
|
|
852
|
-
| **`label`** | <code>string</code> | The label of the GPS point. |
|
|
853
|
-
| **`latitude`** | <code>number</code> | The latitude of the GPS point. |
|
|
854
|
-
| **`longitude`** | <code>number</code> | The longitude of the GPS point. |
|
|
855
|
-
| **`detectionRadius`** | <code>number \| null</code> | The detection radius in meters. |
|
|
856
|
-
| **`distanceFromCurrentPosition`** | <code>number</code> | The distance from the current position in meters. |
|
|
851
|
+
| **`contextId`** | <code>string</code> | The ID of the associated context. | 0.0.1 |
|
|
852
|
+
| **`category`** | <code>string</code> | The category of the GPS point. | 0.0.1 |
|
|
853
|
+
| **`label`** | <code>string</code> | The label of the GPS point. | 0.0.1 |
|
|
854
|
+
| **`latitude`** | <code>number</code> | The latitude of the GPS point. | 0.0.1 |
|
|
855
|
+
| **`longitude`** | <code>number</code> | The longitude of the GPS point. | 0.0.1 |
|
|
856
|
+
| **`detectionRadius`** | <code>number \| null</code> | The detection radius in meters. | 0.0.1 |
|
|
857
|
+
| **`distanceFromCurrentPosition`** | <code>number</code> | The distance from the current position in meters. | 0.0.1 |
|
|
857
858
|
|
|
858
859
|
|
|
859
860
|
#### GetNearbyGPSPointsOptions
|
|
860
861
|
|
|
861
862
|
| Prop | Type | Description | Since |
|
|
862
863
|
| --------------- | ------------------- | ---------------------------------------- | ----- |
|
|
863
|
-
| **`latitude`** | <code>number</code> | The latitude of the reference location. |
|
|
864
|
-
| **`longitude`** | <code>number</code> | The longitude of the reference location. |
|
|
864
|
+
| **`latitude`** | <code>number</code> | The latitude of the reference location. | 0.0.1 |
|
|
865
|
+
| **`longitude`** | <code>number</code> | The longitude of the reference location. | 0.0.1 |
|
|
865
866
|
|
|
866
867
|
|
|
867
868
|
#### GetGPSPointsInBoundingBoxResult
|
|
868
869
|
|
|
869
870
|
| Prop | Type | Description | Since |
|
|
870
871
|
| ------------ | ----------------------- | --------------------------------------- | ----- |
|
|
871
|
-
| **`points`** | <code>GPSPoint[]</code> | The GPS points within the bounding box. |
|
|
872
|
+
| **`points`** | <code>GPSPoint[]</code> | The GPS points within the bounding box. | 0.0.1 |
|
|
872
873
|
|
|
873
874
|
|
|
874
875
|
#### GetGPSPointsInBoundingBoxOptions
|
|
875
876
|
|
|
876
877
|
| Prop | Type | Description | Since |
|
|
877
878
|
| ------------------ | ------------------- | ------------------------------------------ | ----- |
|
|
878
|
-
| **`minLatitude`** | <code>number</code> | The minimum latitude of the bounding box. |
|
|
879
|
-
| **`minLongitude`** | <code>number</code> | The minimum longitude of the bounding box. |
|
|
880
|
-
| **`maxLatitude`** | <code>number</code> | The maximum latitude of the bounding box. |
|
|
881
|
-
| **`maxLongitude`** | <code>number</code> | The maximum longitude of the bounding box. |
|
|
879
|
+
| **`minLatitude`** | <code>number</code> | The minimum latitude of the bounding box. | 0.0.1 |
|
|
880
|
+
| **`minLongitude`** | <code>number</code> | The minimum longitude of the bounding box. | 0.0.1 |
|
|
881
|
+
| **`maxLatitude`** | <code>number</code> | The maximum latitude of the bounding box. | 0.0.1 |
|
|
882
|
+
| **`maxLongitude`** | <code>number</code> | The maximum longitude of the bounding box. | 0.0.1 |
|
|
882
883
|
|
|
883
884
|
|
|
884
885
|
#### GetNearbyBeaconsResult
|
|
885
886
|
|
|
886
887
|
| Prop | Type | Description | Since |
|
|
887
888
|
| -------------- | ---------------------- | -------------------------------------------- | ----- |
|
|
888
|
-
| **`contexts`** | <code>Context[]</code> | The contexts associated with nearby beacons. |
|
|
889
|
+
| **`contexts`** | <code>Context[]</code> | The contexts associated with nearby beacons. | 0.0.1 |
|
|
889
890
|
|
|
890
891
|
|
|
891
892
|
#### SetNotificationsSupportOptions
|
|
892
893
|
|
|
893
894
|
| Prop | Type | Description | Since |
|
|
894
895
|
| ------------- | -------------------- | ------------------------------------------------ | ----- |
|
|
895
|
-
| **`enabled`** | <code>boolean</code> | Whether notifications support should be enabled. |
|
|
896
|
+
| **`enabled`** | <code>boolean</code> | Whether notifications support should be enabled. | 0.0.1 |
|
|
896
897
|
|
|
897
898
|
|
|
898
899
|
#### SetInterfaceLanguageOptions
|
|
899
900
|
|
|
900
901
|
| Prop | Type | Description | Since |
|
|
901
902
|
| -------------- | ------------------- | ------------------------- | ----- |
|
|
902
|
-
| **`language`** | <code>string</code> | The language code to set. |
|
|
903
|
+
| **`language`** | <code>string</code> | The language code to set. | 0.0.1 |
|
|
903
904
|
|
|
904
905
|
|
|
905
906
|
#### CreateARViewOptions
|
|
906
907
|
|
|
907
908
|
| Prop | Type | Description | Since |
|
|
908
909
|
| ------------ | ------------------- | ------------------------------ | ----- |
|
|
909
|
-
| **`x`** | <code>number</code> | The x position of the AR view. |
|
|
910
|
-
| **`y`** | <code>number</code> | The y position of the AR view. |
|
|
911
|
-
| **`width`** | <code>number</code> | The width of the AR view. |
|
|
912
|
-
| **`height`** | <code>number</code> | The height of the AR view. |
|
|
910
|
+
| **`x`** | <code>number</code> | The x position of the AR view. | 0.0.1 |
|
|
911
|
+
| **`y`** | <code>number</code> | The y position of the AR view. | 0.0.1 |
|
|
912
|
+
| **`width`** | <code>number</code> | The width of the AR view. | 0.0.1 |
|
|
913
|
+
| **`height`** | <code>number</code> | The height of the AR view. | 0.0.1 |
|
|
913
914
|
|
|
914
915
|
|
|
915
916
|
#### ResizeARViewOptions
|
|
916
917
|
|
|
917
918
|
| Prop | Type | Description | Since |
|
|
918
919
|
| ------------ | ------------------- | ---------------------------------- | ----- |
|
|
919
|
-
| **`x`** | <code>number</code> | The new x position of the AR view. |
|
|
920
|
-
| **`y`** | <code>number</code> | The new y position of the AR view. |
|
|
921
|
-
| **`width`** | <code>number</code> | The new width of the AR view. |
|
|
922
|
-
| **`height`** | <code>number</code> | The new height of the AR view. |
|
|
920
|
+
| **`x`** | <code>number</code> | The new x position of the AR view. | 0.0.1 |
|
|
921
|
+
| **`y`** | <code>number</code> | The new y position of the AR view. | 0.0.1 |
|
|
922
|
+
| **`width`** | <code>number</code> | The new width of the AR view. | 0.0.1 |
|
|
923
|
+
| **`height`** | <code>number</code> | The new height of the AR view. | 0.0.1 |
|
|
923
924
|
|
|
924
925
|
|
|
925
926
|
#### SetARViewTouchEnabledOptions
|
|
926
927
|
|
|
927
928
|
| Prop | Type | Description | Since |
|
|
928
929
|
| ------------- | -------------------- | ---------------------------------------------------------- | ----- |
|
|
929
|
-
| **`enabled`** | <code>boolean</code> | Whether touch events should be intercepted by the AR view. |
|
|
930
|
+
| **`enabled`** | <code>boolean</code> | Whether touch events should be intercepted by the AR view. | 0.0.1 |
|
|
930
931
|
|
|
931
932
|
|
|
932
933
|
#### SetARViewTouchHoleOptions
|
|
933
934
|
|
|
934
935
|
| Prop | Type | Description | Since |
|
|
935
936
|
| ------------ | ------------------- | ----------------------------------------------- | ----- |
|
|
936
|
-
| **`top`** | <code>number</code> | The top coordinate of the touch hole region. |
|
|
937
|
-
| **`bottom`** | <code>number</code> | The bottom coordinate of the touch hole region. |
|
|
938
|
-
| **`left`** | <code>number</code> | The left coordinate of the touch hole region. |
|
|
939
|
-
| **`right`** | <code>number</code> | The right coordinate of the touch hole region. |
|
|
937
|
+
| **`top`** | <code>number</code> | The top coordinate of the touch hole region. | 0.0.1 |
|
|
938
|
+
| **`bottom`** | <code>number</code> | The bottom coordinate of the touch hole region. | 0.0.1 |
|
|
939
|
+
| **`left`** | <code>number</code> | The left coordinate of the touch hole region. | 0.0.1 |
|
|
940
|
+
| **`right`** | <code>number</code> | The right coordinate of the touch hole region. | 0.0.1 |
|
|
940
941
|
|
|
941
942
|
|
|
942
943
|
#### GetVersionResult
|
|
943
944
|
|
|
944
945
|
| Prop | Type | Description | Since |
|
|
945
946
|
| ------------- | ------------------- | ----------------------- | ----- |
|
|
946
|
-
| **`version`** | <code>string</code> | The version of the sdk. |
|
|
947
|
+
| **`version`** | <code>string</code> | The version of the sdk. | 0.0.1 |
|
|
947
948
|
|
|
948
949
|
|
|
949
950
|
#### PluginListenerHandle
|
|
@@ -957,44 +958,44 @@ Remove all listeners for this plugin.
|
|
|
957
958
|
|
|
958
959
|
| Prop | Type | Description | Since |
|
|
959
960
|
| ---------- | ------------------- | ----------------------------- | ----- |
|
|
960
|
-
| **`code`** | <code>string</code> | The scanned code value. |
|
|
961
|
-
| **`type`** | <code>string</code> | The type of the scanned code. |
|
|
961
|
+
| **`code`** | <code>string</code> | The scanned code value. | 0.0.1 |
|
|
962
|
+
| **`type`** | <code>string</code> | The type of the scanned code. | 0.0.1 |
|
|
962
963
|
|
|
963
964
|
|
|
964
965
|
#### EnterContextEvent
|
|
965
966
|
|
|
966
967
|
| Prop | Type | Description | Since |
|
|
967
968
|
| --------------- | ------------------- | ------------------------------ | ----- |
|
|
968
|
-
| **`contextId`** | <code>string</code> | The ID of the entered context. |
|
|
969
|
+
| **`contextId`** | <code>string</code> | The ID of the entered context. | 0.0.1 |
|
|
969
970
|
|
|
970
971
|
|
|
971
972
|
#### ExitContextEvent
|
|
972
973
|
|
|
973
974
|
| Prop | Type | Description | Since |
|
|
974
975
|
| --------------- | ------------------- | ----------------------------- | ----- |
|
|
975
|
-
| **`contextId`** | <code>string</code> | The ID of the exited context. |
|
|
976
|
+
| **`contextId`** | <code>string</code> | The ID of the exited context. | 0.0.1 |
|
|
976
977
|
|
|
977
978
|
|
|
978
979
|
#### EventFromContentEvent
|
|
979
980
|
|
|
980
981
|
| Prop | Type | Description | Since |
|
|
981
982
|
| ------------ | ------------------- | ----------------------------------- | ----- |
|
|
982
|
-
| **`name`** | <code>string</code> | The name of the custom event. |
|
|
983
|
-
| **`params`** | <code>string</code> | The parameters of the custom event. |
|
|
983
|
+
| **`name`** | <code>string</code> | The name of the custom event. | 0.0.1 |
|
|
984
|
+
| **`params`** | <code>string</code> | The parameters of the custom event. | 0.0.1 |
|
|
984
985
|
|
|
985
986
|
|
|
986
987
|
#### SyncProgressEvent
|
|
987
988
|
|
|
988
989
|
| Prop | Type | Description | Since |
|
|
989
990
|
| -------------- | ------------------- | -------------------------------------------- | ----- |
|
|
990
|
-
| **`progress`** | <code>number</code> | The sync progress value between 0.0 and 1.0. |
|
|
991
|
+
| **`progress`** | <code>number</code> | The sync progress value between 0.0 and 1.0. | 0.0.1 |
|
|
991
992
|
|
|
992
993
|
|
|
993
994
|
#### RequireSyncEvent
|
|
994
995
|
|
|
995
996
|
| Prop | Type | Description | Since |
|
|
996
997
|
| ---------- | --------------------- | -------------------------------------- | ----- |
|
|
997
|
-
| **`tags`** | <code>string[]</code> | The tags that require synchronization. |
|
|
998
|
+
| **`tags`** | <code>string[]</code> | The tags that require synchronization. | 0.0.1 |
|
|
998
999
|
|
|
999
1000
|
|
|
1000
1001
|
### Type Aliases
|