@vonage/client-sdk 2.1.3-alpha.0 → 2.1.3-snapshot.142.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14,7 +14,7 @@ import { ConversationEvent } from '../kotlin/JsUnions';
14
14
  * @packageDocumentation
15
15
  */
16
16
  export * from '../utils';
17
- type VonageEventOverride = Omit<vonage.CombinedEvents, 'conversationEvent' | 'callHangup' | 'callMediaDisconnect' | 'legStatusUpdate' | 'rtcStatsUpdate' | 'callInvite' | 'callInviteCancel' | 'sessionError' | 'callMediaError'> & {
17
+ type VonageEventOverride = Omit<vonage.CombinedEvents, 'conversationEvent' | 'callHangup' | 'callMediaDisconnect' | 'legStatusUpdate' | 'rtcStatsUpdate' | 'callInvite' | 'callInviteCancel' | 'sessionError' | 'callMediaError' | 'disconnected' | 'hangup'> & {
18
18
  conversationEvent: (event: ConversationEvent) => void;
19
19
  callHangup: (callId: string, callQuality: RTCQuality, reason: HangupReason) => void;
20
20
  callMediaDisconnect: (callId: string, reason: CallDisconnectReason) => void;
@@ -24,6 +24,8 @@ type VonageEventOverride = Omit<vonage.CombinedEvents, 'conversationEvent' | 'ca
24
24
  callInvite: (callId: string, from: string, channelType: VoiceChannelType) => void;
25
25
  sessionError: (reason: SessionErrorReason) => void;
26
26
  callMediaError: (callId: string, error: VonageError) => void;
27
+ disconnected: (callId: string) => void;
28
+ hangup: (callId: string) => void;
27
29
  };
28
30
  /**
29
31
  * Vonage Event Names
@@ -119,6 +121,23 @@ export type CallSayParams = Partial<vonage.CallSayParams> & {
119
121
  * @group Voice
120
122
  */
121
123
  export type RtcStats = vonage.RTCStatsJS;
124
+ /**
125
+ * Data for an emergency call
126
+ *
127
+ * @property callId The call ID
128
+ * @property reconnectToken The reconnect token for the call
129
+ * @interface
130
+ * @group Emergency
131
+ */
132
+ export type EmergencyCallData = vonage.emergency.EmergencyCallDataJS;
133
+ /**
134
+ * Options for an emergency call
135
+ *
136
+ * @property ringbackTone Optional URL to a custom ringback tone audio file
137
+ * @interface
138
+ * @group Emergency
139
+ */
140
+ export type EmergencyCallOptions = vonage.emergency.EmergencyCallOptionsJS;
122
141
  /**
123
142
  * VonageClient is the main entry point for the Vonage Client SDK.
124
143
  *
@@ -204,7 +223,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
204
223
  * @group Voice
205
224
  * @param id - The Call Id
206
225
  */
207
- getPeerConnection(id: string): RTCPeerConnection;
226
+ getPeerConnection(id: string): RTCPeerConnection | undefined;
208
227
  /**
209
228
  * Get the HTML Audio Element for the SDK.
210
229
  * It can be used to route output to other devices.
@@ -550,5 +569,34 @@ export declare class VonageClient extends vonage.CombinedClientJS {
550
569
  * @returns the `timestamp` of the message
551
570
  */
552
571
  sendMessageSeenEvent(id: number, conversationId: string): Promise<string>;
572
+ /**
573
+ * Starts an emergency call.
574
+ *
575
+ * @group Emergency
576
+ * @param token
577
+ * @param from
578
+ * @param to
579
+ * @param options - Optional {@link EmergencyCallOptions} containing call options
580
+ * @returns the result containing `callId` and `reconnectToken`
581
+ */
582
+ emergencyCall(token: string, from: string, to: string, options?: Nullable<EmergencyCallOptions>): Promise<EmergencyCallData>;
583
+ /**
584
+ * Reconnects an existing emergency call.
585
+ *
586
+ * @group Emergency
587
+ * @param token
588
+ * @param callId
589
+ * @param reconnectToken
590
+ * @returns void
591
+ */
592
+ reconnectEmergencyCall(token: string, callId: string, reconnectToken: string): Promise<void>;
593
+ /**
594
+ * Hangup an emergency call.
595
+ *
596
+ * @group Emergency
597
+ * @param callId - the `callId` of the call to hangup
598
+ * @returns void
599
+ */
600
+ hangupEmergencyCall(callId: string): Promise<void>;
553
601
  }
554
602
  export default VonageClient;