@capawesome/capacitor-pixlive 0.1.2 → 0.1.4

package/dist/esm/definitions.d.ts

@@ -1,10 +1,10 @@
 import type { PermissionState, PluginListenerHandle } from '@capacitor/core';
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export type PixlivePermissionType = 'bluetooth' | 'bluetoothConnect' | 'bluetoothScan' | 'camera' | 'location' | 'notifications';
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface PixlivePlugin {
     /**
@@ -14,19 +14,19 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     initialize(): Promise<void>;
     /**
      * Check the status of permissions.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     checkPermissions(): Promise<PermissionStatus>;
     /**
      * Request permissions.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     requestPermissions(options?: PixlivePluginPermission): Promise<PermissionStatus>;
     /**
@@ -34,7 +34,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     synchronize(options: SynchronizeOptions): Promise<void>;
     /**
@@ -42,7 +42,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     synchronizeWithToursAndContexts(options: SynchronizeWithToursAndContextsOptions): Promise<void>;
     /**
@@ -50,7 +50,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     updateTagMapping(options: UpdateTagMappingOptions): Promise<void>;
     /**
@@ -58,7 +58,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     enableContextsWithTags(options: EnableContextsWithTagsOptions): Promise<void>;
     /**
@@ -66,7 +66,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     getContexts(): Promise<GetContextsResult>;
     /**
@@ -74,7 +74,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     getContext(options: GetContextOptions): Promise<GetContextResult>;
     /**
@@ -82,7 +82,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     activateContext(options: ActivateContextOptions): Promise<void>;
     /**
@@ -90,7 +90,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     stopContext(): Promise<void>;
     /**
@@ -98,7 +98,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     getNearbyGPSPoints(options: GetNearbyGPSPointsOptions): Promise<GetNearbyGPSPointsResult>;
     /**
@@ -106,7 +106,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     getGPSPointsInBoundingBox(options: GetGPSPointsInBoundingBoxOptions): Promise<GetGPSPointsInBoundingBoxResult>;
     /**
@@ -114,7 +114,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     getNearbyBeacons(): Promise<GetNearbyBeaconsResult>;
     /**
@@ -122,7 +122,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     startNearbyGPSDetection(): Promise<void>;
     /**
@@ -130,7 +130,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     stopNearbyGPSDetection(): Promise<void>;
     /**
@@ -138,7 +138,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     startGPSNotifications(): Promise<void>;
     /**
@@ -146,7 +146,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     stopGPSNotifications(): Promise<void>;
     /**
@@ -154,7 +154,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     setNotificationsSupport(options: SetNotificationsSupportOptions): Promise<void>;
     /**
@@ -162,7 +162,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     setInterfaceLanguage(options: SetInterfaceLanguageOptions): Promise<void>;
     /**
@@ -170,7 +170,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     createARView(options: CreateARViewOptions): Promise<void>;
     /**
@@ -178,7 +178,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     destroyARView(): Promise<void>;
     /**
@@ -186,7 +186,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     resizeARView(options: ResizeARViewOptions): Promise<void>;
     /**
@@ -194,7 +194,7 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     setARViewTouchEnabled(options: SetARViewTouchEnabledOptions): Promise<void>;
     /**
@@ -202,330 +202,330 @@ export interface PixlivePlugin {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     setARViewTouchHole(options: SetARViewTouchHoleOptions): Promise<void>;
     /**
      * Get the version of the sdk.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     getVersion(): Promise<GetVersionResult>;
     /**
      * Called when a QR code or barcode is scanned by the AR camera.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     addListener(eventName: 'codeRecognize', listenerFunc: (event: CodeRecognizeEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Called when an AR context is detected/entered.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     addListener(eventName: 'enterContext', listenerFunc: (event: EnterContextEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Called when an AR context is lost/exited.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     addListener(eventName: 'exitContext', listenerFunc: (event: ExitContextEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Called when AR content/annotations become visible on screen.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     addListener(eventName: 'presentAnnotations', listenerFunc: () => void): Promise<PluginListenerHandle>;
     /**
      * Called when AR content/annotations are hidden.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     addListener(eventName: 'hideAnnotations', listenerFunc: () => void): Promise<PluginListenerHandle>;
     /**
      * Called when AR content dispatches a custom event.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     addListener(eventName: 'eventFromContent', listenerFunc: (event: EventFromContentEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Called during synchronization with progress updates.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     addListener(eventName: 'syncProgress', listenerFunc: (event: SyncProgressEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Called when the SDK requires synchronization with specific tags.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     addListener(eventName: 'requireSync', listenerFunc: (event: RequireSyncEvent) => void): Promise<PluginListenerHandle>;
     /**
      * Remove all listeners for this plugin.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     removeAllListeners(): Promise<void>;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface SynchronizeOptions {
     /**
      * The tags to filter content by.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     tags: string[][];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface SynchronizeWithToursAndContextsOptions {
     /**
      * The tags to filter content by.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     tags: string[][];
     /**
      * The tour IDs to sync.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     tourIds: number[];
     /**
      * The context IDs to sync.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     contextIds: string[];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface UpdateTagMappingOptions {
     /**
      * The tags to map.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     tags: string[];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface EnableContextsWithTagsOptions {
     /**
      * The tags to enable contexts for.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     tags: string[];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface GetContextOptions {
     /**
      * The ID of the context to retrieve.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      * @example "12345"
      */
     contextId: string;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface ActivateContextOptions {
     /**
      * The ID of the context to activate.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      * @example "12345"
      */
     contextId: string;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface GetNearbyGPSPointsOptions {
     /**
      * The latitude of the reference location.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     latitude: number;
     /**
      * The longitude of the reference location.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     longitude: number;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface GetGPSPointsInBoundingBoxOptions {
     /**
      * The minimum latitude of the bounding box.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     minLatitude: number;
     /**
      * The minimum longitude of the bounding box.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     minLongitude: number;
     /**
      * The maximum latitude of the bounding box.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     maxLatitude: number;
     /**
      * The maximum longitude of the bounding box.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     maxLongitude: number;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface SetNotificationsSupportOptions {
     /**
      * Whether notifications support should be enabled.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     enabled: boolean;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface SetInterfaceLanguageOptions {
     /**
      * The language code to set.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      * @example "en"
      */
     language: string;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface CreateARViewOptions {
     /**
      * The x position of the AR view.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     x: number;
     /**
      * The y position of the AR view.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     y: number;
     /**
      * The width of the AR view.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     width: number;
     /**
      * The height of the AR view.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     height: number;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface ResizeARViewOptions {
     /**
      * The new x position of the AR view.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     x: number;
     /**
      * The new y position of the AR view.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     y: number;
     /**
      * The new width of the AR view.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     width: number;
     /**
      * The new height of the AR view.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     height: number;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface SetARViewTouchEnabledOptions {
     /**
      * Whether touch events should be intercepted by the AR view.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     enabled: boolean;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface SetARViewTouchHoleOptions {
     /**
      * The top coordinate of the touch hole region.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     top: number;
     /**
      * The bottom coordinate of the touch hole region.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     bottom: number;
     /**
      * The left coordinate of the touch hole region.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     left: number;
     /**
      * The right coordinate of the touch hole region.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     right: number;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface PixlivePluginPermission {
     /**
      * The permissions to request.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     permissions: PixlivePermissionType[];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface PermissionStatus {
     /**
@@ -533,7 +533,7 @@ export interface PermissionStatus {
      *
      * Only available on iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     bluetooth?: PermissionState;
     /**
@@ -541,7 +541,7 @@ export interface PermissionStatus {
      *
      * Only available on Android.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     bluetoothConnect?: PermissionState;
     /**
@@ -549,13 +549,13 @@ export interface PermissionStatus {
      *
      * Only available on Android.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     bluetoothScan?: PermissionState;
     /**
      * Permission state of the Camera permission.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     camera: PermissionState;
     /**
@@ -563,263 +563,269 @@ export interface PermissionStatus {
      *
      * Only available on Android and iOS.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     location?: PermissionState;
     /**
      * Permission state of the Notifications permission.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     notifications?: PermissionState;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface GetContextsResult {
     /**
      * The list of synchronized contexts.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     contexts: Context[];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface GetContextResult {
     /**
      * The context.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     context: Context;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface GetNearbyBeaconsResult {
     /**
      * The contexts associated with nearby beacons.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     contexts: Context[];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface GetNearbyGPSPointsResult {
     /**
      * The nearby GPS points sorted by distance.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     points: GPSPoint[];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface GetGPSPointsInBoundingBoxResult {
     /**
      * The GPS points within the bounding box.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     points: GPSPoint[];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface Context {
     /**
      * The unique identifier of the context.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     contextId: string;
     /**
      * The name of the context.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     name: string;
     /**
      * The description of the context.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     description: string | null;
     /**
      * The last update timestamp.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     lastUpdate: string;
     /**
      * The URL of the thumbnail image.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     imageThumbnailURL: string | null;
     /**
      * The URL of the high-resolution image.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     imageHiResURL: string | null;
     /**
      * The notification title.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     notificationTitle: string | null;
     /**
      * The notification message.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     notificationMessage: string | null;
     /**
      * The tags associated with the context.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     tags: string[];
+    /**
+     * The languages provided for this context.
+     *
+     * @since 0.1.3
+     */
+    languages: string[];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface GPSPoint {
     /**
      * The ID of the associated context.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     contextId: string;
     /**
      * The category of the GPS point.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     category: string;
     /**
      * The label of the GPS point.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     label: string;
     /**
      * The latitude of the GPS point.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     latitude: number;
     /**
      * The longitude of the GPS point.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     longitude: number;
     /**
      * The detection radius in meters.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     detectionRadius: number | null;
     /**
      * The distance from the current position in meters.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     distanceFromCurrentPosition: number;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface CodeRecognizeEvent {
     /**
      * The scanned code value.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     code: string;
     /**
      * The type of the scanned code.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     type: string;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface EnterContextEvent {
     /**
      * The ID of the entered context.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     contextId: string;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface ExitContextEvent {
     /**
      * The ID of the exited context.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     contextId: string;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface EventFromContentEvent {
     /**
      * The name of the custom event.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     name: string;
     /**
      * The parameters of the custom event.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     params: string;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface SyncProgressEvent {
     /**
      * The sync progress value between 0.0 and 1.0.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     progress: number;
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface RequireSyncEvent {
     /**
      * The tags that require synchronization.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     tags: string[];
 }
 /**
- * @since 8.0.0
+ * @since 0.0.1
  */
 export interface GetVersionResult {
     /**
      * The version of the sdk.
      *
-     * @since 8.0.0
+     * @since 0.0.1
      */
     version: string;
 }