@vonage/client-sdk 2.2.0 → 2.3.0-alpha.0

package/dist/client/VonageClient.d.ts

@@ -14,7 +14,7 @@ import { ConversationEvent } from '../kotlin/JsUnions';
  * @packageDocumentation
  */
 export * from '../utils';
-type VonageEventOverride = Omit<vonage.CombinedEvents, 'conversationEvent' | 'callHangup' | 'callMediaDisconnect' | 'legStatusUpdate' | 'rtcStatsUpdate' | 'callInvite' | 'callInviteCancel' | 'sessionError' | 'callMediaError'> & {
+type VonageEventOverride = Omit<vonage.CombinedEvents, 'conversationEvent' | 'callHangup' | 'callMediaDisconnect' | 'legStatusUpdate' | 'rtcStatsUpdate' | 'callInvite' | 'callInviteCancel' | 'sessionError' | 'callMediaError' | 'emergencyCallDisconnected' | 'emergencyCallHangup'> & {
     conversationEvent: (event: ConversationEvent) => void;
     callHangup: (callId: string, callQuality: RTCQuality, reason: HangupReason) => void;
     callMediaDisconnect: (callId: string, reason: CallDisconnectReason) => void;
@@ -24,6 +24,8 @@ type VonageEventOverride = Omit<vonage.CombinedEvents, 'conversationEvent' | 'ca
     callInvite: (callId: string, from: string, channelType: VoiceChannelType) => void;
     sessionError: (reason: SessionErrorReason) => void;
     callMediaError: (callId: string, error: VonageError) => void;
+    emergencyCallDisconnected: (callId: string) => void;
+    emergencyCallHangup: (callId: string) => void;
 };
 /**
  * Vonage Event Names
@@ -119,6 +121,23 @@ export type CallSayParams = Partial<vonage.CallSayParams> & {
  * @group Voice
  */
 export type RtcStats = vonage.RTCStatsJS;
+/**
+ * Data for an emergency call
+ *
+ * @property callId The call ID
+ * @property reconnectToken The reconnect token for the call
+ * @interface
+ * @group Emergency
+ */
+export type EmergencyCallData = vonage.emergency.EmergencyCallDataJS;
+/**
+ * Options for an emergency call
+ *
+ * @property ringbackTone Optional URL to a custom ringback tone audio file
+ * @interface
+ * @group Emergency
+ */
+export type EmergencyCallOptions = vonage.emergency.EmergencyCallOptionsJS;
 /**
  * VonageClient is the main entry point for the Vonage Client SDK.
  *
@@ -204,7 +223,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @group Voice
      * @param id - The Call Id
      */
-    getPeerConnection(id: string): RTCPeerConnection;
+    getPeerConnection(id: string): RTCPeerConnection | undefined;
     /**
      * Get the HTML Audio Element for the SDK.
      * It can be used to route output to other devices.
@@ -551,5 +570,66 @@ export declare class VonageClient extends vonage.CombinedClientJS {
      * @returns the `timestamp` of the message
      */
     sendMessageSeenEvent(id: number, conversationId: string): Promise<string>;
+    /**
+     * Starts an emergency call.
+     *
+     * @group Emergency
+     * @param token
+     * @param from
+     * @param to
+     * @param options - Optional {@link EmergencyCallOptions} containing call options
+     * @returns the result containing `callId` and `reconnectToken`
+     */
+    emergencyCall(token: string, from: string, to: string, options?: Nullable<EmergencyCallOptions>): Promise<EmergencyCallData>;
+    /**
+     * Reconnects an existing emergency call.
+     *
+     * @group Emergency
+     * @param token
+     * @param callId
+     * @param reconnectToken
+     * @returns void
+     */
+    reconnectEmergencyCall(token: string, callId: string, reconnectToken: string): Promise<void>;
+    /**
+     * Hangup an emergency call.
+     *
+     * @group Emergency
+     * @param callId - the `callId` of the call to hangup
+     * @returns void
+     */
+    hangupEmergencyCall(callId: string): Promise<void>;
+    /**
+     * Mute an emergency call.
+     *
+     * @group Emergency
+     * @param callId - the `callId` of the call to mute
+     * @returns void
+     */
+    muteEmergencyCall(callId: string): Promise<void>;
+    /**
+     * Unmute an emergency call.
+     *
+     * @group Emergency
+     * @param callId - the `callId` of the call to unmute
+     * @returns void
+     */
+    unmuteEmergencyCall(callId: string): Promise<void>;
+    /**
+     * Enable earmuff for an emergency call.
+     *
+     * @group Emergency
+     * @param callId - the `callId` of the call to enable earmuff for
+     * @returns void
+     */
+    enableEarmuffEmergencyCall(callId: string): Promise<void>;
+    /**
+     * Disable earmuff for an emergency call.
+     *
+     * @group Emergency
+     * @param callId - the `callId` of the call to disable earmuff for
+     * @returns void
+     */
+    disableEarmuffEmergencyCall(callId: string): Promise<void>;
 }
 export default VonageClient;