628 lines
16 KiB
JSON
628 lines
16 KiB
JSON
{
|
|
"api": {
|
|
"name": "DumonGeolocationPlugin",
|
|
"slug": "dumongeolocationplugin",
|
|
"docs": "",
|
|
"tags": [],
|
|
"methods": [
|
|
{
|
|
"name": "startPositioning",
|
|
"signature": "() => Promise<void>",
|
|
"parameters": [],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "startpositioning"
|
|
},
|
|
{
|
|
"name": "stopPositioning",
|
|
"signature": "() => Promise<void>",
|
|
"parameters": [],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "stoppositioning"
|
|
},
|
|
{
|
|
"name": "getLatestPosition",
|
|
"signature": "() => Promise<PositioningData>",
|
|
"parameters": [],
|
|
"returns": "Promise<PositioningData>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [
|
|
"PositioningData"
|
|
],
|
|
"slug": "getlatestposition"
|
|
},
|
|
{
|
|
"name": "checkAndRequestPermissions",
|
|
"signature": "() => Promise<PermissionStatus>",
|
|
"parameters": [],
|
|
"returns": "Promise<PermissionStatus>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [
|
|
"PermissionStatus"
|
|
],
|
|
"slug": "checkandrequestpermissions"
|
|
},
|
|
{
|
|
"name": "setOptions",
|
|
"signature": "(options: DumonGeoOptions) => Promise<void>",
|
|
"parameters": [
|
|
{
|
|
"name": "options",
|
|
"docs": "",
|
|
"type": "DumonGeoOptions"
|
|
}
|
|
],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [
|
|
"DumonGeoOptions"
|
|
],
|
|
"slug": "setoptions"
|
|
},
|
|
{
|
|
"name": "getGnssStatus",
|
|
"signature": "() => Promise<SatelliteStatus | null>",
|
|
"parameters": [],
|
|
"returns": "Promise<SatelliteStatus | null>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [
|
|
"SatelliteStatus"
|
|
],
|
|
"slug": "getgnssstatus"
|
|
},
|
|
{
|
|
"name": "getLocationServicesStatus",
|
|
"signature": "() => Promise<{ gpsEnabled: boolean; networkEnabled: boolean; }>",
|
|
"parameters": [],
|
|
"returns": "Promise<{ gpsEnabled: boolean; networkEnabled: boolean; }>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "getlocationservicesstatus"
|
|
},
|
|
{
|
|
"name": "startBackgroundTracking",
|
|
"signature": "(options?: { title?: string | undefined; text?: string | undefined; channelId?: string | undefined; channelName?: string | undefined; postUrl?: string | undefined; } | undefined) => Promise<void>",
|
|
"parameters": [
|
|
{
|
|
"name": "options",
|
|
"docs": "",
|
|
"type": "{ title?: string | undefined; text?: string | undefined; channelId?: string | undefined; channelName?: string | undefined; postUrl?: string | undefined; } | undefined"
|
|
}
|
|
],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "startbackgroundtracking"
|
|
},
|
|
{
|
|
"name": "stopBackgroundTracking",
|
|
"signature": "() => Promise<void>",
|
|
"parameters": [],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "stopbackgroundtracking"
|
|
},
|
|
{
|
|
"name": "isBackgroundTrackingActive",
|
|
"signature": "() => Promise<{ active: boolean; }>",
|
|
"parameters": [],
|
|
"returns": "Promise<{ active: boolean; }>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "isbackgroundtrackingactive"
|
|
},
|
|
{
|
|
"name": "getBackgroundLatestPosition",
|
|
"signature": "() => Promise<PositioningData | null>",
|
|
"parameters": [],
|
|
"returns": "Promise<PositioningData | null>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [
|
|
"PositioningData"
|
|
],
|
|
"slug": "getbackgroundlatestposition"
|
|
},
|
|
{
|
|
"name": "openBackgroundPermissionSettings",
|
|
"signature": "() => Promise<void>",
|
|
"parameters": [],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "openbackgroundpermissionsettings"
|
|
},
|
|
{
|
|
"name": "openNotificationPermissionSettings",
|
|
"signature": "() => Promise<void>",
|
|
"parameters": [],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "opennotificationpermissionsettings"
|
|
},
|
|
{
|
|
"name": "setAuthTokens",
|
|
"signature": "(tokens: { accessToken: string; refreshToken: string; }) => Promise<void>",
|
|
"parameters": [
|
|
{
|
|
"name": "tokens",
|
|
"docs": "",
|
|
"type": "{ accessToken: string; refreshToken: string; }"
|
|
}
|
|
],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "setauthtokens"
|
|
},
|
|
{
|
|
"name": "clearAuthTokens",
|
|
"signature": "() => Promise<void>",
|
|
"parameters": [],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "clearauthtokens"
|
|
},
|
|
{
|
|
"name": "getAuthState",
|
|
"signature": "() => Promise<{ present: boolean; }>",
|
|
"parameters": [],
|
|
"returns": "Promise<{ present: boolean; }>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "getauthstate"
|
|
},
|
|
{
|
|
"name": "setBackgroundPostUrl",
|
|
"signature": "(options: { url?: string; }) => Promise<void>",
|
|
"parameters": [
|
|
{
|
|
"name": "options",
|
|
"docs": "",
|
|
"type": "{ url?: string | undefined; }"
|
|
}
|
|
],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "setbackgroundposturl"
|
|
},
|
|
{
|
|
"name": "getBackgroundPostUrl",
|
|
"signature": "() => Promise<{ url: string | null; }>",
|
|
"parameters": [],
|
|
"returns": "Promise<{ url: string | null; }>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "getbackgroundposturl"
|
|
},
|
|
{
|
|
"name": "configureEdgeToEdge",
|
|
"signature": "(options: { bgColor: string; style: 'DARK' | 'LIGHT'; overlay?: boolean; }) => Promise<void>",
|
|
"parameters": [
|
|
{
|
|
"name": "options",
|
|
"docs": "",
|
|
"type": "{ bgColor: string; style: 'DARK' | 'LIGHT'; overlay?: boolean | undefined; }"
|
|
}
|
|
],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "configureedgetoedge"
|
|
},
|
|
{
|
|
"name": "setGpsMode",
|
|
"signature": "(options: { mode: 'normal' | 'driving'; }) => Promise<void>",
|
|
"parameters": [
|
|
{
|
|
"name": "options",
|
|
"docs": "",
|
|
"type": "{ mode: 'normal' | 'driving'; }"
|
|
}
|
|
],
|
|
"returns": "Promise<void>",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"slug": "setgpsmode"
|
|
},
|
|
{
|
|
"name": "addListener",
|
|
"signature": "(eventName: 'onPositionUpdate', listenerFunc: (data: PositioningData) => void) => PluginListenerHandle",
|
|
"parameters": [
|
|
{
|
|
"name": "eventName",
|
|
"docs": "",
|
|
"type": "'onPositionUpdate'"
|
|
},
|
|
{
|
|
"name": "listenerFunc",
|
|
"docs": "",
|
|
"type": "(data: PositioningData) => void"
|
|
}
|
|
],
|
|
"returns": "PluginListenerHandle",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [
|
|
"PluginListenerHandle",
|
|
"PositioningData"
|
|
],
|
|
"slug": "addlisteneronpositionupdate-"
|
|
},
|
|
{
|
|
"name": "addListener",
|
|
"signature": "(eventName: 'onGnssStatus', listenerFunc: (data: SatelliteStatus) => void) => PluginListenerHandle",
|
|
"parameters": [
|
|
{
|
|
"name": "eventName",
|
|
"docs": "",
|
|
"type": "'onGnssStatus'"
|
|
},
|
|
{
|
|
"name": "listenerFunc",
|
|
"docs": "",
|
|
"type": "(data: SatelliteStatus) => void"
|
|
}
|
|
],
|
|
"returns": "PluginListenerHandle",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [
|
|
"PluginListenerHandle",
|
|
"SatelliteStatus"
|
|
],
|
|
"slug": "addlistenerongnssstatus-"
|
|
}
|
|
],
|
|
"properties": []
|
|
},
|
|
"interfaces": [
|
|
{
|
|
"name": "PositioningData",
|
|
"slug": "positioningdata",
|
|
"docs": "",
|
|
"tags": [],
|
|
"methods": [],
|
|
"properties": [
|
|
{
|
|
"name": "source",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "'GNSS' | 'WIFI' | 'FUSED' | 'MOCK'"
|
|
},
|
|
{
|
|
"name": "timestamp",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number"
|
|
},
|
|
{
|
|
"name": "latitude",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number"
|
|
},
|
|
{
|
|
"name": "longitude",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number"
|
|
},
|
|
{
|
|
"name": "accuracy",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number"
|
|
},
|
|
{
|
|
"name": "speed",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number"
|
|
},
|
|
{
|
|
"name": "acceleration",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number"
|
|
},
|
|
{
|
|
"name": "directionRad",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number"
|
|
},
|
|
{
|
|
"name": "isMocked",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "mode",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "'normal' | 'driving'"
|
|
},
|
|
{
|
|
"name": "predicted",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "boolean | undefined"
|
|
},
|
|
{
|
|
"name": "speedSource",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "'GNSS' | 'IMU' | 'DELTA' | 'NONE' | undefined"
|
|
},
|
|
{
|
|
"name": "speedGnss",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "speedImu",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "speedDerived",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "PermissionStatus",
|
|
"slug": "permissionstatus",
|
|
"docs": "",
|
|
"tags": [],
|
|
"methods": [],
|
|
"properties": [
|
|
{
|
|
"name": "location",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "'granted' | 'denied'"
|
|
},
|
|
{
|
|
"name": "wifi",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "'granted' | 'denied'"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "DumonGeoOptions",
|
|
"slug": "dumongeooptions",
|
|
"docs": "",
|
|
"tags": [],
|
|
"methods": [],
|
|
"properties": [
|
|
{
|
|
"name": "distanceThresholdMeters",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "speedChangeThreshold",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "directionChangeThreshold",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "emitDebounceMs",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "drivingEmitIntervalMs",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "wifiScanIntervalMs",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "enableWifiRtt",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "boolean | undefined"
|
|
},
|
|
{
|
|
"name": "enableLogging",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "boolean | undefined"
|
|
},
|
|
{
|
|
"name": "enableForwardPrediction",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "boolean | undefined"
|
|
},
|
|
{
|
|
"name": "maxPredictionSeconds",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "emitGnssStatus",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "boolean | undefined"
|
|
},
|
|
{
|
|
"name": "suppressMockedUpdates",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "boolean | undefined"
|
|
},
|
|
{
|
|
"name": "keepScreenOn",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "boolean | undefined"
|
|
},
|
|
{
|
|
"name": "backgroundPollingIntervalMs",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "backgroundPostMinDistanceMeters",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "backgroundPostMinAccuracyMeters",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "backgroundMinPostIntervalMs",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number | undefined"
|
|
},
|
|
{
|
|
"name": "backgroundUseImuFallback",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "boolean | undefined"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "SatelliteStatus",
|
|
"slug": "satellitestatus",
|
|
"docs": "",
|
|
"tags": [],
|
|
"methods": [],
|
|
"properties": [
|
|
{
|
|
"name": "satellitesInView",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number"
|
|
},
|
|
{
|
|
"name": "usedInFix",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "number"
|
|
},
|
|
{
|
|
"name": "constellationCounts",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "{ [key: string]: number; }"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "PluginListenerHandle",
|
|
"slug": "pluginlistenerhandle",
|
|
"docs": "",
|
|
"tags": [],
|
|
"methods": [],
|
|
"properties": [
|
|
{
|
|
"name": "remove",
|
|
"tags": [],
|
|
"docs": "",
|
|
"complexTypes": [],
|
|
"type": "() => Promise<void>"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"enums": [],
|
|
"typeAliases": [],
|
|
"pluginConfigs": []
|
|
} |