@cometchat/chat-sdk-javascript 4.0.0-beta1

package/dist/type/lib/models/Listner.d.ts

@@ -0,0 +1,258 @@
+export declare class MessageListener {
+    /**
+     * This event is triggered when a text message is received.
+    */
+    onTextMessageReceived?: Function;
+    /**
+     * This event is triggered when a media message is received.
+    */
+    onMediaMessageReceived?: Function;
+    /**
+     * This event is triggered when a custom message is received.
+    */
+    onCustomMessageReceived?: Function;
+    /**
+     * This event is triggered when someone start typing.
+    */
+    onTypingStarted?: Function;
+    /**
+     * This event is triggered when someone stops typing.
+    */
+    onTypingEnded?: Function;
+    /**
+     * This event is triggered when a message is delivered.
+    */
+    onMessagesDelivered?: Function;
+    /**
+     * This event is triggered when a message is read.
+    */
+    onMessagesRead?: Function;
+    /**
+     * This event is triggered when a message is edited.
+    */
+    onMessageEdited?: Function;
+    /**
+     * This event is triggered when a message is deleted.
+    */
+    onMessageDeleted?: Function;
+    /**
+     * This event is triggered when a transient message is received.
+    */
+    onTransientMessageReceived?: Function;
+    constructor(...args: any[]);
+}
+export declare class CallListener {
+    /**
+     * This event is triggered when an incoming call is received.
+    */
+    onIncomingCallReceived?: Function;
+    /**
+     * This event is triggered when an outgoing call is accepted.
+    */
+    onOutgoingCallAccepted?: Function;
+    /**
+     * This event is triggered when an outgoing call is rejected.
+    */
+    onOutgoingCallRejected?: Function;
+    /**
+     * This event is triggered when an incoming call is cancelled.
+    */
+    onIncomingCallCancelled?: Function;
+    /**
+     * This event is triggered when call is ended.
+    */
+    onCallEndedMessageReceived?: Function;
+    constructor(...args: any[]);
+}
+export declare class UserListener {
+    /**
+     * This event is triggered when a user comes online.
+    */
+    onUserOnline?: Function;
+    /**
+     * This event is triggered when a user goes offline.
+    */
+    onUserOffline?: Function;
+    constructor(...args: any[]);
+}
+export declare class GroupListener {
+    /**
+     * This event is triggered when a user joins a group.
+    */
+    onGroupMemberJoined?: Function;
+    /**
+     * This event is triggered when a group member leaves the group.
+    */
+    onGroupMemberLeft?: Function;
+    /**
+     * This event is triggered when a group member is kicked from the group.
+    */
+    onGroupMemberKicked?: Function;
+    /**
+     * This event is triggered when a group member is banned from the group.
+    */
+    onGroupMemberBanned?: Function;
+    /**
+     * This event is triggered when a group member is unbanned from the group.
+    */
+    onGroupMemberUnbanned?: Function;
+    /**
+     * This event is triggered when scope of a group member is changed.
+    */
+    onGroupMemberScopeChanged?: Function;
+    /**
+     * This event is triggered when a user is added in the group.
+    */
+    onGroupMemberAddedToGroup: Function;
+    constructor(...args: any[]);
+}
+export declare class OngoingCallListener {
+    /**
+     * @internal
+    */
+    onYouLeft?: Function;
+    /**
+     * @internal
+    */
+    onYouJoined?: Function;
+    /**
+     * This event is triggered when a user joins the call.
+    */
+    onUserJoined?: Function;
+    /**
+     * This event is triggered when a user leaves the call.
+    */
+    onUserLeft?: Function;
+    /**
+     * This event is triggered when the participant list of the call changes.
+    */
+    onUserListUpdated?: Function;
+    /**
+     * This event is triggered when the media device list changes.
+    */
+    onMediaDeviceListUpdated?: Function;
+    /**
+     * This event is triggered when someone starts recording the call.
+    */
+    onRecordingStarted?: Function;
+    /**
+     * This event is triggered when someone stops recording the call.
+    */
+    onRecordingStopped?: Function;
+    /**
+     * This event is triggered when someone starts sharing their screen in the call.
+    */
+    onScreenShareStarted?: Function;
+    /**
+     * This event is triggered when someone stops sharing their screen in the call.
+    */
+    onScreenShareStopped?: Function;
+    /**
+     * This event is triggered when a user is muted.
+    */
+    onUserMuted?: Function;
+    /**
+     * This event is triggered when an audio call is switched to a video call.
+    */
+    onCallSwitchedToVideo?: Function;
+    /**
+     * This event is triggered when the call is ended.
+    */
+    onCallEnded?: Function;
+    /**
+     * This event is triggered when an error occurs.
+    */
+    onError?: Function;
+    constructor(...args: any[]);
+}
+export declare class LoginListener {
+    /**
+     * This event is triggered when the user login is successful.
+    */
+    loginSuccess?: Function;
+    /**
+     * This event is triggered when the user login fails.
+    */
+    loginFailure?: Function;
+    /**
+     * This event is triggered when the user logout is successful.
+    */
+    logoutSuccess?: Function;
+    /**
+     * This event is triggered when the user logout fails.
+    */
+    logoutFailure?: Function;
+    constructor(...args: any[]);
+}
+export declare class ConnectionListener {
+    /**
+     * This event is triggered when the WebSocket connection is in connected state.
+    */
+    onConnected?: Function;
+    /**
+     * This event is triggered when the WebSocket connection is in connecting state.
+    */
+    inConnecting?: Function;
+    /**
+     * This event is triggered when the WebSocket connection is in disconnected state.
+    */
+    onDisconnected?: Function;
+    /**
+     * This event is triggered when the WebSocket connection is in feature throttled state.
+    */
+    onFeatureThrottled?: Function;
+    constructor(...args: any[]);
+}
+/** @internal */
+export interface EventListener {
+    _name: string;
+    _eventListener?: MessageListener | UserListener | OngoingCallListener | CallListener | GroupListener | LoginListener | ConnectionListener;
+}
+/** @internal */
+export declare class Listener implements EventListener {
+    _name: string;
+    _callback: Function;
+    constructor(name: string, callback: Function);
+}
+/** @internal */
+export declare class MessagesListener extends Listener implements EventListener {
+    _cursor?: number;
+    _eventListener: MessageListener;
+    constructor(name: string, messageEventListener?: MessageListener, cursor?: number, callback?: Function);
+}
+/** @internal */
+export declare class UsersListener extends Listener implements EventListener {
+    _cursor?: number;
+    _eventListener: UserListener;
+    constructor(name: string, userEventHandler?: UserListener, cursor?: number, callback?: Function);
+}
+/** @internal */
+export declare class GroupsListener extends Listener implements EventListener {
+    _cursor?: number;
+    _eventListener: GroupListener;
+    constructor(name: string, groupEventHandler?: GroupListener, cursor?: number, callback?: Function);
+}
+/** @internal */
+export declare class UserCallListener extends Listener implements EventListener {
+    _cursor?: number;
+    _eventListener: OngoingCallListener;
+    constructor(callEventHandler?: OngoingCallListener, cursor?: number, callback?: Function);
+}
+/** @internal */
+export declare class CallsListener extends Listener implements EventListener {
+    _cursor?: number;
+    _eventListener: CallListener;
+    constructor(name: string, callEventListner?: CallListener, cursor?: number, callback?: Function);
+}
+/** @internal */
+export declare class UserLoginListener extends Listener implements EventListener {
+    _cursor?: number;
+    _eventListener: LoginListener;
+    constructor(name: string, loginEventHandler?: LoginListener, cursor?: number, callback?: Function);
+}
+/** @internal */
+export declare class WSConnectionListener extends Listener implements EventListener {
+    _cursor?: number;
+    _eventListener: ConnectionListener;
+    constructor(name: string, connectionEventHandler?: ConnectionListener, cursor?: number, callback?: Function);
+}

package/dist/type/lib/models/MediaDevice.d.ts

@@ -0,0 +1,36 @@
+export declare class MediaDevice {
+    private id;
+    private name;
+    private active;
+    constructor(id: string, name: string, active: boolean);
+    /**
+     * Method to get ID of the media device.
+     * @returns {string}
+    */
+    getId(): string;
+    /**
+     * Method to set ID of the media device.
+     * @param {string} id
+    */
+    setId(id: string): void;
+    /**
+     * Method to get name of the media device.
+     * @returns {string}
+    */
+    getName(): string;
+    /**
+     * Method to set name of the media device.
+     * @param {string} name
+    */
+    setName(name: string): void;
+    /**
+     * Method to check if the media device is active or not.
+     * @returns {boolean}
+    */
+    getIsActive(): boolean;
+    /**
+     * Method to set the media device as active.
+     * @param {boolean} active
+    */
+    setIsActive(active: boolean): void;
+}

package/dist/type/lib/models/MediaMessage.d.ts

@@ -0,0 +1,115 @@
+/**
+ *
+ * @module MediaMessage
+ */
+import { BaseMessage } from "./BaseMessage";
+import { Message } from "./BaseMessage";
+import { User } from "./UserModel";
+import { Attachment } from './attachment';
+import { Group } from "./Group";
+export declare class MediaMessage extends BaseMessage implements Message {
+    /** @private */ static readonly TYPE: {
+        TEXT: string;
+        MEDIA: string;
+        IMAGE: string;
+        VIDEO: string;
+        AUDIO: string;
+        FILE: string;
+        CUSTOM: string;
+    };
+    /** @private */ static readonly RECEIVER_TYPE: {
+        USER: string;
+        GROUP: string;
+    };
+    /** @private */ static readonly CATEGORY: {
+        MESSAGE: string;
+        ACTION: string;
+        CALL: string;
+        CUSTOM: string;
+    };
+    private url;
+    private file;
+    private files;
+    private _metaData;
+    protected data?: any;
+    private caption;
+    private tags?;
+    constructor(receiverId: string, file: object | string | Array<object> | any, type: string, receiverType: string);
+    /**
+     * Method to set caption for the media message.
+     * @param {string} text
+    */
+    setCaption(text: string): void;
+    /**
+     * Method to get caption of the media message.
+     * @returns {string}
+    */
+    getCaption(): string;
+    /**
+     * Method to get sender of the message.
+     * @returns {User}
+    */
+    getSender(): User;
+    /**
+     * Method to get receiver of the message.
+     * @returns {User | Group}
+    */
+    getReceiver(): User | Group;
+    /**
+     * Method to get metadata of the message.
+     * @returns {Object}
+    */
+    getMetadata(): Object;
+    /**
+     * Method to set metadata of the message.
+     * @param {Object} metadata
+    */
+    setMetadata(metadata: Object): void;
+    /**
+     * Method to get data of the message.
+     * @returns {Object}
+    */
+    getData(): Object;
+    /**
+     * Method to set data of the message.
+     * @param {Object} value
+    */
+    setData(value: Object): void;
+    /**
+     * Method to get attachment of media message.
+     * @returns {Attachment}
+    */
+    getAttachment(): Attachment;
+    /**
+     * Method to set attachment of media message.
+     * @param {Attachment} attachment
+    */
+    setAttachment(attachment: Attachment): void;
+    /**
+     * Method to get all the attachments of media message.
+     * @returns {Array<Attachment>}
+    */
+    getAttachments(): Array<Attachment>;
+    /**
+     * Method to set multiple attachments of media message.
+     * @param {Array<Attachment>} attachments
+    */
+    setAttachments(attachments: Array<Attachment>): void;
+    /**
+     * Method to get URL of the media file.
+     * @returns {string}
+    */
+    getURL(): string;
+    /**
+     * Get the tags of the message.
+     * @returns {Array<String>}
+    */
+    getTags(): Array<String>;
+    /**
+     * @param {Array<String>} tags
+     * Set the tags for the message.
+    */
+    setTags(tags: Array<String>): void;
+    private getSenderFromData;
+    private getReceiverFromData;
+}

package/dist/type/lib/models/MessageReceipt.d.ts

@@ -0,0 +1,99 @@
+/**
+ *
+ * @module MessageReceipt
+ */
+import { User } from "./UserModel";
+export declare class MessageReceipt {
+    RECEIPT_TYPE: {
+        READ_RECEIPT: string;
+        DELIVERY_RECEIPT: string;
+    };
+    private receiptType;
+    private sender;
+    private receiver;
+    private timestamp;
+    private readAt;
+    private deliveredAt;
+    private messageId;
+    private receiverType;
+    /**
+     * Method to get receiver type of the message receipt.
+     * @returns {string}
+    */
+    getReceiverType(): string;
+    /**
+     * Method to set receiver type of the message receipt.
+     * @param {string} receiverType
+    */
+    setReceiverType(receiverType: string): void;
+    /**
+     * Method to get sender of the message receipt.
+     * @returns {User}
+    */
+    getSender(): User;
+    /**
+     * Method to set sender of the message receipt.
+     * @param {User} sender
+    */
+    setSender(sender: User): void;
+    /**
+     * Method to get receiver of the message receipt.
+     * @returns {string}
+    */
+    getReceiver(): string;
+    /**
+     * Method to set receiver of the message receipt.
+     * @param {string} receiver
+    */
+    setReceiver(receiver: string): void;
+    /**
+     * Method to get timestamp of the message receipt.
+     * @returns {string}
+    */
+    getTimestamp(): string;
+    /**
+     * Method to set timestamp of the message receipt.
+     * @param {string} timestamp
+    */
+    setTimestamp(timestamp: string): void;
+    /**
+     * Method to set readAt timestamp of the message receipt.
+     * @param {number} readAt
+    */
+    setReadAt(readAt: number): void;
+    /**
+     * Method to get readAt timestamp of the message receipt.
+     * @returns {number}
+    */
+    getReadAt(): number;
+    /**
+     * Method to set deliveredAt timestamp of the message receipt.
+     * @param {number} deliveredAt
+    */
+    setDeliveredAt(deliveredAt: number): void;
+    /**
+     * Method to get deliveredAt timestamp of the message receipt.
+     * @returns {number}
+    */
+    getDeliveredAt(): number;
+    /**
+     * Method to get the message ID.
+     * @returns {string}
+    */
+    getMessageId(): string;
+    /**
+     * Method to set the message ID.
+     * @param {string} messageId
+    */
+    setMessageId(messageId: string): void;
+    /**
+     * Method to get the receipt type of message receipt.
+     * @returns {string}
+    */
+    getReceiptType(): string;
+    /**
+     * Method to set the receipt type of message receipt.
+     * @param {string} receiptType
+    */
+    setReceiptType(receiptType?: string): void;
+}

package/dist/type/lib/models/RTCUser.d.ts

@@ -0,0 +1,18 @@
+export declare class RTCUser {
+    private uid;
+    private avatar;
+    private name;
+    private jwt;
+    private resource;
+    constructor(uid: string);
+    setUID(uid: string): void;
+    getUID(): string;
+    setName(name: string): void;
+    getName(): string;
+    setAvatar(avatar: string): void;
+    getAvatar(): string;
+    setJWT(jwt: string): void;
+    getJWT(): string;
+    setResource(resource: string): void;
+    getResource(): string;
+}

package/dist/type/lib/models/TextMessage.d.ts

@@ -0,0 +1,84 @@
+/**
+ *
+ * @module TextMessage
+ */
+import { BaseMessage, Message } from "./BaseMessage";
+import { User } from "./UserModel";
+import { Group } from "./Group";
+export declare class TextMessage extends BaseMessage implements Message {
+    /** @private */ static readonly TYPE: string;
+    /** @private */ static readonly RECEIVER_TYPE: {
+        USER: string;
+        GROUP: string;
+    };
+    /** @private */ static readonly CATEGORY: string;
+    private text?;
+    private data?;
+    private processedText?;
+    private tags?;
+    /**
+     *Creates an instance of TextMessage.
+     * @param {string} receiverUid
+     * @param {string} text
+     * @param {string} senderUid
+     * @param {string} receiverType
+     * @memberof TextMessage
+     */
+    constructor(receiverId: string, text: string, receiverType: string);
+    /**
+     * Method to get sender of the message.
+     * @returns {User}
+    */
+    getSender(): User;
+    /**
+     * Method to get receiver of the message.
+     * @returns {User | Group}
+    */
+    getReceiver(): User | Group;
+    /**
+     * Method to get metadata of the message.
+     * @returns {Object}
+    */
+    getMetadata(): Object;
+    /**
+     * Method to set metadata of the message.
+     * @param {Object} value
+    */
+    setMetadata(value: Object): void;
+    /**
+     * Method to get data of the message.
+     * @returns {Object}
+    */
+    getData(): any;
+    /**
+     * Method to set data of the message.
+     * @param {Object} value
+    */
+    setData(value: string): void;
+    /**
+     * Method to get text of the message.
+     * @returns {string}
+    */
+    getText(): string;
+    /**
+     * Method to set text of the message.
+     * @param {string} text
+    */
+    setText(text: string): void;
+    /** @internal */
+    setProcessedText(text: string): void;
+    /** @internal */
+    getProcessedText(): string;
+    /**
+     * Get the tags of the message.
+     * @returns {Array<String>}
+    */
+    getTags(): Array<String>;
+    /**
+     * @param {Array<String>} tags
+     * Set the tags for the message.
+    */
+    setTags(tags: Array<String>): void;
+    private getSenderFromData;
+    private getReceiverFromData;
+}

package/dist/type/lib/models/TransientMessage.d.ts

@@ -0,0 +1,48 @@
+import { User } from './UserModel';
+export declare class TransientMessage {
+    private receiverId;
+    private receiverType;
+    private data;
+    private sender?;
+    constructor(receiverId: string, receiverType: string, data: any);
+    /**
+     * Method to get receiverID of the transient message.
+     * @returns {string}
+    */
+    getReceiverId(): string;
+    /**
+     * Method to set receiverID of the transient message.
+     * @param {string} receiverId
+    */
+    setReceiverId(receiverId: string): void;
+    /**
+     * Method to get receiver type of the transient message.
+     * @returns {string}
+    */
+    getReceiverType(): string;
+    /**
+     * Method to set receiver type of the transient message.
+     * @param {string} receiverType
+    */
+    setReceiverType(receiverType: string): void;
+    /**
+     * Method to get data of the transient message.
+     * @returns {any}
+    */
+    getData(): any;
+    /**
+     * Method to set data of the transient message.
+     * @param {any} data
+    */
+    setData(data: any): void;
+    /**
+     * Method to get sender of the transient message.
+     * @returns {User}
+    */
+    getSender(): User;
+    /**
+     * Method to set sender of the transient message.
+     * @param {User} sender
+    */
+    setSender(sender: User): void;
+}

package/dist/type/lib/models/TypingNotification.d.ts

@@ -0,0 +1,52 @@
+/**
+ *
+ * @module TypingIndicator
+ */
+import { User } from './UserModel';
+export declare class TypingIndicator {
+    private receiverType?;
+    private receiverId?;
+    private metadata?;
+    private sender?;
+    constructor(receiverId?: string, receiverType?: string, meta?: any);
+    /**
+     * Method to get receiver type of the transient message.
+     * @returns {string}
+    */
+    getReceiverType(): string;
+    /**
+     * Method to set receiver type of the transient message.
+     * @param {string} receiverType
+    */
+    setReceiverType(receiverType: string): void;
+    /**
+     * Method to get receiverID of typing indicator.
+     * @returns {string}
+    */
+    getReceiverId(): string;
+    /**
+     * Method to set receiverID of typing indicator.
+     * @param {string} receiverId
+    */
+    setReceiverId(receiverId: string): void;
+    /**
+     * Method to get metadata of the transient message.
+     * @returns {string}
+    */
+    getMetadata(): string;
+    /**
+     * Method to set metadata of the transient message.
+     * @param {string} meta
+    */
+    setMetadata(meta: string): void;
+    /**
+     * Method to get sender of the transient message.
+     * @returns {User}
+    */
+    getSender(): User;
+    /**
+     * Method to set sender of the transient message.
+     * @param {User} sender
+    */
+    setSender(sender: User): void;
+}