AppleHealthSyncProps

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

Kind: Type alias
Package: @ovok/native

Import

import { AppleHealthSyncProps } from '@ovok/native/data-sync';

TypeScript shape

type AppleHealthSyncProps = HealthSyncProps<HKSampleTypeIdentifier> & {
    backgroundDelivery?: {
        frequency?: HKUpdateFrequency;
    };
};

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

Public members

Member	Type	Details
dataToSync	{ [key in HealthSyncKey]?: { typeIdentifiers: { typeIdentifier: T; code?: ObservationCode | string; system?: string; display?: string; }[]; minDate?: Date; mode?: HealthDataMode; }; }	—
chunkSize	number	Optional. The chunk size for sync, if not provided, it will be 5000. This is the number of samples to sync at a time.
wifiOnly	boolean	Optional. Restrict health reads to Wi-Fi. By default any connected network is accepted. When the device is offline, the progress reason is always offline; when this option pauses cellular data, it is wifi-only.
onError	(error: Bundle<Resource> | Error | null) => void	Optional. —
onProgress	(progress: { [key in HealthSyncKey]?: SyncProgress; }) => void	Optional. —
backgroundDelivery	{ frequency?: HKUpdateFrequency; }	Optional. Enables HealthKit observer delivery while the app is in the background.

Learn the workflow

Continue with Health Data for the workflow context and examples.

Source

View the declaration in the SDK source.