Hooks Reference

Web SDK React hooks for state management and SDK integration

Overview

This section provides a detailed reference for all React hooks available in the Suki Web SDK.

UseSuki Hook

The useSuki hook is a React hook for managing SDK state and operations within React components.

The code snippet below shows how to use the useSuki hook to access SDK state and methods:

Typescript

const client: UseSukiReturn = useSuki();

Returns

It returns a UseSukiReturn object containing SDK state and methods for ambient session management.

UseSukiReturn Type

Return type of the useSuki hook containing SDK state and methods.

JavaScript

type UseSukiReturn = {
  activeAmbientId: string | null;
  attemptLogin: () => void;
  cancelAmbient: () => void;
  error: SukiError | null;
  init: (options: ReactInitOptions) => void;
  isAmbientInProgress: boolean;
  isAmbientPaused: boolean;
  isInitialized: boolean;
  on: <T extends keyof EmitterEvents>(
    type: T,
    handler: (args: EmitterEvents[T]) => void | Promise<void>,
  ) => () => void;
  pauseAmbient: () => void;
  resumeAmbient: () => void;
  setEncounter: (encounter: Encounter) => Promise<void>;
  setPartnerToken: (partnerToken: string) => void;
  startAmbient: () => void;
  submitAmbient: () => void;
};

Available Properties

Hide properties

activeAmbientId · string | null

The ID of the currently active ambient session, or null if no session is active.

error · SukiError | null

Current error state of the SDK, or null if no errors.

isAmbientInProgress · boolean

Whether an ambient session is currently in progress.

isAmbientPaused · boolean

Whether the current ambient session is paused.

isInitialized · boolean

Whether the SDK has been successfully initialized.

Available Methods

Hide available methods

attemptLogin · void

Attempts to authenticate when SDK is not authenticated after initialization. This method does not take any parameters.

cancelAmbient · void

Cancels the current ambient session. This method does not take any parameters.

init · void

Initializes the SDK with the provided options.

Hide parameters

options · ReactInitOptions · required

The configuration options required to initialize the SDK.

on · () => void

Subscribes to SDK events. This method returns an unsubscribe function.

Hide parameters

type · T · required

The type of event to subscribe to (e.g., 'ready', 'ambient:update').

handler · (args: EmitterEvents[T]) => void | Promise<void> · required

The callback function to be executed when the event is emitted.

pauseAmbient · void

Pauses the current ambient session. This method does not take any parameters.

resumeAmbient · void

Resumes a paused ambient session. This method does not take any parameters.

setEncounter · Promise<void>

Updates the current encounter data.

Hide parameters

encounter · Encounter · required

The encounter object containing updated patient and encounter details.

setPartnerToken · void

Updates the partner token after token refresh.

Hide parameters

partnerToken · string · required

The new partner token string.

startAmbient · void

Starts a new ambient session. This method does not take any parameters.

submitAmbient · void

Submits the current ambient session. This method does not take any parameters.

Next Steps

Refer to the Provider Types to learn more about the provider types.