Skip to main content

useRedeemPatientSharingInvite

Redeems a patient-sharing invite and returns the resulting share.

When to use it​

Use the typed redemption payload from the invite flow and handle expiration or access errors.

Setup​

Call it from a client-side React component below OvokProvider so it uses the client configured at that provider boundary.

Hook arguments​

The hook takes no configuration arguments. Call mutate(payload) when the user or workflow is ready to run the operation; the payload and result types are shown below.

TypeScript signature​

(): OvokMutationState<RedeemPatientSharingInvite, PatientSharingShare>

Mutation state​

The operation runs only when you call mutate(payload). The payload type is RedeemPatientSharingInvite; the returned promise and data carry PatientSharingShare.

FieldMeaning
dataLatest successful result, or undefined before success.
loadingWhether the mutation is running.
errorNormalized Error from the latest failure.
mutateStarts the operation, resolves with its result, and rejects on failure.
resetClears mutation data and error state.

Request behavior​

The mutation is explicit: collect and validate the input in your UI, disable repeated submission while loading is true, handle the rejected promise, and render error near the action.

Example​

Call the mutation from an event handler and show its error beside the action.

import { useRedeemPatientSharingInvite } from '@ovok/core';

type Input = Parameters<ReturnType<typeof useRedeemPatientSharingInvite>['mutate']>[0];

export function RedeemPatientSharingInviteExample({ input }: { input: Input }) {
  const { mutate, loading, error } = useRedeemPatientSharingInvite();
  async function submit() {
    try { await mutate(input); } catch { /* The hook exposes the error below. */ }
  }
  return <section>
    <button disabled={loading} onClick={() => void submit()}>Submit</button>
    {error && <p role="alert">{error.message}</p>}
  </section>;
}