Skip to main content

BTProviderProps

No behavioral description is attached to this declaration. The public signature, parameter and return types, and source location below document its published contract.

Kind: Interface
Package: @ovok/native

Import​

import { BTProviderProps } from '@ovok/native/bt-management';

TypeScript shape​

interface BTProviderProps<T extends readonly AcceptedDevice[]> extends BTProviderChildWrapperProps<T> {
onAccessPermissionChanged?: (accessPermission: boolean) => void;
permissionFallback?: (permission: BTProviderPermissionFallbackProps) => React.ReactNode;
gateOnPermission?: boolean;
}

This is a type-level export; it has no call parameters.

Public members​

MemberTypeDetails
onAccessPermissionChanged(accessPermission: boolean) => voidOptional. —
permissionFallback(permission: BTProviderPermissionFallbackProps) => React.ReactNodeOptional. Callback to be called when the access permission is not granted and the user is asked to open the settings
gateOnPermissionbooleanOptional. Keep children mounted while permission is pending or denied when false (default).
bleManagerBleManager—
acceptedDevicesT—
permissionStatusBluetoothPermissionStatusOptional. —
oneReadingPerConnectionbooleanOptional. —
deliveredEcgFileNamesreadonly string[]Optional. —
deliveredFileNamesreadonly string[]Optional. —
clearDeviceHistorybooleanOptional. Clear supported device history after it has been downloaded.
resultPoliciesPartial<Record<string, DeviceResultPolicy>>Optional. —
clockSyncClockSyncOptionsOptional. —
autoConnectbooleanOptional. —
autoConnectDelayMsnumberOptional. —
onDeviceSelectionRequired(selection: { devices: readonly BTDeviceSelection[]; select: (device: BTDeviceSelection) => Promise<void>; }) => voidOptional. —
backgroundSyncBackgroundSyncOptions<DeviceKeyOf<T>>Optional. —
onDeviceFound(device: BTManagedDevice<DeviceKeyOf<T>>, manager: BTManager<T>) => Promise<void>Optional. —
onError(data: ErrorCallback) => voidOptional. —
onDeviceStatusChanged(data: DeviceStatusChangeCallback) => voidOptional. —
onConnectionEvent(data: DeviceConnectionEvent) => voidOptional. —
onResult(data: ResultCallback<DeviceKeyOf<T>>) => voidOptional. —

Learn the workflow​

Continue with Bluetooth for the workflow context and examples.

Source​

View the declaration in the SDK source.