Variable: useCallKit()

const useCallKit: () => UseCallKitResult

Defined in: packages/react-native-client/src/hooks/useCallKit.ts:161

A hook for managing CallKit sessions on iOS. Does nothing on other platforms. CallKit provides a native iOS interface for managing VoIP calls, integrating with the system's phone UI and controls. Use this hook when you need fine-grained control over the CallKit session lifecycle.

Returns

UseCallKitResult

An object containing methods to manage CallKit sessions:

• startCallKitSession(config: CallKitConfig) - Starts a CallKit session with the given configuration
• endCallKitSession() - Ends the current CallKit session
• getCallKitSessionStatus() - Returns whether there is currently an active CallKit session

Example

import { useCallKit } from '@fishjam-cloud/react-native-client';

const { startCallKitSession, endCallKitSession } = useCallKit();

// Start a CallKit session
await startCallKitSession({ displayName: 'John Doe', isVideo: true });

// Later, end the session
await endCallKitSession();