@cometchat/calls-sdk-javascript 4.0.4 → 4.0.5

package/pack/models/CallGroup.d.ts

@@ -0,0 +1,14 @@
+export declare class CallGroup {
+    protected guid: string;
+    protected name: string;
+    protected icon: string;
+    constructor(object: any);
+    getGuid(): string;
+    setGuid(guid: string): void;
+    getName(): string;
+    setName(name: string): void;
+    getIcon(): string;
+    setIcon(icon: string): void;
+    toString(): string;
+    static getGroupFromJson(object: any): CallGroup;
+}

package/pack/models/CallLog.d.ts

@@ -0,0 +1,276 @@
+import { CallGroup } from "./CallGroup";
+import { CallUser } from "./CallUser";
+import { Participant } from "./Participant";
+import { Recording } from "./Recording";
+/**
+ * Represents a call log.
+ */
+export declare class CallLog {
+    /**
+     * The session ID of the call log.
+     */
+    private sessionId;
+    /**
+     * The total audio minutes of the call log.
+     */
+    private totalAudioMinutes;
+    /**
+     * The total video minutes of the call log.
+     */
+    private totalVideoMinutes;
+    /**
+     * The total duration of the call log.
+     */
+    private totalDuration;
+    /**
+     * Whether the call log has a recording.
+     */
+    private hasRecording;
+    /**
+     * The time the call was initiated at.
+     */
+    private initiatedAt;
+    /**
+     * The call category of the call log.
+     */
+    private callCategory;
+    /**
+     * @type {CallUser}
+     * The initiator of the call log.
+     */
+    private initiator;
+    /**
+     * @type {CallUser | CallGroup}
+     * The receiver of the call log.
+     */
+    private receiver;
+    /**
+     * The receiver type of the call log.
+     */
+    private receiverType;
+    /**
+     * The status of the call log.
+     */
+    private status;
+    /**
+     * The total duration in minutes of the call log.
+     */
+    private totalDurationInMinutes;
+    /**
+     * The total number of participants in the call log.
+     */
+    private totalParticipants;
+    /**
+     * The type of the call log.
+     */
+    private type;
+    /**
+     * The message ID of the call log.
+     */
+    private mid;
+    /**
+     * The time the call ended at.
+     */
+    private endedAt;
+    /**
+     * @type {Participant[]}
+     * The participants of the call log.
+     */
+    private participants;
+    /**
+     * @type {Recording[]}
+     * The recordings of the call log.
+     */
+    private recordings;
+    /**
+     * Creates a new instance of CallLog.
+     * @param data - The data to initialize the call log with.
+     */
+    constructor(data: any);
+    /**
+     * Gets the session ID of the call log.
+     * @returns The session ID of the call log.
+     */
+    getSessionID(): string;
+    /**
+     * Sets the session ID of the call log.
+     * @param value - The session ID to set.
+     */
+    setSessionID(value: string): void;
+    /**
+     * Gets the total audio minutes of the call log.
+     * @returns The total audio minutes of the call log.
+     */
+    getTotalAudioMinutes(): number;
+    /**
+     * Sets the total audio minutes of the call log.
+     * @param value - The total audio minutes to set.
+     */
+    setTotalAudioMinutes(value: number): void;
+    /**
+     * Gets the total video minutes of the call log.
+     * @returns The total video minutes of the call log.
+     */
+    getTotalVideoMinutes(): number;
+    /**
+     * Sets the total video minutes of the call log.
+     * @param value - The total video minutes to set.
+     */
+    setTotalVideoMinutes(value: number): void;
+    /**
+     * Gets the total duration of the call log.
+     * @returns The total duration of the call log.
+     */
+    getTotalDuration(): string;
+    /**
+     * Sets the total duration of the call log.
+     * @param value - The total duration to set.
+     */
+    setTotalDuration(value: string): void;
+    /**
+     * Gets whether the call log has a recording.
+     * @returns Whether the call log has a recording.
+     */
+    getHasRecording(): boolean;
+    /**
+     * Sets whether the call log has a recording.
+     * @param value - Whether the call log has a recording.
+     */
+    setHasRecording(value: boolean): void;
+    /**
+     * Gets the time the call was initiated at.
+     * @returns The time the call was initiated at.
+     */
+    getInitiatedAt(): number;
+    /**
+     * Sets the time the call was initiated at.
+     * @param value - The time the call was initiated at.
+     */
+    setInitiatedAt(value: number): void;
+    /**
+     * Gets the call category of the call log.
+     * @returns The call category of the call log.
+     */
+    getCallCategory(): string;
+    /**
+     * Sets the call category of the call log.
+     * @param value - The call category to set.
+     */
+    setCallCategory(value: string): void;
+    /**
+     * Gets the initiator of the call log.
+     * @returns The initiator of the call log.
+     */
+    getInitiator(): CallUser;
+    /**
+     * Sets the initiator of the call log.
+     * @param value - The initiator to set.
+     */
+    setInitiator(value: CallUser): void;
+    /**
+     * Gets the receiver of the call log.
+     * @returns The receiver of the call log.
+     */
+    getReceiver(): CallUser | CallGroup;
+    /**
+     * Sets the receiver of the call log.
+     * @param value - The receiver to set.
+     */
+    setReceiver(value: CallUser | CallGroup): void;
+    /**
+     * Gets the receiver type of the call log.
+     * @returns The receiver type of the call log.
+     */
+    getReceiverType(): string;
+    /**
+     * Sets the receiver type of the call log.
+     * @param value - The receiver type to set.
+     */
+    setReceiverType(value: string): void;
+    /**
+     * Gets the status of the call log.
+     * @returns The status of the call log.
+     */
+    getStatus(): string;
+    /**
+     * Sets the status of the call log.
+     * @param value - The status to set.
+     */
+    setStatus(value: string): void;
+    /**
+     * Gets the total duration in minutes of the call log.
+     * @returns The total duration in minutes of the call log.
+     */
+    getTotalDurationInMinutes(): number;
+    /**
+     * Sets the total duration in minutes of the call log.
+     * @param value - The total duration in minutes to set.
+     */
+    setTotalDurationInMinutes(value: number): void;
+    /**
+     * Gets the total number of participants in the call log.
+     * @returns The total number of participants in the call log.
+     */
+    getTotalParticipants(): number;
+    /**
+     * Sets the total number of participants in the call log.
+     * @param value - The total number of participants to set.
+     */
+    setTotalParticipants(value: number): void;
+    /**
+     * Gets the type of the call log.
+     * @returns The type of the call log.
+     */
+    getType(): string;
+    /**
+     * Sets the type of the call log.
+     * @param value - The type to set.
+     */
+    setType(value: string): void;
+    /**
+     * Gets the message ID of the call log.
+     * @returns The message ID of the call log.
+     */
+    getMid(): string;
+    /**
+     * Sets the message ID of the call log.
+     * @param value - The message ID to set.
+     */
+    setMid(value: string): void;
+    /**
+     * Gets the time the call ended at.
+     * @returns The time the call ended at.
+     */
+    getEndedAt(): number;
+    /**
+     * Sets the time the call ended at.
+     * @param value - The time the call ended at.
+     */
+    setEndedAt(value: number): void;
+    /**
+     * Gets the participants of the call log.
+     * @returns The participants of the call log.
+     */
+    getParticipants(): Participant[];
+    /**
+     * Sets the participants of the call log.
+     * @param value - The participants to set.
+     */
+    setParticipants(value: Participant[]): void;
+    /**
+     * Gets the recordings of the call log.
+     * @returns The recordings of the call log.
+     */
+    getRecordings(): Recording[];
+    /**
+     * Sets the recordings of the call log.
+     * @param value - The recordings to set.
+     */
+    setRecordings(value: Recording[]): void;
+    /**
+     * Creates a new instance of CallLog from JSON data.
+     * @param data - The JSON data to create the call log from.
+     * @returns A new instance of CallLog created from the JSON data.
+     */
+    static callLogFromJson(data: any): CallLog;
+}

package/pack/models/CallUser.d.ts

@@ -0,0 +1,14 @@
+export declare class CallUser {
+    protected uid: string;
+    protected name: string;
+    protected avatar: string;
+    constructor(object: any);
+    getUid(): string;
+    setUid(uid: string): void;
+    getName(): string;
+    setName(name: string): void;
+    getAvatar(): string;
+    setAvatar(avatar: string): void;
+    toString(): string;
+    static getUserFromJson(object: any): CallUser;
+}

package/pack/models/CometChatCallLogs.d.ts

@@ -0,0 +1,189 @@
+import { CallLog } from "./CallLog";
+/**
+ * Represents a request to fetch call logs.
+ */
+declare class CallLogRequest {
+    /**
+     * The maximum number of call logs to fetch.
+     */
+    private limit;
+    /**
+     * The total number of pages of call logs.
+     */
+    private totalPages;
+    /**
+     * The current page of call logs.
+     */
+    private currentPage;
+    /**
+     * The type of call to filter by.
+     */
+    private callType;
+    /**
+     * The status of call to filter by.
+     */
+    private callStatus;
+    /**
+     * Whether the call has a recording or not.
+     */
+    private hasRecording;
+    /**
+     * The category of call to filter by.
+     */
+    private callCategory;
+    /**
+     * The direction of call to filter by.
+     */
+    private callDirection;
+    /**
+     * The user ID to filter by.
+     */
+    private uid;
+    /**
+     * The group ID to filter by.
+     */
+    private guid;
+    /**
+     * The authentication token to use for the API call.
+     */
+    private authToken;
+    /**
+     * Whether an API call is currently in progress.
+     */
+    private inProgress;
+    /**
+     * The timestamp of the last update.
+     */
+    private updatedAt;
+    /**
+     * Whether to only fetch updates.
+     */
+    private onlyUpdates;
+    /**
+     * The timestamp of the call log.
+     */
+    private timestamp?;
+    /**
+     * The affix of the call log.
+     */
+    private affix;
+    /**
+     * The last affix of the call log.
+     */
+    private lastAffix;
+    /**
+     * The current method of the call log.
+     */
+    private currentMethod;
+    /**
+     * The pagination metadata of the call log.
+     */
+    private paginationMeta;
+    /**
+     * Creates a new CallLogRequest instance.
+     * @param builder The builder object to use for constructing the request.
+     */
+    constructor(builder: CallLogRequestBuilder);
+    /**
+     * Fetches the next page of call logs.
+     * @returns A promise that resolves to an array of CallLog objects, or rejects with a CometChatCallsException if there was an error.
+     */
+    fetchNext(): Promise<CallLog[]>;
+    /**
+     * Fetches the previous page of call logs.
+     * @returns A promise that resolves to an array of CallLog objects, or an empty array if there are no previous pages, or rejects with a CometChatCallsException if there was an error..
+     */
+    fetchPrevious(): Promise<CallLog[] | []>;
+    /**
+     * Makes an API call to fetch call logs.
+     * @param isFetchNext Whether to fetch the next page of call logs.
+     * @returns A promise that resolves to an array of CallLog objects, or rejects with a CometChatCallsException if there was an error.
+     */
+    private makeAPICall;
+    /**
+     * Gets the filter parameters for the API call.
+     * @param isNext Whether to fetch the next page of call logs.
+     * @returns The filter parameters object.
+     */
+    private getParams;
+    /**
+     * Parses the API response and returns an array of CallLog objects.
+     * @param response The API response string.
+     * @returns An array of CallLog objects.
+     */
+    private getCallLogList;
+}
+/**
+ * A builder class for creating a request to fetch call logs.
+ */
+export declare class CallLogRequestBuilder {
+    /** @private */ limit: number;
+    /** @private */ callType: string;
+    /** @private */ callStatus: string;
+    /** @private */ hasRecording: boolean;
+    /** @private */ callCategory: string;
+    /** @private */ callDirection: string;
+    /** @private */ uid: string;
+    /** @private */ guid: string;
+    /** @private */ authToken: string;
+    /**
+     * Sets the limit of call logs to be fetched.
+     * @param limit - The number of call logs to be fetched.
+     * @returns The CallLogRequestBuilder object.
+     */
+    setLimit(limit: number): this;
+    /**
+     * Sets the type of call to be fetched.
+     * @param callType - The type of call to be fetched. Can be either 'video' or 'audio'.
+     * @returns The CallLogRequestBuilder object.
+     */
+    setCallType(callType: 'video' | 'audio'): this;
+    /**
+     * Sets the status of call to be fetched.
+     * @param callStatus - The status of call to be fetched. Can be either 'ongoing', 'busy', 'rejected', 'cancelled', 'ended' or 'missed'.
+     * @returns The CallLogRequestBuilder object.
+     */
+    setCallStatus(callStatus: 'ongoing' | 'busy' | 'rejected' | 'cancelled' | 'ended' | 'missed'): this;
+    /**
+     * Sets whether the call has recording or not.
+     * @param hasRecording - Whether the call has recording or not.
+     * @returns The CallLogRequestBuilder object.
+     */
+    setHasRecording(hasRecording: boolean): this;
+    /**
+     * Sets the category of call to be fetched.
+     * @param callCategory - The category of call to be fetched. Can be either 'call' or 'meet'.
+     * @returns The CallLogRequestBuilder object.
+     */
+    setCallCategory(callCategory: 'call' | 'meet'): this;
+    /**
+     * Sets the direction of call to be fetched.
+     * @param callDirection - The direction of call to be fetched. Can be either 'incoming' or 'outgoing'.
+     * @returns The CallLogRequestBuilder object.
+     */
+    setCallDirection(callDirection: 'incoming' | 'outgoing'): this;
+    /**
+     * Sets the user ID of the call logs to be fetched.
+     * @param uid - The user ID of the call logs to be fetched.
+     * @returns The CallLogRequestBuilder object.
+     */
+    setUid(uid: string): this;
+    /**
+     * Sets the group ID of the call logs to be fetched.
+     * @param guid - The group ID of the call logs to be fetched.
+     * @returns The CallLogRequestBuilder object.
+     */
+    setGuid(guid: string): this;
+    /**
+     * Sets the authorization token for the request.
+     * @param authToken - The authorization token for the request.
+     * @returns The CallLogRequestBuilder object.
+     */
+    setAuthToken(authToken: string): this;
+    /**
+     * Builds and returns the CallLogRequest object.
+     * @returns The CallLogRequest object.
+     */
+    build(): CallLogRequest;
+}
+export {};

package/pack/models/CometChatCalls.d.ts

@@ -4,8 +4,11 @@ import { OngoingCallListener } from "./Listener";
 import { CallConstants } from "../constants";
 import { PresenterSettings, PresenterSettingsBuilder } from "./PresenterSettings";
 import { ListenerHandlers } from "./ListnerHandler";
+import { CallLog } from './CallLog';
+import { CallLogRequestBuilder } from './CometChatCallLogs';
 export declare class CometChatCalls {
     private static appSettings;
+    private static inProgress;
     private static callEventListener;
     private static debounceDeviceChange;
     private static deviceList;
@@ -32,6 +35,8 @@ export declare class CometChatCalls {
     static CallAppSettingsBuilder: typeof CallAppSettingsBuilder;
     static CallAppSettings: typeof CallAppSettings;
     static MainVideoContainerSetting: typeof MainVideoContainerSetting;
+    static CallLogRequestBuilder: typeof CallLogRequestBuilder;
+    static CallLog: typeof CallLog;
     private static isPresenterMode;
     static joinPresentation(callToken: string, presenterSettings: PresenterSettings, htmlElement: HTMLElement): Promise<void>;
     static startSession(callToken: string, callSettings: CallSettings, htmlElement: HTMLElement): Promise<void>;
@@ -127,7 +132,7 @@ export declare class CometChatCalls {
      * Method to get all the available audio input devices.
      * @returns {MediaDeviceInfo[]}
      */
-    static getAudioInputDevices(): InputDeviceInfo[];
+    static getAudioInputDevices(): MediaDeviceInfo[];
     /**
      * Method to get all the available audio output devices.
      * @returns {MediaDeviceInfo[]}
@@ -156,4 +161,12 @@ export declare class CometChatCalls {
      * @returns {void}
      */
     static setVideoInputDevice(deviceId: string): void;
+    /**
+     * Retrieves call details for a given session ID and auth token.
+     * @param sessionID - The session ID of the call.
+     * @param authToken - The authentication token required to make the API call.
+     * @returns A Promise that resolves to a CallLog object containing the call details.
+     * @throws {CometChatCallsException} If there is an error retrieving the call details.
+     */
+    static getCallDetails(sessionID: string, authToken: string): Promise<CallLog>;
 }

package/pack/models/Listener.d.ts

@@ -10,6 +10,7 @@ interface IOngoingCallListener {
     onScreenShareStarted: () => void;
     onScreenShareStopped: () => void;
     onUserMuted: (event: Partial<ICallEventsData["onUserMuted"]>) => void;
+    onUserUnMuted: (event: Partial<ICallEventsData["onUserUnMuted"]>) => void;
     onCallSwitchedToVideo: (event: Partial<ICallEventsData["onCallSwitchedToVideo"]>) => void;
     onCallEnded: () => void;
     onCallEndButtonPressed: () => void;
@@ -60,6 +61,10 @@ export declare class OngoingCallListener {
      * This event is triggered when a user is muted.
     */
     onUserMuted?: IOngoingCallListener["onUserMuted"];
+    /**
+     * This event is triggered when a user is unmuted.
+     */
+    onUserUnMuted?: IOngoingCallListener["onUserUnMuted"];
     /**
      * This event is triggered when an audio call is switched to a video call.
     */