@cometchat/chat-sdk-javascript 4.0.0-beta1

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

@@ -0,0 +1,159 @@
+/**
+ *
+ * @module Call
+ */
+import { BaseMessage, Message } from "./BaseMessage";
+import { Group } from "./Group";
+import { User } from "./UserModel";
+export declare class Call extends BaseMessage implements Message {
+    static readonly TYPE: {
+        TEXT: string;
+        MEDIA: string;
+        IMAGE: string;
+        VIDEO: string;
+        AUDIO: string;
+        FILE: string;
+        CUSTOM: string;
+    };
+    static readonly RECEIVER_TYPE: {
+        USER: string;
+        GROUP: string;
+    };
+    static readonly CATEGORY: {
+        MESSAGE: string;
+        ACTION: string;
+        CALL: string;
+        CUSTOM: string;
+    };
+    static readonly ACTION_TYPE: {
+        TYPE_MEMBER_JOINED: string;
+        TYPE_MEMBER_LEFT: string;
+        TYPE_MEMBER_KICKED: string;
+        TYPE_MEMBER_BANNED: string;
+        TYPE_MEMBER_UNBANNED: string;
+        TYPE_MEMBER_INVITED: string;
+        TYPE_MEMBER_SCOPE_CHANGED: string;
+        TYPE_MESSAGE: string;
+        TYPE_MESSAGE_EDITED: string;
+        TYPE_MESSAGE_DELETED: string;
+        TYPE_MEMBER_ADDED: string;
+    };
+    private sessionId;
+    protected metadata: any;
+    protected action: string;
+    protected rawData: string;
+    protected initiatedAt: number;
+    protected joinedAt: number;
+    protected data: any;
+    protected callInitiator: object;
+    protected callReceiver: object;
+    /**
+     * @memberof {@link CometChat | CometChat }
+     * @param receiverId
+     * @param type
+     * @param receiverType
+     * @param category
+    */
+    constructor(receiverId: any, type: any, receiverType: any, category?: any);
+    /**
+     * Get call initiator entity(User)
+     * @returns {User}
+    */
+    getCallInitiator(): User;
+    /**
+     * @param {User} user
+     * Set details of the call initiator.
+    */
+    setCallInitiator(user: User): void;
+    /**
+     * Get call receiver entity(User/Group)
+     * @returns {User | Group}
+    */
+    getCallReceiver(): Group | User;
+    /**
+     * @param {User | Group} receiver
+     * Set details of the call receiver.
+    */
+    setCallReceiver(receiver: User | Group): void;
+    /** @internal */
+    getData(): object;
+    /** @internal */
+    setData(data: object): void;
+    /**
+     * Get unique session id of the call message.
+     * @returns {string}
+    */
+    getSessionId(): string;
+    /**
+     * @param {string} sessionId
+     * Set unique session id of the call message.
+    */
+    setSessionId(sessionId: string): void;
+    /**
+     * Get JSONObject of data set by developer.
+     * @returns
+     */
+    getMetadata(): any;
+    /**
+     * @param {any} metadata
+     * Set metadata of the call message.
+    */
+    setMetadata(metadata: any): void;
+    /**
+     * Get sender of the message.
+     * @returns {User}
+    */
+    getSender(): User;
+    /**
+     * Get action of call.
+     * @returns {string}
+    */
+    getAction(): string;
+    /**
+     * @param {string} action
+     * Set action of call.
+    */
+    setAction(action: string): void;
+    /**
+     * Get Call initiated timestamp.
+     * @returns {number}
+     */
+    getInitiatedAt(): number;
+    /**
+     * @param {number} initiatedAt
+     * Set call initiated timestamp.
+    */
+    setInitiatedAt(initiatedAt: number): void;
+    /**
+     * Get Call join timestamp.
+     * @returns {number}
+     */
+    getJoinedAt(): number;
+    /**
+     * @param {number} joinedAt
+     * Set call join timestamp.
+    */
+    setJoinedAt(joinedAt: number): void;
+    /**
+     * Get raw JSON data of the call message.
+     * @returns {any}
+    */
+    getRawData(): any;
+    /**
+     * @param {any} rawData
+     * Set raw JSON data of the call message.
+    */
+    setRawData(rawData: any): void;
+    /**
+     * @internal
+     * @param {string} receiverUid
+     * @param {string} text
+     * @param {string} senderUid
+     * @param {string} receiverType
+     * @memberof Actions
+     */
+    static callFromJSON(rawMessage: any): Call | Message;
+    private getSenderFromData;
+    private getCallInitiatedByFromData;
+    private getCallReceivedByFromData;
+}

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

@@ -0,0 +1,25 @@
+import { CometChatEvent } from "./CometChatEvent";
+export declare class CometChatAuthEvent extends CometChatEvent {
+    protected status: string;
+    protected code: string;
+    protected auth: string;
+    protected deviceId: string;
+    protected presenceSubscription: string;
+    protected params: Object;
+    constructor(appId: string, receiver: string, receiverType: string, sender: string, deviceId: string);
+    getStatus(): string;
+    setStatus(status: string): void;
+    getCode(): string;
+    setCode(code: string): void;
+    setAuth(auth: string): void;
+    getAuth(): string;
+    setPresenceSubscription(presenceSubscription: string): void;
+    getPresenceSubscription(): string;
+    setDeviceId(deviceId: string): void;
+    getdeviceId(): string;
+    setExtraParmaeters(params: Object): void;
+    getExtraParameters(): Object;
+    getAsString(): string;
+    getAsJSONObject(): Object;
+    static getAuthEventFromJSON(message: any): CometChatAuthEvent;
+}

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

@@ -0,0 +1,25 @@
+export declare class CometChatEvent {
+    protected appId: string;
+    protected receiver: string;
+    protected receiverType: string;
+    protected type: string;
+    protected deviceId: string;
+    protected sender: string;
+    protected messageSender: string;
+    constructor(appId: string, receiver: string, receiverType: string, sender: string, deviceId: string, messageSender?: string);
+    getAppId(): string;
+    setAppId(appId: string): void;
+    getReceiver(): string;
+    setReceiver(receiver: string): void;
+    getSender(): string;
+    setSender(sender: string): void;
+    getReceiverType(): string;
+    setReceiverType(receiverType: string): void;
+    getType(): string;
+    setType(type: string): void;
+    getDeviceId(): string;
+    setDeviceId(deviceId: string): void;
+    getMessageSender(): string;
+    setMessageSender(messageSender: string): void;
+    protected getCometChatEventJSON(): Object;
+}

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

@@ -0,0 +1,9 @@
+import { BaseMessage } from "./BaseMessage";
+import { CometChatEvent } from "./CometChatEvent";
+export declare class CometChatMessageEvent extends CometChatEvent {
+    protected message: BaseMessage;
+    constructor(appId: string, receiver: string, receiverType: string, sender: string, deviceId: string);
+    getMessage(): BaseMessage;
+    setMessage(message: BaseMessage): void;
+    static getMessageEventFromJSON(message: any): CometChatMessageEvent;
+}

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

@@ -0,0 +1,6 @@
+import { CometChatEvent } from "./CometChatEvent";
+export declare class CometChatPingEvent extends CometChatEvent {
+    constructor(appId: string, receiver: string, receiverType: string, sender: string, deviceId: string);
+    getAsString(): string;
+    getAsJSONObject(): Object;
+}

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

@@ -0,0 +1,15 @@
+import { CometChatEvent } from "./CometChatEvent";
+import { User } from "./UserModel";
+export declare class CometChatPresenceEvent extends CometChatEvent {
+    protected action: string;
+    protected user: User;
+    protected timestamp: number;
+    constructor(appId: string, receiver: string, receiverType: string, sender: string, deviceId: string);
+    getAction(): string;
+    setAction(action: string): void;
+    getUser(): User;
+    setUser(user: User): void;
+    getTimestamp(): number;
+    setTimestamp(timestamp: number): void;
+    static getPresenceEventFromJSON(message: any): CometChatPresenceEvent;
+}

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

@@ -0,0 +1,14 @@
+import { CometChatEvent } from "./CometChatEvent";
+import { MessageReceipt } from "./MessageReceipt";
+export declare class CometChatReceiptEvent extends CometChatEvent {
+    protected action: string;
+    protected receipt: MessageReceipt;
+    constructor(appId: string, receiver: string, receiverType: string, sender: string, deviceId: string, messageSender?: string);
+    getAction(): string;
+    setAction(action: string): void;
+    getMessageReceipt(): MessageReceipt;
+    setMessageReceipt(receipt: MessageReceipt): void;
+    getAsString(): string;
+    getAsJSONObject(): Object;
+    static getReceiptEventFromJSON(message: any): CometChatReceiptEvent;
+}

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

@@ -0,0 +1,11 @@
+import { CometChatEvent } from "./CometChatEvent";
+import { TransientMessage } from "./TransientMessage";
+export declare class CometChatTransientEvent extends CometChatEvent {
+    protected transientMessage: TransientMessage;
+    constructor(appId: string, receiver: string, receiverType: string, sender: string, deviceId: string);
+    getTransientMessage(): TransientMessage;
+    setTransientMessage(transientMessage: TransientMessage): void;
+    getAsString(): string;
+    getAsJSONObject(): Object;
+    static getTransientEventFromJSON(message: any): CometChatTransientEvent;
+}

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

@@ -0,0 +1,14 @@
+import { CometChatEvent } from "./CometChatEvent";
+import { TypingIndicator } from "./TypingNotification";
+export declare class CometChatTypingEvent extends CometChatEvent {
+    protected action: string;
+    protected typingIndicator: TypingIndicator;
+    constructor(appId: string, receiver: string, receiverType: string, sender: string, deviceId: string);
+    getAction(): string;
+    setAction(action: string): void;
+    getTypingIndicator(): TypingIndicator;
+    setTypingIndicator(typing: TypingIndicator): void;
+    getAsString(): string;
+    getAsJSONObject(): Object;
+    static getTypingEventFromJSON(message: any): CometChatTypingEvent;
+}

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

@@ -0,0 +1,73 @@
+/**
+ *
+ * @module Conversation
+ */
+import { User } from './UserModel';
+import { Group } from './Group';
+import { TextMessage } from './TextMessage';
+import { MediaMessage } from './MediaMessage';
+import { CustomMessage } from './CustomMessage';
+export declare class Conversation {
+    protected conversationId: string;
+    protected conversationType: string;
+    protected lastMessage: TextMessage | MediaMessage | CustomMessage | any;
+    protected conversationWith: User | Group;
+    protected unreadMessageCount: number;
+    protected tags: Array<String>;
+    constructor(conversationId: string, conversationType: string, lastMessage: TextMessage | MediaMessage | CustomMessage | any, conversationWith: User | Group, unreadMessageCount: number, tags: Array<String>);
+    /**
+     * Method to set conversation ID of the conversation.
+     * @param {string} conversationId
+    */
+    setConversationId(conversationId: string): void;
+    /**
+     * Method to set conversation type of the conversation.
+     * @param {string} conversationId
+    */
+    setConversationType(conversationType: string): void;
+    /**
+     * Method to set last message of the conversation.
+     * @param {TextMessage | MediaMessage | CustomMessage | any} conversationId
+    */
+    setLastMessage(lastMessage: TextMessage | MediaMessage | CustomMessage | any): void;
+    /**
+     * Method to set conversationWith of the conversation.
+     * @param {User | Group} conversationId
+    */
+    setConversationWith(conversationWith: User | Group): void;
+    /**
+     * Method to set unread message count of the conversation.
+     * @param {number} conversationId
+    */
+    setUnreadMessageCount(unreadMessageCount: number): void;
+    /**
+     * Method to get conversation ID of the conversation.
+     * @returns {string}
+    */
+    getConversationId(): string;
+    /**
+     * Method to get conversation type of the conversation.
+     * @returns {string}
+    */
+    getConversationType(): string;
+    /**
+     * Method to get last message of the conversation.
+     * @returns {TextMessage | MediaMessage | CustomMessage | any}
+    */
+    getLastMessage(): TextMessage | MediaMessage | CustomMessage | any;
+    /**
+     * Method to get conversationWith of the conversation.
+     * @returns {User | Group}
+    */
+    getConversationWith(): User | Group;
+    /**
+     * Method to get unread message count of the conversation.
+     * @returns {number}
+    */
+    getUnreadMessageCount(): number;
+    /**
+     * Method to get tags of conversation.
+     * @returns {Array<String>}
+    */
+    getTags(): Array<String>;
+}

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

@@ -0,0 +1,13 @@
+/**
+ *
+ * @module CometChatException
+ * @implements {ErrorModel}
+ */
+import { ErrorModel } from "./ErrorModel";
+export declare class CometChatException implements ErrorModel {
+    code?: string | number;
+    name?: string;
+    message?: string;
+    details?: string;
+    constructor(errorModel: ErrorModel);
+}

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

@@ -0,0 +1,71 @@
+/**
+ *
+ * @module CustomMessage
+ */
+import { BaseMessage, Message } from "./BaseMessage";
+import { User } from "./UserModel";
+import { Group } from "./Group";
+export declare class CustomMessage extends BaseMessage implements Message {
+    private customData;
+    private subType;
+    private data?;
+    private tags?;
+    constructor(...args: any[]);
+    /**
+     * Method to get custom data of the message.
+     * @returns {Object}
+     */
+    getCustomData(): Object;
+    /**
+     * Method to set custom data of the message.
+     * @param {Object} customData
+     */
+    setCustomData(customData: Object): void;
+    /**
+     * Method to get sender of the message.
+     * @returns {User}
+     */
+    getSender(): User;
+    /**
+     * Method to get receiver of the message.
+     * @returns {User | Group}
+     */
+    getReceiver(): User | Group;
+    /**
+     * Methhod to get sub type of the message.
+     * @returns {string}
+     */
+    getSubType(): string;
+    /**
+     * Method to set sub type of the message.
+     * @param {string} subType
+     */
+    setSubType(subType: string): void;
+    /**
+     * 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
+     */
+    getData(): any;
+    /**
+     * 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/ErrorModel.d.ts

@@ -0,0 +1,12 @@
+/**
+ *
+ *
+ * @export
+ * @interface ErrorModel
+ */
+export interface ErrorModel {
+    code?: string | number;
+    name?: string;
+    message?: string;
+    details?: string;
+}

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

@@ -0,0 +1,190 @@
+/**
+ *
+ * @module Group
+ */
+import { GroupType } from "../Constants";
+export declare class Group {
+    /** @private */ static readonly TYPE: typeof GroupType;
+    /** @private */ static readonly Type: typeof GroupType;
+    private guid;
+    private name;
+    private type;
+    private password;
+    private icon;
+    private description;
+    private owner;
+    private metadata;
+    private createdAt;
+    private updatedAt;
+    private hasJoined;
+    private wsChannel;
+    private scope;
+    private joinedAt;
+    private membersCount;
+    private tags;
+    /**
+     * Creates an instance of Group.
+     * @param {string} guid
+     * @param {string} name
+     * @param {GroupType} type
+     * @param {string} [passsword]
+     * @param {string} [icon]
+     * @param {string} [description]
+     * @memberof Group
+     */
+    constructor(guid: string, name?: string, type?: GroupType | string, passsword?: string, icon?: string, description?: string, hasJoined?: boolean);
+    /**
+     * Method to get GUID of the group.
+     * @returns {string}
+    */
+    getGuid(): string;
+    /**
+     * Method to set GUID of the group.
+     * @param {string} guid
+    */
+    setGuid(guid: string): void;
+    /**
+     * Method to get name of the group.
+     * @returns {string}
+    */
+    getName(): string;
+    /**
+     * Method to set name of the group.
+     * @param {string} name
+    */
+    setName(name: string): void;
+    /**
+     * Method to get the type of the group.
+     * @returns {GroupType | string}
+    */
+    getType(): GroupType | string;
+    /**
+     * Method to set the type of the group.
+     * @param {GroupType | string} type
+    */
+    setType(type: GroupType | string): void;
+    /**
+     * Method to get password of the group.
+     * @returns {string}
+    */
+    getPassword(): string;
+    /**
+     * Method to set password of the group.
+     * @param {string} password
+    */
+    setPassword(password: string): void;
+    /**
+     * Method to get icon of the group.
+     * @returns {string}
+    */
+    getIcon(): string;
+    /**
+     * Method to set icon of the group.
+     * @param {string} icon
+    */
+    setIcon(icon: string): void;
+    /**
+     * Method to get description of the group.
+     * @returns {string}
+    */
+    getDescription(): string;
+    /**
+     * Method to set description of the group.
+     * @param {string} description
+    */
+    setDescription(description: string): void;
+    /**
+     * Method to get owner of the group.
+     * @returns {string}
+    */
+    getOwner(): string;
+    /**
+     * Method to set owner of the group.
+     * @param {string} owner
+    */
+    setOwner(owner: string): void;
+    /**
+     * Method to get metadata of the group.
+     * @returns {string}
+    */
+    getMetadata(): string;
+    /**
+     * Method to set metadata of the group.
+     * @param {string} metadata
+    */
+    setMetadata(metadata: string): void;
+    /**
+     * Method to get the created at timestamp of the group.
+     * @returns {number}
+    */
+    getCreatedAt(): number;
+    /**
+     * Method to set the created at timestamp of the group.
+     * @param {number} createdAt
+    */
+    setCreatedAt(createdAt: number): void;
+    /**
+     * Method to get the updated at timestamp of the group.
+     * @returns {number}
+    */
+    getUpdatedAt(): number;
+    /**
+     * Method to set updated at timestamp of the group.
+     * @param {number} updatedAt
+    */
+    setUpdatedAt(updatedAt: number): void;
+    /**
+     * Method to get the joinedAt of the group.
+     * @returns {boolean}
+    */
+    getHasJoined(): boolean;
+    /**
+     * Method to set the joinedAt of the group.
+     * @param {boolean} hasJoined
+    */
+    setHasJoined(hasJoined: boolean): void;
+    /** @private */
+    getWsChannel(): any;
+    /** @private */
+    setWsChannel(wsChannel: any): void;
+    /**
+     * Method to set scope of the logged-in user in the group.
+     * @param {string} scope
+    */
+    setScope(scope: string): void;
+    /**
+     * Method to get scope of the logged-in user.
+     * @returns {string}
+    */
+    getScope(): string;
+    /**
+     * Method to get joinedAt timestamp of the logged-in user.
+     * @returns {string}
+    */
+    getJoinedAt(): string;
+    /**
+     * Method to set joinedAt timestamp of the logged-in user in the group.
+     * @param {string} joinedAt
+    */
+    setJoinedAt(joinedAt: string): void;
+    /**
+     * Method to get members count of the group.
+     * @returns {number}
+    */
+    getMembersCount(): number;
+    /**
+     * Method to set members count of the group.
+     * @param {number} membersCount
+    */
+    setMembersCount(membersCount: number): void;
+    /**
+     * Method to set tags of the group.
+     * @param {string[]} tags
+    */
+    setTags(tags: Array<String>): void;
+    /**
+     * Method to get tags of the group.
+     * @returns {string[]}
+    */
+    getTags(): Array<String>;
+}

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

@@ -0,0 +1,43 @@
+/**
+ *
+ * @module GroupMember
+*/
+import { User } from "./UserModel";
+import { GroupMemberScope } from "../Constants";
+export declare class GroupMember extends User {
+    private static readonly GroupMemberScope;
+    private scope;
+    private joinedAt;
+    private guid;
+    constructor(uid: string, scope?: string);
+    /**
+     * Method to set scope of the group member.
+     * @param {GroupMemberScope} scope
+    */
+    setScope(scope: GroupMemberScope): void;
+    /**
+     * Method to set joinedAt of the group member.
+     * @param {number} joinedAt
+    */
+    setJoinedAt(joinedAt: number): void;
+    /**
+     * Method to set guid of the group member.
+     * @param {string} guid
+    */
+    setGuid(guid: string): void;
+    /**
+     * Method to get scope of the group member.
+     * @returns {string}
+    */
+    getScope(): string;
+    /**
+     * Method to get joinedAt of the group member.
+     * @returns {number}
+    */
+    getJoinedAt(): number;
+    /**
+     * Method to get guid of the group member.
+     * @returns {string}
+    */
+    getGuid(): string;
+}