@cometchat/calls-sdk-javascript 4.0.11 → 4.1.0

package/pack/src/models/CallSettings.d.ts

@@ -33,6 +33,7 @@ export declare class CallSettings {
     private analyticsSettings;
     private customCSS;
     private ShowRecordingButton;
+    private idleTimeoutPeriod;
     private StartRecordingOnCallStart;
     private callListener;
     private ShowSwitchToVideoCallButton;
@@ -42,6 +43,7 @@ export declare class CallSettings {
     constructor(builder?: CallSettingsBuilder);
     getCallListener(): OngoingCallListener;
     isRecordingButtonEnabled(): boolean;
+    getIdleTimeoutPeriod(): number;
     shouldStartRecordingOnCallStart(): boolean;
     getCustomCSS(): string;
     isAudioOnlyCall(): boolean;
@@ -76,6 +78,7 @@ export declare class CallSettingsBuilder {
     /** @private */ analyticsSettings: Object;
     /** @private */ customCSS: string;
     /** @private */ ShowRecordingButton: boolean;
+    /** @private */ idleTimeoutPeriod: number;
     /** @private */ StartRecordingOnCallStart: boolean;
     /** @private */ ShowSwitchToVideoCallButton: boolean;
     /** @private */ virtualBackground: VirtualBackground;
@@ -201,6 +204,17 @@ export declare class CallSettingsBuilder {
      * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
     */
     showRecordingButton(showRecordingButton: boolean): this;
+    /**
+     *
+     * @param {number} idleTimeoutPeriod
+     * This method sets the idle timeout period for the call.
+     * If set and you are the only one in call, the call will end
+     * after the idle timeout period, giving you the option to
+     * extend the call 60 seconds before the call ends.
+     * Default value is 180 seconds.
+     * @returns {CallSettingsBuilder} Returns the CallSettingsBuilder instance
+    */
+    setIdleTimeoutPeriod(idleTimeoutPeriod: number): this;
     /**
      *
      * @param {boolean} startRecordingOnCallStart

package/pack/src/models/Listener.d.ts

@@ -13,6 +13,7 @@ interface IOngoingCallListener {
     onUserUnMuted: (event: Partial<ICallEventsData["onUserUnMuted"]>) => void;
     onCallSwitchedToVideo: (event: Partial<ICallEventsData["onCallSwitchedToVideo"]>) => void;
     onCallEnded: () => void;
+    onSessionTimeout: () => void;
     onCallEndButtonPressed: () => void;
     onError: (error: CometChatCallsException) => void;
 }
@@ -73,6 +74,10 @@ export declare class OngoingCallListener {
      * This event is triggered when the call is ended.
     */
     onCallEnded?: IOngoingCallListener["onCallEnded"];
+    /**
+     * This event is triggered when the call is ended due to session timeout.
+    */
+    onSessionTimeout?: IOngoingCallListener["onSessionTimeout"];
     /**
      * This event is triggered when an error occurs.
     */

package/pack/src/models/PresenterSettings.d.ts

@@ -34,6 +34,7 @@ export declare class PresenterSettings {
     private analyticsSettings;
     private customCSS;
     private ShowRecordingButton;
+    private idleTimeoutPeriod;
     private StartRecordingOnCallStart;
     private callListener;
     private ShowSwitchToVideoCallButton;
@@ -43,6 +44,7 @@ export declare class PresenterSettings {
     constructor(builder?: PresenterSettingsBuilder);
     getCallListener(): OngoingCallListener;
     isRecordingButtonEnabled(): boolean;
+    getIdleTimeoutPeriod(): number;
     shouldStartRecordingOnCallStart(): boolean;
     getCustomCSS(): string;
     isAudioOnlyCall(): boolean;
@@ -78,6 +80,7 @@ export declare class PresenterSettingsBuilder {
     /** @private */ analyticsSettings: Object;
     /** @private */ customCSS: string;
     /** @private */ ShowRecordingButton: boolean;
+    /** @private */ idleTimeoutPeriod: number;
     /** @private */ StartRecordingOnCallStart: boolean;
     /** @private */ ShowSwitchToVideoCallButton: boolean;
     /** @private */ virtualBackground: VirtualBackground;
@@ -206,6 +209,17 @@ export declare class PresenterSettingsBuilder {
      * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
     */
     showRecordingButton(showRecordingButton: boolean): this;
+    /**
+     *
+     * @param {number} idleTimeoutPeriod
+     * This method sets the idle timeout period for the call.
+     * If set and you are the only one in call, the call will end
+     * after the idle timeout period, giving you the option to
+     * extend the call 60 seconds before the call ends.
+     * Default value is 180 seconds.
+     * @returns {PresenterSettingsBuilder} Returns the PresenterSettingsBuilder instance
+    */
+    setIdleTimeoutPeriod(idleTimeoutPeriod: number): this;
     /**
      *
      * @param {boolean} startRecordingOnCallStart

package/pack/src/types/ICallSettings.d.ts

@@ -4,6 +4,7 @@ export interface ICallsettings {
     screenShareMode?: "default" | "presenter";
     ShowEndCallButton?: boolean;
     ShowRecordingButton?: boolean;
+    idleTimeoutPeriod?: number;
     StartRecordingOnCallStart?: boolean;
     ShowMuteAudioButton?: boolean;
     ShowPauseVideoButton?: boolean;

package/pack/src/types/callEvents.d.ts

@@ -1,5 +1,5 @@
 import { AnyProperties } from "./common";
-export type CallingEventsInternal = "initialDeviceList" | "onDeviceChange" | "onUserJoined" | "onUserLeft" | "onUserListChanged" | "SCREEN_SHARE_STARTED" | "SCREEN_SHARE_ENDED" | "SCREEN_SHARE_ENDED" | "hangup" | "onCallSwitchedToVideo" | "onRecordingToggled" | "onCallEndButtonPressed" | "onUserMuted" | "onUserUnMuted";
+export type CallingEventsInternal = "initialDeviceList" | "onDeviceChange" | "onUserJoined" | "onUserLeft" | "onUserListChanged" | "SCREEN_SHARE_STARTED" | "SCREEN_SHARE_ENDED" | "SCREEN_SHARE_ENDED" | "hangup" | "onSessionTimeout" | "onCallSwitchedToVideo" | "onRecordingToggled" | "onCallEndButtonPressed" | "onUserMuted" | "onUserUnMuted";
 interface IAVDevice {
     deviceId: string;
     kind: string;
@@ -65,6 +65,7 @@ export interface ICallEventsData {
         audioOutputDevices: IAVDevice[];
     };
     onCallEnded: {};
+    onSessionTimeout: {};
     onCallSwitchedToVideo: {
         sessionId: string;
         initiator: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cometchat/calls-sdk-javascript",
-  "version": "4.0.11",
+  "version": "4.1.0",
   "description": "Cometchat's Javascript SDK for In-app Calling.",
   "main": "pack/index.js",
   "module": "pack/index.js",

package/pack/index.js.LICENSE.txt

@@ -1 +0,0 @@
-/*! For license information please see index.js.LICENSE.txt */