@capawesome/capacitor-pixlive 0.1.2 → 0.1.4
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.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\n/**\n * @since 8.0.0\n */\nexport type PixlivePermissionType =\n | 'bluetooth'\n | 'bluetoothConnect'\n | 'bluetoothScan'\n | 'camera'\n | 'location'\n | 'notifications';\n\n/**\n * @since 8.0.0\n */\nexport interface PixlivePlugin {\n /**\n * Initialize the PixLive SDK.\n *\n * This must be called before any other method.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n initialize(): Promise<void>;\n /**\n * Check the status of permissions.\n *\n * @since 8.0.0\n */\n checkPermissions(): Promise<PermissionStatus>;\n /**\n * Request permissions.\n *\n * @since 8.0.0\n */\n requestPermissions(\n options?: PixlivePluginPermission,\n ): Promise<PermissionStatus>;\n /**\n * Sync content from PixLive Maker filtered by tags.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n synchronize(options: SynchronizeOptions): Promise<void>;\n /**\n * Sync content filtered by tags, tour IDs, and context IDs.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n synchronizeWithToursAndContexts(\n options: SynchronizeWithToursAndContextsOptions,\n ): Promise<void>;\n /**\n * Update tag-to-context mappings for language filtering.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n updateTagMapping(options: UpdateTagMappingOptions): Promise<void>;\n /**\n * Enable only contexts matching specific tags.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n enableContextsWithTags(options: EnableContextsWithTagsOptions): Promise<void>;\n /**\n * Get all synchronized contexts.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n getContexts(): Promise<GetContextsResult>;\n /**\n * Get a single context by ID.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n getContext(options: GetContextOptions): Promise<GetContextResult>;\n /**\n * Programmatically trigger/activate a context.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n activateContext(options: ActivateContextOptions): Promise<void>;\n /**\n * Stop the currently playing/active context.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n stopContext(): Promise<void>;\n /**\n * Get GPS points near a given location, sorted by distance.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n getNearbyGPSPoints(\n options: GetNearbyGPSPointsOptions,\n ): Promise<GetNearbyGPSPointsResult>;\n /**\n * Get all GPS points within a geographic bounding box.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n getGPSPointsInBoundingBox(\n options: GetGPSPointsInBoundingBoxOptions,\n ): Promise<GetGPSPointsInBoundingBoxResult>;\n /**\n * Get contexts associated with nearby detected beacons.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n getNearbyBeacons(): Promise<GetNearbyBeaconsResult>;\n /**\n * Start background GPS proximity detection.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n startNearbyGPSDetection(): Promise<void>;\n /**\n * Stop background GPS proximity detection.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n stopNearbyGPSDetection(): Promise<void>;\n /**\n * Enable GPS-triggered local notifications.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n startGPSNotifications(): Promise<void>;\n /**\n * Disable GPS-triggered local notifications.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n stopGPSNotifications(): Promise<void>;\n /**\n * Enable or disable notification support.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n setNotificationsSupport(\n options: SetNotificationsSupportOptions,\n ): Promise<void>;\n /**\n * Set the language for SDK UI elements.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n setInterfaceLanguage(options: SetInterfaceLanguageOptions): Promise<void>;\n /**\n * Create the native AR camera view at specified screen coordinates.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n createARView(options: CreateARViewOptions): Promise<void>;\n /**\n * Destroy the AR camera view.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n destroyARView(): Promise<void>;\n /**\n * Resize the AR view.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n resizeARView(options: ResizeARViewOptions): Promise<void>;\n /**\n * Enable or disable touch event interception on the AR view.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n setARViewTouchEnabled(options: SetARViewTouchEnabledOptions): Promise<void>;\n /**\n * Define a rectangular region where touches pass through the AR view to the web layer.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n setARViewTouchHole(options: SetARViewTouchHoleOptions): Promise<void>;\n /**\n * Get the version of the sdk.\n *\n * @since 8.0.0\n */\n getVersion(): Promise<GetVersionResult>;\n /**\n * Called when a QR code or barcode is scanned by the AR camera.\n *\n * @since 8.0.0\n */\n addListener(\n eventName: 'codeRecognize',\n listenerFunc: (event: CodeRecognizeEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when an AR context is detected/entered.\n *\n * @since 8.0.0\n */\n addListener(\n eventName: 'enterContext',\n listenerFunc: (event: EnterContextEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when an AR context is lost/exited.\n *\n * @since 8.0.0\n */\n addListener(\n eventName: 'exitContext',\n listenerFunc: (event: ExitContextEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when AR content/annotations become visible on screen.\n *\n * @since 8.0.0\n */\n addListener(\n eventName: 'presentAnnotations',\n listenerFunc: () => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when AR content/annotations are hidden.\n *\n * @since 8.0.0\n */\n addListener(\n eventName: 'hideAnnotations',\n listenerFunc: () => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when AR content dispatches a custom event.\n *\n * @since 8.0.0\n */\n addListener(\n eventName: 'eventFromContent',\n listenerFunc: (event: EventFromContentEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called during synchronization with progress updates.\n *\n * @since 8.0.0\n */\n addListener(\n eventName: 'syncProgress',\n listenerFunc: (event: SyncProgressEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when the SDK requires synchronization with specific tags.\n *\n * @since 8.0.0\n */\n addListener(\n eventName: 'requireSync',\n listenerFunc: (event: RequireSyncEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Remove all listeners for this plugin.\n *\n * @since 8.0.0\n */\n removeAllListeners(): Promise<void>;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface SynchronizeOptions {\n /**\n * The tags to filter content by.\n *\n * @since 8.0.0\n */\n tags: string[][];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface SynchronizeWithToursAndContextsOptions {\n /**\n * The tags to filter content by.\n *\n * @since 8.0.0\n */\n tags: string[][];\n /**\n * The tour IDs to sync.\n *\n * @since 8.0.0\n */\n tourIds: number[];\n /**\n * The context IDs to sync.\n *\n * @since 8.0.0\n */\n contextIds: string[];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface UpdateTagMappingOptions {\n /**\n * The tags to map.\n *\n * @since 8.0.0\n */\n tags: string[];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface EnableContextsWithTagsOptions {\n /**\n * The tags to enable contexts for.\n *\n * @since 8.0.0\n */\n tags: string[];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface GetContextOptions {\n /**\n * The ID of the context to retrieve.\n *\n * @since 8.0.0\n * @example \"12345\"\n */\n contextId: string;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface ActivateContextOptions {\n /**\n * The ID of the context to activate.\n *\n * @since 8.0.0\n * @example \"12345\"\n */\n contextId: string;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface GetNearbyGPSPointsOptions {\n /**\n * The latitude of the reference location.\n *\n * @since 8.0.0\n */\n latitude: number;\n /**\n * The longitude of the reference location.\n *\n * @since 8.0.0\n */\n longitude: number;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface GetGPSPointsInBoundingBoxOptions {\n /**\n * The minimum latitude of the bounding box.\n *\n * @since 8.0.0\n */\n minLatitude: number;\n /**\n * The minimum longitude of the bounding box.\n *\n * @since 8.0.0\n */\n minLongitude: number;\n /**\n * The maximum latitude of the bounding box.\n *\n * @since 8.0.0\n */\n maxLatitude: number;\n /**\n * The maximum longitude of the bounding box.\n *\n * @since 8.0.0\n */\n maxLongitude: number;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface SetNotificationsSupportOptions {\n /**\n * Whether notifications support should be enabled.\n *\n * @since 8.0.0\n */\n enabled: boolean;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface SetInterfaceLanguageOptions {\n /**\n * The language code to set.\n *\n * @since 8.0.0\n * @example \"en\"\n */\n language: string;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface CreateARViewOptions {\n /**\n * The x position of the AR view.\n *\n * @since 8.0.0\n */\n x: number;\n /**\n * The y position of the AR view.\n *\n * @since 8.0.0\n */\n y: number;\n /**\n * The width of the AR view.\n *\n * @since 8.0.0\n */\n width: number;\n /**\n * The height of the AR view.\n *\n * @since 8.0.0\n */\n height: number;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface ResizeARViewOptions {\n /**\n * The new x position of the AR view.\n *\n * @since 8.0.0\n */\n x: number;\n /**\n * The new y position of the AR view.\n *\n * @since 8.0.0\n */\n y: number;\n /**\n * The new width of the AR view.\n *\n * @since 8.0.0\n */\n width: number;\n /**\n * The new height of the AR view.\n *\n * @since 8.0.0\n */\n height: number;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface SetARViewTouchEnabledOptions {\n /**\n * Whether touch events should be intercepted by the AR view.\n *\n * @since 8.0.0\n */\n enabled: boolean;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface SetARViewTouchHoleOptions {\n /**\n * The top coordinate of the touch hole region.\n *\n * @since 8.0.0\n */\n top: number;\n /**\n * The bottom coordinate of the touch hole region.\n *\n * @since 8.0.0\n */\n bottom: number;\n /**\n * The left coordinate of the touch hole region.\n *\n * @since 8.0.0\n */\n left: number;\n /**\n * The right coordinate of the touch hole region.\n *\n * @since 8.0.0\n */\n right: number;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface PixlivePluginPermission {\n /**\n * The permissions to request.\n *\n * @since 8.0.0\n */\n permissions: PixlivePermissionType[];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface PermissionStatus {\n /**\n * Permission state of the Bluetooth permission.\n *\n * Only available on iOS.\n *\n * @since 8.0.0\n */\n bluetooth?: PermissionState;\n /**\n * Permission state of the Bluetooth Connect permission.\n *\n * Only available on Android.\n *\n * @since 8.0.0\n */\n bluetoothConnect?: PermissionState;\n /**\n * Permission state of the Bluetooth Scan permission.\n *\n * Only available on Android.\n *\n * @since 8.0.0\n */\n bluetoothScan?: PermissionState;\n /**\n * Permission state of the Camera permission.\n *\n * @since 8.0.0\n */\n camera: PermissionState;\n /**\n * Permission state of the Location permission.\n *\n * Only available on Android and iOS.\n *\n * @since 8.0.0\n */\n location?: PermissionState;\n /**\n * Permission state of the Notifications permission.\n *\n * @since 8.0.0\n */\n notifications?: PermissionState;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface GetContextsResult {\n /**\n * The list of synchronized contexts.\n *\n * @since 8.0.0\n */\n contexts: Context[];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface GetContextResult {\n /**\n * The context.\n *\n * @since 8.0.0\n */\n context: Context;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface GetNearbyBeaconsResult {\n /**\n * The contexts associated with nearby beacons.\n *\n * @since 8.0.0\n */\n contexts: Context[];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface GetNearbyGPSPointsResult {\n /**\n * The nearby GPS points sorted by distance.\n *\n * @since 8.0.0\n */\n points: GPSPoint[];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface GetGPSPointsInBoundingBoxResult {\n /**\n * The GPS points within the bounding box.\n *\n * @since 8.0.0\n */\n points: GPSPoint[];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface Context {\n /**\n * The unique identifier of the context.\n *\n * @since 8.0.0\n */\n contextId: string;\n /**\n * The name of the context.\n *\n * @since 8.0.0\n */\n name: string;\n /**\n * The description of the context.\n *\n * @since 8.0.0\n */\n description: string | null;\n /**\n * The last update timestamp.\n *\n * @since 8.0.0\n */\n lastUpdate: string;\n /**\n * The URL of the thumbnail image.\n *\n * @since 8.0.0\n */\n imageThumbnailURL: string | null;\n /**\n * The URL of the high-resolution image.\n *\n * @since 8.0.0\n */\n imageHiResURL: string | null;\n /**\n * The notification title.\n *\n * @since 8.0.0\n */\n notificationTitle: string | null;\n /**\n * The notification message.\n *\n * @since 8.0.0\n */\n notificationMessage: string | null;\n /**\n * The tags associated with the context.\n *\n * @since 8.0.0\n */\n tags: string[];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface GPSPoint {\n /**\n * The ID of the associated context.\n *\n * @since 8.0.0\n */\n contextId: string;\n /**\n * The category of the GPS point.\n *\n * @since 8.0.0\n */\n category: string;\n /**\n * The label of the GPS point.\n *\n * @since 8.0.0\n */\n label: string;\n /**\n * The latitude of the GPS point.\n *\n * @since 8.0.0\n */\n latitude: number;\n /**\n * The longitude of the GPS point.\n *\n * @since 8.0.0\n */\n longitude: number;\n /**\n * The detection radius in meters.\n *\n * @since 8.0.0\n */\n detectionRadius: number | null;\n /**\n * The distance from the current position in meters.\n *\n * @since 8.0.0\n */\n distanceFromCurrentPosition: number;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface CodeRecognizeEvent {\n /**\n * The scanned code value.\n *\n * @since 8.0.0\n */\n code: string;\n /**\n * The type of the scanned code.\n *\n * @since 8.0.0\n */\n type: string;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface EnterContextEvent {\n /**\n * The ID of the entered context.\n *\n * @since 8.0.0\n */\n contextId: string;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface ExitContextEvent {\n /**\n * The ID of the exited context.\n *\n * @since 8.0.0\n */\n contextId: string;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface EventFromContentEvent {\n /**\n * The name of the custom event.\n *\n * @since 8.0.0\n */\n name: string;\n /**\n * The parameters of the custom event.\n *\n * @since 8.0.0\n */\n params: string;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface SyncProgressEvent {\n /**\n * The sync progress value between 0.0 and 1.0.\n *\n * @since 8.0.0\n */\n progress: number;\n}\n\n/**\n * @since 8.0.0\n */\nexport interface RequireSyncEvent {\n /**\n * The tags that require synchronization.\n *\n * @since 8.0.0\n */\n tags: string[];\n}\n\n/**\n * @since 8.0.0\n */\nexport interface GetVersionResult {\n /**\n * The version of the sdk.\n *\n * @since 8.0.0\n */\n version: string;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\n/**\n * @since 0.0.1\n */\nexport type PixlivePermissionType =\n | 'bluetooth'\n | 'bluetoothConnect'\n | 'bluetoothScan'\n | 'camera'\n | 'location'\n | 'notifications';\n\n/**\n * @since 0.0.1\n */\nexport interface PixlivePlugin {\n /**\n * Initialize the PixLive SDK.\n *\n * This must be called before any other method.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n initialize(): Promise<void>;\n /**\n * Check the status of permissions.\n *\n * @since 0.0.1\n */\n checkPermissions(): Promise<PermissionStatus>;\n /**\n * Request permissions.\n *\n * @since 0.0.1\n */\n requestPermissions(\n options?: PixlivePluginPermission,\n ): Promise<PermissionStatus>;\n /**\n * Sync content from PixLive Maker filtered by tags.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n synchronize(options: SynchronizeOptions): Promise<void>;\n /**\n * Sync content filtered by tags, tour IDs, and context IDs.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n synchronizeWithToursAndContexts(\n options: SynchronizeWithToursAndContextsOptions,\n ): Promise<void>;\n /**\n * Update tag-to-context mappings for language filtering.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n updateTagMapping(options: UpdateTagMappingOptions): Promise<void>;\n /**\n * Enable only contexts matching specific tags.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n enableContextsWithTags(options: EnableContextsWithTagsOptions): Promise<void>;\n /**\n * Get all synchronized contexts.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n getContexts(): Promise<GetContextsResult>;\n /**\n * Get a single context by ID.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n getContext(options: GetContextOptions): Promise<GetContextResult>;\n /**\n * Programmatically trigger/activate a context.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n activateContext(options: ActivateContextOptions): Promise<void>;\n /**\n * Stop the currently playing/active context.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n stopContext(): Promise<void>;\n /**\n * Get GPS points near a given location, sorted by distance.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n getNearbyGPSPoints(\n options: GetNearbyGPSPointsOptions,\n ): Promise<GetNearbyGPSPointsResult>;\n /**\n * Get all GPS points within a geographic bounding box.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n getGPSPointsInBoundingBox(\n options: GetGPSPointsInBoundingBoxOptions,\n ): Promise<GetGPSPointsInBoundingBoxResult>;\n /**\n * Get contexts associated with nearby detected beacons.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n getNearbyBeacons(): Promise<GetNearbyBeaconsResult>;\n /**\n * Start background GPS proximity detection.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n startNearbyGPSDetection(): Promise<void>;\n /**\n * Stop background GPS proximity detection.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n stopNearbyGPSDetection(): Promise<void>;\n /**\n * Enable GPS-triggered local notifications.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n startGPSNotifications(): Promise<void>;\n /**\n * Disable GPS-triggered local notifications.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n stopGPSNotifications(): Promise<void>;\n /**\n * Enable or disable notification support.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n setNotificationsSupport(\n options: SetNotificationsSupportOptions,\n ): Promise<void>;\n /**\n * Set the language for SDK UI elements.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n setInterfaceLanguage(options: SetInterfaceLanguageOptions): Promise<void>;\n /**\n * Create the native AR camera view at specified screen coordinates.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n createARView(options: CreateARViewOptions): Promise<void>;\n /**\n * Destroy the AR camera view.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n destroyARView(): Promise<void>;\n /**\n * Resize the AR view.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n resizeARView(options: ResizeARViewOptions): Promise<void>;\n /**\n * Enable or disable touch event interception on the AR view.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n setARViewTouchEnabled(options: SetARViewTouchEnabledOptions): Promise<void>;\n /**\n * Define a rectangular region where touches pass through the AR view to the web layer.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n setARViewTouchHole(options: SetARViewTouchHoleOptions): Promise<void>;\n /**\n * Get the version of the sdk.\n *\n * @since 0.0.1\n */\n getVersion(): Promise<GetVersionResult>;\n /**\n * Called when a QR code or barcode is scanned by the AR camera.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'codeRecognize',\n listenerFunc: (event: CodeRecognizeEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when an AR context is detected/entered.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'enterContext',\n listenerFunc: (event: EnterContextEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when an AR context is lost/exited.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'exitContext',\n listenerFunc: (event: ExitContextEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when AR content/annotations become visible on screen.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'presentAnnotations',\n listenerFunc: () => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when AR content/annotations are hidden.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'hideAnnotations',\n listenerFunc: () => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when AR content dispatches a custom event.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'eventFromContent',\n listenerFunc: (event: EventFromContentEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called during synchronization with progress updates.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'syncProgress',\n listenerFunc: (event: SyncProgressEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Called when the SDK requires synchronization with specific tags.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'requireSync',\n listenerFunc: (event: RequireSyncEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Remove all listeners for this plugin.\n *\n * @since 0.0.1\n */\n removeAllListeners(): Promise<void>;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface SynchronizeOptions {\n /**\n * The tags to filter content by.\n *\n * @since 0.0.1\n */\n tags: string[][];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface SynchronizeWithToursAndContextsOptions {\n /**\n * The tags to filter content by.\n *\n * @since 0.0.1\n */\n tags: string[][];\n /**\n * The tour IDs to sync.\n *\n * @since 0.0.1\n */\n tourIds: number[];\n /**\n * The context IDs to sync.\n *\n * @since 0.0.1\n */\n contextIds: string[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface UpdateTagMappingOptions {\n /**\n * The tags to map.\n *\n * @since 0.0.1\n */\n tags: string[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface EnableContextsWithTagsOptions {\n /**\n * The tags to enable contexts for.\n *\n * @since 0.0.1\n */\n tags: string[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetContextOptions {\n /**\n * The ID of the context to retrieve.\n *\n * @since 0.0.1\n * @example \"12345\"\n */\n contextId: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface ActivateContextOptions {\n /**\n * The ID of the context to activate.\n *\n * @since 0.0.1\n * @example \"12345\"\n */\n contextId: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetNearbyGPSPointsOptions {\n /**\n * The latitude of the reference location.\n *\n * @since 0.0.1\n */\n latitude: number;\n /**\n * The longitude of the reference location.\n *\n * @since 0.0.1\n */\n longitude: number;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetGPSPointsInBoundingBoxOptions {\n /**\n * The minimum latitude of the bounding box.\n *\n * @since 0.0.1\n */\n minLatitude: number;\n /**\n * The minimum longitude of the bounding box.\n *\n * @since 0.0.1\n */\n minLongitude: number;\n /**\n * The maximum latitude of the bounding box.\n *\n * @since 0.0.1\n */\n maxLatitude: number;\n /**\n * The maximum longitude of the bounding box.\n *\n * @since 0.0.1\n */\n maxLongitude: number;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface SetNotificationsSupportOptions {\n /**\n * Whether notifications support should be enabled.\n *\n * @since 0.0.1\n */\n enabled: boolean;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface SetInterfaceLanguageOptions {\n /**\n * The language code to set.\n *\n * @since 0.0.1\n * @example \"en\"\n */\n language: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface CreateARViewOptions {\n /**\n * The x position of the AR view.\n *\n * @since 0.0.1\n */\n x: number;\n /**\n * The y position of the AR view.\n *\n * @since 0.0.1\n */\n y: number;\n /**\n * The width of the AR view.\n *\n * @since 0.0.1\n */\n width: number;\n /**\n * The height of the AR view.\n *\n * @since 0.0.1\n */\n height: number;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface ResizeARViewOptions {\n /**\n * The new x position of the AR view.\n *\n * @since 0.0.1\n */\n x: number;\n /**\n * The new y position of the AR view.\n *\n * @since 0.0.1\n */\n y: number;\n /**\n * The new width of the AR view.\n *\n * @since 0.0.1\n */\n width: number;\n /**\n * The new height of the AR view.\n *\n * @since 0.0.1\n */\n height: number;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface SetARViewTouchEnabledOptions {\n /**\n * Whether touch events should be intercepted by the AR view.\n *\n * @since 0.0.1\n */\n enabled: boolean;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface SetARViewTouchHoleOptions {\n /**\n * The top coordinate of the touch hole region.\n *\n * @since 0.0.1\n */\n top: number;\n /**\n * The bottom coordinate of the touch hole region.\n *\n * @since 0.0.1\n */\n bottom: number;\n /**\n * The left coordinate of the touch hole region.\n *\n * @since 0.0.1\n */\n left: number;\n /**\n * The right coordinate of the touch hole region.\n *\n * @since 0.0.1\n */\n right: number;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface PixlivePluginPermission {\n /**\n * The permissions to request.\n *\n * @since 0.0.1\n */\n permissions: PixlivePermissionType[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface PermissionStatus {\n /**\n * Permission state of the Bluetooth permission.\n *\n * Only available on iOS.\n *\n * @since 0.0.1\n */\n bluetooth?: PermissionState;\n /**\n * Permission state of the Bluetooth Connect permission.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n bluetoothConnect?: PermissionState;\n /**\n * Permission state of the Bluetooth Scan permission.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n bluetoothScan?: PermissionState;\n /**\n * Permission state of the Camera permission.\n *\n * @since 0.0.1\n */\n camera: PermissionState;\n /**\n * Permission state of the Location permission.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n location?: PermissionState;\n /**\n * Permission state of the Notifications permission.\n *\n * @since 0.0.1\n */\n notifications?: PermissionState;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetContextsResult {\n /**\n * The list of synchronized contexts.\n *\n * @since 0.0.1\n */\n contexts: Context[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetContextResult {\n /**\n * The context.\n *\n * @since 0.0.1\n */\n context: Context;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetNearbyBeaconsResult {\n /**\n * The contexts associated with nearby beacons.\n *\n * @since 0.0.1\n */\n contexts: Context[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetNearbyGPSPointsResult {\n /**\n * The nearby GPS points sorted by distance.\n *\n * @since 0.0.1\n */\n points: GPSPoint[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetGPSPointsInBoundingBoxResult {\n /**\n * The GPS points within the bounding box.\n *\n * @since 0.0.1\n */\n points: GPSPoint[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface Context {\n /**\n * The unique identifier of the context.\n *\n * @since 0.0.1\n */\n contextId: string;\n /**\n * The name of the context.\n *\n * @since 0.0.1\n */\n name: string;\n /**\n * The description of the context.\n *\n * @since 0.0.1\n */\n description: string | null;\n /**\n * The last update timestamp.\n *\n * @since 0.0.1\n */\n lastUpdate: string;\n /**\n * The URL of the thumbnail image.\n *\n * @since 0.0.1\n */\n imageThumbnailURL: string | null;\n /**\n * The URL of the high-resolution image.\n *\n * @since 0.0.1\n */\n imageHiResURL: string | null;\n /**\n * The notification title.\n *\n * @since 0.0.1\n */\n notificationTitle: string | null;\n /**\n * The notification message.\n *\n * @since 0.0.1\n */\n notificationMessage: string | null;\n /**\n * The tags associated with the context.\n *\n * @since 0.0.1\n */\n tags: string[];\n /**\n * The languages provided for this context.\n *\n * @since 0.1.3\n */\n languages: string[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GPSPoint {\n /**\n * The ID of the associated context.\n *\n * @since 0.0.1\n */\n contextId: string;\n /**\n * The category of the GPS point.\n *\n * @since 0.0.1\n */\n category: string;\n /**\n * The label of the GPS point.\n *\n * @since 0.0.1\n */\n label: string;\n /**\n * The latitude of the GPS point.\n *\n * @since 0.0.1\n */\n latitude: number;\n /**\n * The longitude of the GPS point.\n *\n * @since 0.0.1\n */\n longitude: number;\n /**\n * The detection radius in meters.\n *\n * @since 0.0.1\n */\n detectionRadius: number | null;\n /**\n * The distance from the current position in meters.\n *\n * @since 0.0.1\n */\n distanceFromCurrentPosition: number;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface CodeRecognizeEvent {\n /**\n * The scanned code value.\n *\n * @since 0.0.1\n */\n code: string;\n /**\n * The type of the scanned code.\n *\n * @since 0.0.1\n */\n type: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface EnterContextEvent {\n /**\n * The ID of the entered context.\n *\n * @since 0.0.1\n */\n contextId: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface ExitContextEvent {\n /**\n * The ID of the exited context.\n *\n * @since 0.0.1\n */\n contextId: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface EventFromContentEvent {\n /**\n * The name of the custom event.\n *\n * @since 0.0.1\n */\n name: string;\n /**\n * The parameters of the custom event.\n *\n * @since 0.0.1\n */\n params: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface SyncProgressEvent {\n /**\n * The sync progress value between 0.0 and 1.0.\n *\n * @since 0.0.1\n */\n progress: number;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface RequireSyncEvent {\n /**\n * The tags that require synchronization.\n *\n * @since 0.0.1\n */\n tags: string[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetVersionResult {\n /**\n * The version of the sdk.\n *\n * @since 0.0.1\n */\n version: string;\n}\n"]}
|