diff --git a/README.md b/README.md index 9fe714b..94bcbf4 100644 --- a/README.md +++ b/README.md @@ -1773,7 +1773,9 @@ setupLocatorSdkConfig({license: 'xxx', sdkVersion: '2.0.1'}); App version >= TBD -Check if the SDK is configured. Wrapper for `getState`. +Check if the SDK is configured. Wrapper for `getState`. See SDK type +`LocatorState`: +https://datamob.gitbook.io/doc-locator/TQfkVhcPsZiXIvXxq8Bv/english/service#id-4.4.5-getstate-locatorstate ```ts getLocatorSdkState: () => Promise<{state: string}>; @@ -1783,17 +1785,21 @@ getLocatorSdkState: () => Promise<{state: string}>; App version >= TBD -Start real-time sharing or SOS. Wrapper for `setSdkMode`. +Start real-time sharing or SOS. Wrapper for `setSdkMode`. See SDK type +`LocatorSdkMode`: +https://datamob.gitbook.io/doc-locator/TQfkVhcPsZiXIvXxq8Bv/english/service#id-4.5.3-setsdkmode-mode-locatorsdkmode-void ```ts -setLocatorSdkMode: (mode: 'default' | 'observed' | 'sos' | string) => Promise; +setLocatorSdkMode: (mode: string) => Promise; ``` ### getLocatorJwtToken App version >= TBD -Get JWT token for map backend auth. Wrapper for `getJwtToken`. +Get JWT token for map backend auth. Wrapper for `getJwtToken`. See SDK return +contract: +https://datamob.gitbook.io/doc-locator/TQfkVhcPsZiXIvXxq8Bv/english/service#id-4.4.9-getjwttoken-string ```ts getLocatorJwtToken: () => Promise<{token: string}>; @@ -1803,38 +1809,20 @@ getLocatorJwtToken: () => Promise<{token: string}>; App version >= TBD -Get pending permissions. Wrapper for `pendingPermissions`. +Get pending permissions. Wrapper for `pendingPermissions`. See SDK type +`LocatorPermission`: +https://datamob.gitbook.io/doc-locator/TQfkVhcPsZiXIvXxq8Bv/english/service#id-4.4.10-pendingpermissions-locatorpermission ```ts getLocatorPendingPermissions: () => Promise<{permissions: Array}>; ``` -#### Permission identifiers - -Android - -- `location_fine` -- `location_coarse` -- `location_background` -- `activity_recognition` -- `body_sensors` -- `battery_optimization` -- `foreground_service` -- `foreground_service_location` -- `access_network_state` - -iOS - -- `location_in_use` -- `location_background` -- `motion_usage` -- `fall_detection` - ### getLocatorSdkVersion App version >= TBD -Get SDK version. Wrapper for `getVersion`. +Get SDK version. Wrapper for `getVersion`. See SDK return contract: +https://datamob.gitbook.io/doc-locator/TQfkVhcPsZiXIvXxq8Bv/english/service#id-4.4.8-getversion-string ```ts getLocatorSdkVersion: () => Promise<{version: string}>; @@ -1844,33 +1832,37 @@ getLocatorSdkVersion: () => Promise<{version: string}>; App version >= TBD -Get SDK session. Wrapper for `getSession`. +Get SDK session. Wrapper for `getSession`. See SDK type `LocatorSession`: +https://datamob.gitbook.io/doc-locator/TQfkVhcPsZiXIvXxq8Bv/english/service#id-4.4.7-getsession-locatorsession ```ts -getLocatorSdkSession: () => Promise<{ - session: { - id: string; - startAt: number; - endAt: number | null; - }; -}>; +getLocatorSdkSession: () => + Promise<{ + session: { + id: string; + startAt: number; + endAt: number | null; + }; + }>; ``` ### getLocatorSdkMode App version >= TBD -Get current SDK mode. Wrapper for `getSdkMode`. +Get current SDK mode. Wrapper for `getSdkMode`. See SDK type `LocatorSdkMode`: +https://datamob.gitbook.io/doc-locator/TQfkVhcPsZiXIvXxq8Bv/english/service#id-4.4.6-getsdkmode-locatorsdkmode ```ts -getLocatorSdkMode: () => Promise<{mode: 'default' | 'observed' | 'sos' | string}>; +getLocatorSdkMode: () => Promise<{mode: string}>; ``` ### getLocatorSdkConfig App version >= TBD -Get current SDK config. Wrapper for `getConfig`. +Get current SDK config. Wrapper for `getConfig`. See SDK type `LocatorConfig`: +https://datamob.gitbook.io/doc-locator/TQfkVhcPsZiXIvXxq8Bv/english/service#id-4.4.1-getconfig-locatorconfig ```ts getLocatorSdkConfig: () => Promise<{config: LocatorSdkConfig | null}>; diff --git a/src/family-locator.ts b/src/family-locator.ts index 8c4623b..f7625b0 100644 --- a/src/family-locator.ts +++ b/src/family-locator.ts @@ -2,7 +2,7 @@ import {postMessageToNativeApp} from './post-message'; // Family Locator SDK webview bridge methods. -export type LocatorSdkMode = 'default' | 'observed' | 'sos' | string; +export type LocatorSdkMode = string; export type LocatorSdkConfig = { license: string; diff --git a/src/post-message.ts b/src/post-message.ts index 8dcd04e..d3f2d19 100644 --- a/src/post-message.ts +++ b/src/post-message.ts @@ -539,7 +539,7 @@ export type ResponsesFromNativeApp = { GET_LOCATOR_SDK_MODE: { type: 'GET_LOCATOR_SDK_MODE'; id: string; - payload: {mode: 'default' | 'observed' | 'sos' | string}; + payload: {mode: string}; }; GET_LOCATOR_SDK_CONFIG: { type: 'GET_LOCATOR_SDK_CONFIG';