@ovok/native/data-sync

Apple Health and Health Connect import: authorization, sync progress and manual request UI.

Import from @ovok/native/data-sync.

ComponentsCopy Anchor Link

SyncProgressListCopy Anchor Link

const SyncProgressList: MemoExoticComponent<(__namedParameters) => Element>;

Lists the sync progress of each data type with its status.

DataSync()Copy Anchor Link

function DataSync(__namedParameters): Element;

Namespace for the health data sync components; renders its children.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Element

HooksCopy Anchor Link

useHealthAuthorization()Copy Anchor Link

function useHealthAuthorization(): HealthAuthorizationValue;

Returns the health authorization state; must be used inside an Apple Health or Health Connect authorization provider.

ReturnsCopy Anchor Link

HealthAuthorizationValue

ClassesCopy Anchor Link

HealthSyncBatchErrorCopy Anchor Link

Error of a health import batch that did not save every entry, carrying the server response.

ExtendsCopy Anchor Link

• Error

ConstructorsCopy Anchor Link

ConstructorCopy Anchor Link

new HealthSyncBatchError(
   message,
   bundle?,
   outcome?
): HealthSyncBatchError;

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

HealthSyncBatchError

OverridesCopy Anchor Link

Error.constructor

PropertiesCopy Anchor Link

FunctionsCopy Anchor Link

getHealthDataCoding()Copy Anchor Link

function getHealthDataCoding(
   provider,
   identifier,
   mode
): object;

Returns the coding for a health platform identifier and data mode.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

getHealthDataMode()Copy Anchor Link

function getHealthDataMode(key, configuredMode?): HealthDataMode;

Returns the configured mode, or the default mode of the data type.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

HealthDataMode

toHealthSyncError()Copy Anchor Link

function toHealthSyncError(error): Error;

Converts a failed batch response or error into an Error, keeping the bundle or outcome.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Error

Type AliasesCopy Anchor Link

AndroidHealthConnectAuthorizationStatusCopy Anchor Link

type AndroidHealthConnectAuthorizationStatus = object;

Health Connect authorization state.

PropertiesCopy Anchor Link

backgroundAccess?Copy Anchor Link

backgroundAccess?: "authorized" | "shouldRequest" | "refused" | "unsupported";

Background access is reported independently; it never blocks foreground import.

error?Copy Anchor Link

error?: Error;

Error of the last authorization attempt.

missingTypes?Copy Anchor Link

missingTypes?: readonly string[];

Record types that still need authorization.

stateCopy Anchor Link

state:
  | "unknown"
  | "shouldRequest"
  | "requesting"
  | "authorized"
  | "refused"
  | "error";

Current authorization stage.

AndroidHealthSyncPropsCopy Anchor Link

type AndroidHealthSyncProps = HealthSyncProps<RecordType>;

Props of AndroidHealthSync.

AppleHealthAuthorizationStatusCopy Anchor Link

type AppleHealthAuthorizationStatus = object;

Apple Health authorization state.

PropertiesCopy Anchor Link

error?Copy Anchor Link

error?: Error;

Error of the last authorization attempt.

notRequestedMeasurementTypesCopy Anchor Link

notRequestedMeasurementTypes: HealthSyncKey[];

Configured measurement types with at least one unanswered read identifier.

notRequestedReadIdentifiersCopy Anchor Link

notRequestedReadIdentifiers: AppleHealthDataTypeIdentifier[];

HealthKit types that still need to be answered in Settings.

notRequestedWriteIdentifiersCopy Anchor Link

notRequestedWriteIdentifiers: SampleTypeIdentifierWriteable[];

HealthKit write types that still need to be answered in Settings.

stateCopy Anchor Link

state: "unknown" | "shouldRequest" | "requesting" | "ready" | "error";

Current authorization stage.

AppleHealthDataTypeIdentifierCopy Anchor Link

type AppleHealthDataTypeIdentifier = SampleTypeIdentifier;

HealthKit sample type identifiers supported by the SDK.

AppleHealthSyncPropsCopy Anchor Link

type AppleHealthSyncProps = HealthSyncProps<AppleHealthDataTypeIdentifier> & object;

Props of AppleHealthSync.

Type DeclarationCopy Anchor Link

HealthAuthorizationValueCopy Anchor Link

type HealthAuthorizationValue =
  | {
  missingTypes: readonly string[];
  platform: "apple-health";
  request: () => Promise<void>;
  status: AppleHealthAuthorizationStatus;
}
  | {
  missingTypes: readonly string[];
  platform: "health-connect";
  request: () => Promise<void>;
  status: AndroidHealthConnectAuthorizationStatus;
};

Authorization state and request action of the active health platform.

Union MembersCopy Anchor Link

Type LiteralCopy Anchor Link

{
  missingTypes: readonly string[];
  platform: "apple-health";
  request: () => Promise<void>;
  status: AppleHealthAuthorizationStatus;
}

Type LiteralCopy Anchor Link

{
  missingTypes: readonly string[];
  platform: "health-connect";
  request: () => Promise<void>;
  status: AndroidHealthConnectAuthorizationStatus;
}

HealthDataModeCopy Anchor Link

type HealthDataMode = "point" | "daily-total" | "daily-summary" | "session" | "series";

How a data type is turned into observations.

HealthSyncKeyCopy Anchor Link

type HealthSyncKey = HealthSyncKeys | HealthDataType;

Measurement type or health-only data type that can be synced.

HealthSyncKeysCopy Anchor Link

type HealthSyncKeys = Exclude<MeasurementTypeKey,
  | MeasurementTypeKey.photoUpload
| MeasurementTypeKey.symptomQuestionnaire>;

Measurement types that can be synced, excluding photo upload and symptom questionnaire.

SyncPauseReasonCopy Anchor Link

type SyncPauseReason = "offline" | "wifi-only";

Why a sync is paused.

SyncProgressCopy Anchor Link

type SyncProgress = object;

Sync state of one data type.

PropertiesCopy Anchor Link

measurementTypeKeyCopy Anchor Link

measurementTypeKey: HealthSyncKey;

Data type being synced.

progress?Copy Anchor Link

progress?: object;

Records processed so far.

created?Copy Anchor Link

created?: number;

Number of observations created instead of matched or updated.

doneCopy Anchor Link

done: number;

Records processed.

totalCopy Anchor Link

total: number;

Records to process.

reason?Copy Anchor Link

reason?: SyncPauseReason;

Why the sync is paused.

statusCopy Anchor Link

status: "started" | "completed" | "failed" | "idle" | "syncing" | "paused";

Current sync stage.

SyncProgressListPropsCopy Anchor Link

type SyncProgressListProps = object;

Props of SyncProgressList.

PropertiesCopy Anchor Link

labelForType?Copy Anchor Link

labelForType?: (type) => string;

Returns the display label of a data type.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

string

progressCopy Anchor Link

progress:
  | Partial<Record<string, SyncProgress>>
  | null
  | undefined;

Sync progress per data type.

reasonLabels?Copy Anchor Link

reasonLabels?: Partial<Record<NonNullable<SyncProgress["reason"]>, string>>;

Overrides the pause reason texts.

statusLabels?Copy Anchor Link

statusLabels?: Partial<Record<SyncProgress["status"], string>>;

Overrides the status texts.

Text?Copy Anchor Link

Text?: React.ComponentType<React.ComponentProps<typeof PaperText>>;

Text component used to render labels.

EnumerationsCopy Anchor Link

HealthDataTypeCopy Anchor Link

Health data that is not represented by a core measurement service.

Enumeration MembersCopy Anchor Link

VariablesCopy Anchor Link

HEALTH_DATA_CATALOGCopy Anchor Link

const HEALTH_DATA_CATALOG: readonly HealthDataCatalogEntry[];

Supported Apple Health and Health Connect data types with their LOINC mappings.

HealthAuthorizationContextCopy Anchor Link

const HealthAuthorizationContext: Context<HealthAuthorizationValue | null>;

Context carrying the health authorization state.

ReferencesCopy Anchor Link

HealthImportAdapterCopy Anchor Link

Re-exports HealthImportAdapter

useHealthImportCopy Anchor Link

Re-exports useHealthImport