Skip to main content

useBackgroundSync

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

Kind: React hook
Package: @ovok/native

Import​

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

TypeScript signatures​

({ enabled: initialEnabled, canEnable, onEnabledChange, }?: UseBackgroundSyncOptions): { enabled: boolean; setEnabled: (enabled: boolean) => Promise<void>; status: BackgroundSyncStatus; reason?: string; error?: Error; }
ParameterTypeDetails
__0UseBackgroundSyncOptions—

Returns: { enabled: boolean; setEnabled: (enabled: boolean) => Promise<void>; status: BackgroundSyncStatus; reason?: string; error?: Error; }.

Learn the workflow​

Continue with Bluetooth for the workflow context and examples.

Source​

View the declaration in the SDK source.