Fishjam Mobile SDK - v0.24.0
    Preparing search index...
    useCallKitService: (config: CallKitConfig) => void = ...

    A convenience hook for automatically managing CallKit session lifecycle on iOS. Does nothing on other platforms. This hook automatically starts a CallKit session when the component mounts and ends it when the component unmounts. Use this hook when you want CallKit to be active for the entire lifetime of a component (e.g., during a call).

    Type declaration

      • (config: CallKitConfig): void
      • Parameters

        • config: CallKitConfig

          Configuration object containing:

          • displayName - The name to display in the CallKit UI (e.g., username, call title)
          • isVideo - Whether the call is video or audio only

        Returns void

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

    function CallScreen({ username }: { username: string }) {
    // CallKit session will automatically start when this component mounts
    // and end when it unmounts
    useCallKitService({ displayName: username, isVideo: true });

    return null;
    }