@twilio/voice-react-native-sdk/src/type/NativeModule.ts

Twilio Voice React Native SDK

import type { NativeModulesStatic } from 'react-native';
import type { CallInvite } from '../CallInvite';
import type { PreflightTest } from '../PreflightTest';
import type { NativeAudioDevicesInfo } from './AudioDevice';
import type {
  NativeCallInfo,
  NativeCallFeedbackIssue,
  NativeCallFeedbackScore,
} from './Call';
import type { NativeCallInviteInfo } from './CallInvite';
import type { Uuid } from './common';
import type { RTCStats } from './RTCStats';

export interface TwilioVoiceReactNative extends NativeModulesStatic {
  /**
   * Native types.
   *
   * The following event related functions are required by the React Native
   * bindings.
   */
  addListener: (eventType: string) => void;
  removeListeners: (count: number) => void;

  /**
   * Call bindings.
   */
  call_disconnect(callUuid: Uuid): Promise<void>;
  call_getStats(callUuid: Uuid): Promise<RTCStats.StatsReport>;
  call_hold(callUuid: Uuid, hold: boolean): Promise<boolean>;
  call_isOnHold(callUuid: Uuid): Promise<boolean>;
  call_isMuted(callUuid: Uuid): Promise<boolean>;
  call_mute(callUuid: Uuid, mute: boolean): Promise<boolean>;
  call_postFeedback(
    callUuid: Uuid,
    score: NativeCallFeedbackScore,
    issue: NativeCallFeedbackIssue
  ): Promise<void>;
  call_sendDigits(callUuid: Uuid, digits: string): Promise<void>;
  call_sendMessage(
    callUuid: Uuid,
    content: string,
    contentType: string,
    messageType: string
  ): Promise<string>;

  /**
   * Call Invite bindings.
   */
  callInvite_accept(
    callInviteUuid: Uuid,
    acceptOptions: CallInvite.AcceptOptions
  ): Promise<NativeCallInfo>;
  callInvite_isValid(callInviteUuid: Uuid): Promise<boolean>;
  callInvite_reject(callInviteUuid: Uuid): Promise<void>;
  callInvite_updateCallerHandle(
    callInviteUuid: Uuid,
    handle: string
  ): Promise<void>;

  /**
   * Voice bindings.
   */
  voice_connect_android(
    token: string,
    twimlParams: Record<string, any>,
    notificationDisplayName: string | undefined
  ): Promise<NativeCallInfo>;
  voice_connect_ios(
    token: string,
    twimlParams: Record<string, any>,
    contactHandle: string
  ): Promise<NativeCallInfo>;
  voice_initializePushRegistry(): Promise<void>;
  voice_setCallKitConfiguration(
    configuration: Record<string, any>
  ): Promise<void>;
  voice_setIncomingCallContactHandleTemplate(template?: string): Promise<void>;
  voice_getAudioDevices(): Promise<NativeAudioDevicesInfo>;
  voice_getCalls(): Promise<NativeCallInfo[]>;
  voice_getCallInvites(): Promise<NativeCallInviteInfo[]>;
  voice_getDeviceToken(): Promise<string>;
  voice_getVersion(): Promise<string>;
  voice_handleEvent(remoteMessage: Record<string, string>): Promise<boolean>;
  voice_register(accessToken: string): Promise<void>;
  voice_selectAudioDevice(audioDeviceUuid: Uuid): Promise<void>;
  voice_showNativeAvRoutePicker(): Promise<void>;
  voice_unregister(accessToken: string): Promise<void>;

  /**
   * Preflight related bindings.
   */
  voice_runPreflight(
    accessToken: string,
    options: PreflightTest.Options
  ): Promise<Uuid>;

  preflightTest_getCallSid(preflightTestUuid: Uuid): Promise<string>;
  preflightTest_getEndTime(preflightTestUuid: Uuid): Promise<string>;
  preflightTest_getLatestSample(preflightTestUuid: Uuid): Promise<string>;
  preflightTest_getReport(preflightTestUuid: Uuid): Promise<string>;
  preflightTest_getStartTime(preflightTestUuid: Uuid): Promise<string>;
  preflightTest_getState(preflightTestUuid: Uuid): Promise<string>;
  preflightTest_stop(preflightTestUuid: Uuid): Promise<void>;

  preflightTest_flushEvents(): Promise<void>;
}