@cometchat/chat-sdk-javascript
Version:
A complete chat solution.
1,284 lines (1,281 loc) • 299 kB
TypeScript
// Generated by dts-bundle v0.7.3
/**
*Initialises and returns the CometChat singleton object.
*
* @export
* @param {string} appId appId generted at the time of perchase. unique for each client.
* @returns {CometChat}
*/
export function init(appId: string): CometChat;
export as namespace CometChat;
export as namespace CometChatNotifications;
export class CometChat {
static AIAssistantBaseEvent: typeof AIAssistantBaseEvent;
static AIAssistantRunStartedEvent: typeof AIAssistantRunStartedEvent;
static AIAssistantRunFinishedEvent: typeof AIAssistantRunFinishedEvent;
static AIAssistantMessageStartedEvent: typeof AIAssistantMessageStartedEvent;
static AIAssistantMessageEndedEvent: typeof AIAssistantMessageEndedEvent;
static AIAssistantContentReceivedEvent: typeof AIAssistantContentReceivedEvent;
static AIAssistantToolStartedEvent: typeof AIAssistantToolStartedEvent;
static AIAssistantToolEndedEvent: typeof AIAssistantToolEndedEvent;
static AIAssistantToolArgumentEvent: typeof AIAssistantToolArgumentEvent;
static AIAssistantToolResultEvent: typeof AIAssistantToolResultEvent;
static AI_ASSISTANT_EVENTS: {
RUN_STARTED: string;
RUN_FINISHED: string;
TEXT_MESSAGE_START: string;
TEXT_MESSAGE_END: string;
TEXT_MESSAGE_CONTENT: string;
TOOL_CALL_STARTED: string;
TOOL_CALL_ENDED: string;
TOOL_CALL_RESULT: string;
TOOL_CALL_ARGUMENT: string;
};
static GroupType: typeof GroupType;
static GroupMemberScope: typeof GroupMemberScope;
static ResponseConstants: {
RESPONSE_KEYS: {
KEY_DATA: string;
KEY_META: string;
KEY_CURSOR: string;
KEY_NEXT: string;
KEY_PREVIOUS: string;
KEY_ACTION: string;
KEY_MESSAGE: string;
KEY_ERROR: string;
KEY_ERROR_DETAILS: string;
KEY_ERROR_CODE: string;
KEY_ERROR_MESSAGE: string;
KEY_AUTH_TOKEN: string;
KEY_WS_CHANNEL: string;
KEY_IDENTITY: string;
KEY_SERVICE: string;
KEY_ENTITIES: string;
KEY_REACTIONS: string;
KEY_ENTITITY: string;
KEY_ENTITYTYPE: string;
KEY_ATTACHMENTS: string;
CODE_REQUEST_OK: number;
CODE_BAD_REQUEST: number;
UNREAD_UNDELIVERED_KEYS: {
ENTITY: string;
ENTITY_TYPE: string;
ENTITY_Id: string;
COUNT: string;
};
GROUP_MEMBERS_RESPONSE: {
SUCCESS: string;
ERROR: string;
MESSAGE: string;
};
KEY_ENTITY_TYPE: {
USER: string;
GROUP: string;
};
KEY_CONVERSATION_STARTER: string;
KEY_SMART_REPLIES: string;
KEY_CONVERSATION_SUMMARY: string;
KEY_BOT_REPLY: string;
};
};
static CallConstants: {
CALL_MODE: {
DEFAULT: string;
SPOTLIGHT: string;
SINGLE: string;
TILE: string;
GRID: string;
};
CALL_TYPE: {
AUDIO: string;
VIDEO: string;
};
RECEIVER_TYPE_GROUP: string;
RECEIVER_TYPE_USER: string;
CALL_KEYS: {
CALL_DATA: string;
CALL_ID: string;
CALL_SESSION_ID: string;
CALL_RECEIVER: string;
CALL_SENDER: string;
CALL_RECEIVER_TYPE: string;
CALL_STATUS: string;
CALL_TYPE: string;
CALL_INITIATED_AT: string;
CALL_JOINED_AT: string;
CALL_LEFT_AT: string;
CALL_METADATA: string;
CALL_ENTITIES: string;
CALL_ENTITY_TYPE: string;
CALL_ENTITY: string;
CALL_ENTITY_USER: string;
CALL_ENTITY_GROUP: string;
};
CALL_STATUS: {
INITIATED: string;
ONGOING: string;
UNANSWERED: string;
REJECTED: string;
BUSY: string;
CANCELLED: string;
ENDED: string;
};
AUDIO_INPUT_DEVICES: string;
AUDIO_OUTPUT_DEVICES: string;
VIDEO_INPUT_DEVICES: string;
POST_MESSAGES: {
TYPES: {
ACTION_MESSAGE: string;
HANGUP: string;
COMETCHAT_RTC_SETTINGS: string;
};
ACTIONS: {
USER_JOINED: string;
USER_LEFT: string;
USER_LIST_CHANGED: string;
INITIAL_DEVICE_LIST: string;
DEVICE_CHANGE: string;
LOAD: string;
CHANGE_AUDIO_INPUT: string;
CHANGE_AUDIO_OUTPUT: string;
CHANGE_VIDEO_INPUT: string;
MUTE_AUDIO: string;
UNMUTE_AUDIO: string;
PAUSE_VIDEO: string;
UNPAUSE_VIDEO: string;
SWITCH_MODE: string;
START_SCREENSHARE: string;
STOP_SCREENSHARE: string;
END_CALL: string;
START_RECORDING: string;
STOP_RECORDING: string;
RECORDING_TOGGLED: string;
USER_MUTED: string;
SCREEN_SHARE_STARTED: string;
SCREEN_SHARE_STOPPED: string;
SWITCH_TO_VIDEO_CALL: string;
SWITCHED_TO_VIDEO_CALL: string;
OPEN_VIRTUAL_BACKGROUND: string;
SET_BACKGROUND_BLUR: string;
SET_BACKGROUND_IMAGE: string;
};
};
MEDIA_DEVICE: {
ID: string;
NAME: string;
ACTIVE: string;
};
ZOOM_BUTTON_DEFAULT_PARAMS: {
position: string;
visible: boolean;
};
NAME_LABEL_DEFAULT_PARAMS: {
position: string;
visible: boolean;
color: string;
};
NETWORK_LABEL_DEFAULT_PARAMS: {
position: string;
visible: boolean;
};
MAIN_VIDEO_CONTAINER_SETTINGS: {
KEYS: {
POSITION: string;
VISIBILITY: string;
COLOR: string;
};
};
};
static ActionConstatnts: {
ACTION_SUBJECTS: {
ACTION_ON: string;
ACTION_BY: string;
ACTION_FOR: string;
};
ACTION_ENTITY_TYPE: {
GROUP_USER: string;
USER: string;
GROUP: string;
MESSAGE: string;
};
ACTION_KEYS: {
ACTION_CREATED: string;
ACTION_UPDATED: string;
ACTION_DELETED: string;
ENTITIES: string;
ENTITY: string;
ENTITY_TYPE: string;
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_ADDED: string;
ACTION_SCOPE_CHANGED: string;
ACTION_TYPE_USER: string;
ACTION_TYPE_GROUP: string;
ACTION_TYPE_GROUP_MEMBER: string;
TYPE_MESSAGE_EDITED: string;
TYPE_MESSAGE_DELETED: string;
ACTION_TYPE_CALL: string;
EXTRAS: string;
SCOPE: string;
NEW: string;
OLD: string;
};
ActionMessages: {
ACTION_GROUP_JOINED_MESSAGE: string;
ACTION_GROUP_LEFT_MESSAGE: string;
ACTION_MEMBER_KICKED_MESSAGE: string;
ACTION_MEMBER_BANNED_MESSAGE: string;
ACTION_MEMBER_UNBANNED_MESSAGE: string;
ACTION_MEMBER_INVITED_MESSAGE: string;
ACTION_MESSAGE_EDITED_MESSAGE: string;
ACTION_MESSAGE_DELETED_MESSAGE: string;
ACTION_MEMBER_SCOPE_CHANGED: string;
ACTION_MEMBER_ADDED_TO_GROUP: string;
};
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;
};
ACTIONS: {
MEMBER_ADDED: string;
MEMBER_JOINED: string;
MEMBER_LEFT: string;
MEMBER_KICKED: string;
MEMBER_BANNED: string;
MEMBER_UNBANNED: string;
MEMBER_INVITED: string;
MEMBER_SCOPE_CHANGED: string;
MESSAGE_EDITED: string;
MESSSAGE_DELETED: string;
TYPE_USER: string;
TYPE_GROUP: string;
TYPE_GROUP_MEMBER: string;
};
};
static CALL_ERROR: {
CALL_ALREADY_INITIATED: {
code: string;
name: string;
message: string;
details: {};
};
ERROR_IN_CALLING: {
code: string;
name: string;
message: string;
details: {};
};
CANNOT_ACCEPT_CALL: {
code: string;
name: string;
message: string;
details: {};
};
NOT_INITIALIZED: {
code: string;
name: string;
message: string;
details: {};
};
NOT_LOGGED_IN: {
code: string;
name: string;
message: string;
details: {};
};
SESSION_ID_REQUIRED: {
code: string;
name: string;
message: string;
details: {};
};
CALL_SETTINGS_REQUIRED: {
code: string;
name: string;
message: string;
details: {};
};
JWT_NOT_FOUND: {
code: string;
name: string;
message: string;
details: {};
};
};
static MessageConstatnts: {
TYPE: {
TEXT: string;
MEDIA: string;
IMAGE: string;
VIDEO: string;
AUDIO: string;
FILE: string;
CUSTOM: string;
ASSISTANT: string;
TOOL_RESULT: string;
TOOL_ARGUMENTS: string;
};
CATEGORY: {
MESSAGE: string;
ACTION: string;
CALL: string;
CUSTOM: string;
INTERACTIVE: string;
AGENTIC: string;
};
RECEIVER_TYPE: {
USER: string;
GROUP: string;
};
KEYS: {
ATTATCHMENT: string;
ATTATCHMENTS: string;
ACTION: string;
TYPE: string;
DATA: string;
ID: string;
MUID: string;
SENDER: string;
RECEIVER: string;
RECEIVER_ID: string;
CATEGORY: string;
RECEIVER_TYPE: string;
SENT_AT: string;
STATUS: string;
TEXT: string;
URL: string;
METADATA: string;
RECEIPTS: string;
MY_RECEIPTS: string;
CUSTOM_DATA: string;
CUSTOM_SUB_TYPE: string;
RESOURCE: string;
MENTIONS: string;
INTERACTIVE_DATA: string;
INTERACTION_GOAL: string;
INTERACTIONS: string;
ALLOW_SENDER_INTERACTION: string;
ELEMENT_ID: string;
INTERACTED_AT: string;
ELEMENT_IDS: string;
RUN_ID: string;
THREAD_ID: string;
TOOL_CALLS: string;
FUNCTION: string;
NAME: string;
ARGUMENTS: string;
TOOL_CALL_ID: string;
DISPLAY_NAME: string;
EXECUTION_TEXT: string;
};
KNOWN_MEDIA_TYPE: {
IMAGE: any[];
VIDEO: any[];
AUDIO: any[];
FILE: any[];
};
PAGINATION: {
AFFIX: {
APPEND: string;
PREPEND: string;
};
CURSOR_FILEDS: {
ID: string;
SENT_AT: string;
};
CURSOR_AFFIX_DEFAULT: string;
CURSOR_FIELD_DEFAULT: string;
KEYS: {
PER_PAGE: string;
CURSOR_AFFIX: string;
AFFIX: string;
CURSOR_FIELD: string;
CURSOR_VALUE: string;
UID: string;
SENT_AT: string;
ID: string;
CURRENT_PAGE: string;
UNREAD: string;
HIDE_MESSAGES_FROM_BLOCKED_USER: string;
SEARCH_KEY: string;
ONLY_UPDATES: string;
UPDATED_AT: string;
CATEGORY: string;
CATEGORIES: string;
TYPE: string;
TYPES: string;
HIDE_REPLIES: string;
HIDE_DELETED_MESSAGES: string;
WITH_TAGS: string;
TAGS: string;
MENTIONS_WITH_TAG_INFO: string;
MENTIONS_WITH_BLOCKED_INFO: string;
ONLY_INTERACTION_GOAL_COMPLETED: string;
HAS_ATTACHMENTS: string;
HAS_LINKS: string;
HAS_MENTIONS: string;
HAS_REACTIONS: string;
MENTIONED_UIDS: string;
ATTACHMENT_TYPES: string;
WITH_PARENT: string;
};
};
};
static APP_SETTINGS: {
APP_SETTINGS: string;
KEYS: {
CHAT_HOST: string;
CHAT_USE_SSL: string;
GROUP_SERVICE: string;
CALL_SERVICE: string;
CHAT_WS_PORT: string;
CHAT_WSS_PORT: string;
CHAT_HTTP_BIND_PORT: string;
CHAT_HTTPS_BIND_PORT: string;
ADMIN_API_HOST: string;
CLIENT_API_HOST: string;
WEBRTC_HOST: string;
WEBRTC_USE_SSL: string;
WEBRTC_WS_PORT: string;
WEBRTC_WSS_PORT: string;
WEBRTC_HTTP_BIND_PORT: string;
WEBRTC_HTTPS_BIND_PORT: string;
EXTENSION_LIST: string;
EXTENSION_KEYS: {
ID: string;
NAME: string;
};
JID_HOST_OVERRIDE: string;
CHAT_HOST_OVERRIDE: string;
CHAT_HOST_APP_SPECIFIC: string;
MODE: string;
CONNECTION_TYPE: string;
DEFAULT_MODE: string;
LIMITED_TRANSIENT: string;
NO_TRANSIENT: string;
POLLING_ENABLED: string;
POLLING_INTERVAL: string;
ANALYTICS_PING_DISABLED: string;
ANALYTICS_HOST: string;
ANALYTICS_VERSION: string;
ANALYTICS_USE_SSL: string;
SETTINGS_HASH: string;
SETTINGS_HASH_RECEIVED_AT: string;
DENY_FALLBACK_TO_POLLING: string;
APP_VERSION: string;
MAIN_DOMAIN: string;
CHAT_API_VERSION: string;
WS_API_VERSION: string;
REGION: string;
EXTENSION_DOMAIN: string;
WEBRTC_API_SUBDOMAIN: string;
WEBRTC_WEB_FRONTEND_HOST: string;
WEBRTC_WEB_FRONTEND_VERSION: string;
SECURED_MEDIA_HOST: string;
PARAMETERS: string;
CORE_CONVERSATIONS_UPDATE_ON_CALL_ACTIVITIES: string;
CORE_CONVERSATIONS_UPDATE_ON_GROUP_ACTIONS: string;
CORE_CONVERSATIONS_UPDATE_ON_CUSTOM_MESSAGES: string;
CORE_CONVERSATIONS_UPDATE_ON_REPLIES: string;
};
};
static GroupConstants: {
KEYS: {
NAME: string;
GUID: string;
TYPE: string;
PASSWORD: string;
ICON: string;
DESCRIPTION: string;
OWNER: string;
METADATA: string;
CREATED_AT: string;
UPDATED_AT: string;
HAS_JOINED: string;
WS_CHANNEL: string;
TAGS: string;
};
};
static TYPING_NOTIFICATION: {
RECEIVER_ID: string;
RECEIVER_TYPE: string;
META: string;
KEYS: {
TYPING_NOTIFICATION: string;
TIMESTAMP: string;
};
ACTIONS: {
STARTED: string;
ENDED: string;
};
};
/**
* @deprecated Use `PresenceConstants` instead.
*/
static PresenceConstatnts: {
STATUS: {
ONLINE: string;
AVAILABLE: string;
OFFLINE: string;
JOINED: string;
LEFT: string;
};
};
static PresenceConstants: {
STATUS: {
ONLINE: string;
AVAILABLE: string;
OFFLINE: string;
JOINED: string;
LEFT: string;
};
};
static APPINFO: {
platform: string;
sdkVersion: string;
apiVersion: string;
sdkVersionWithUnderScore: string;
};
static UserConstants: {
UID: string;
NAME: string;
AUTH_TOKEN: string;
AVATAR: string;
LAST_ACTIVE_AT: string;
LINK: string;
META_DATA: string;
ROLE: string;
STATUS: string;
STATUS_MESSAGE: string;
USER_NAME: string;
TAGS: string;
SORT_BY: {
NAME: string;
STATUS: string;
};
SORT_ORDER: {
ASCENDING: string;
DESCENDING: string;
};
};
static GENERAL_ERROR: {
MUST_BE_A_STRING: {
code: string;
name: string;
message: string;
details: {};
};
MUST_BE_A_NUMBER: {
code: string;
name: string;
message: string;
details: {};
};
MUST_BE_A_OBJECT: {
code: string;
name: string;
message: string;
details: {};
};
MUST_BE_AN_ARRAY: {
code: string;
name: string;
message: string;
details: {};
};
MUST_BE_A_BOOLEAN: {
code: string;
name: string;
message: string;
details: {};
};
MUST_BE_A_BLOB: {
code: string;
name: string;
message: string;
details: {};
};
INVALID: {
code: string;
name: string;
message: string;
details: {};
};
METHOD_COMPULSORY: {
code: string;
name: string;
message: string;
details: {};
};
LIMIT_EXCEEDED: {
code: string;
name: string;
message: string;
details: {};
};
MUST_BE_A_POSITIVE_NUMBER: {
code: string;
name: string;
message: string;
details: {};
};
INVALID_MEDIA_FILE: {
code: string;
name: string;
message: string;
details: {};
};
EMPTY_STRING: {
code: string;
name: string;
message: string;
details: {};
};
MISSING_KEY: {
code: string;
name: string;
message: string;
details: {};
};
EMPTY_ARRAY: {
code: string;
name: string;
message: string;
details: {};
};
INVALID_SEARCH_KEYWORD: {
code: string;
name: string;
message: string;
details: {};
};
INVALID_GROUP_PROPERTY: {
code: string;
name: string;
message: string;
details: {};
};
INVALID_USER_PROPERTY: {
code: string;
name: string;
message: string;
details: {};
};
PARAMETER_MUST_BE_A_NUMBER: {
code: string;
name: string;
message: string;
details: {};
};
PARAMETER_MUST_BE_AN_ARRAY: {
code: string;
name: string;
message: string;
details: {};
};
PARAMETER_MUST_BE_A_BOOLEAN: {
code: string;
name: string;
message: string;
details: {};
};
PARAMETER_MUST_BE_A_POSITIVE_NUMBER: {
code: string;
name: string;
message: string;
details: {};
};
PARAMETER_MUST_BE_A_STRING: {
code: string;
name: string;
message: string;
details: {};
};
PARAMETER_COMPULSORY: {
code: string;
name: string;
message: string;
details: {};
};
PASSWORD_COMPULSORY: {
code: string;
name: string;
message: string;
details: {};
};
INVALID_ARRAY: {
code: string;
name: string;
message: string;
details: {};
};
};
static ConversationErrors: {
INVALID_CONVERSATION_TYPE: {
code: string;
name: string;
message: string;
details: string;
};
CONVERSATION_NOT_FOUND: {
code: string;
name: string;
message: string;
details: string;
};
};
static LOCAL_STORE: {
COMMON_STORE: string;
MESSAGE_LISTENERS_LIST: string;
USERS_STORE: string;
MESSAGES_STORE: string;
KEYS_STORE: string;
STORE_STRING: string;
KEY_STRING: string;
KEY_USER: string;
KEY_APP_SETTINGS: string;
KEY_APP_ID: string;
KEY_DEVICE_ID: string;
KEY_SESSION_ID: string;
KEY_MESSAGE_LISTENER_LIST: string;
};
static SDKHeader: {
platform: string;
sdkVersion: string;
sdk: string;
};
static Errors: {
ERROR_IO_EXCEPTION: string;
ERROR_JSON_EXCEPTION: string;
ERROR_PASSWORD_MISSING: string;
ERROR_LIMIT_EXCEEDED: string;
ERROR_USER_NOT_LOGGED_IN: string;
ERROR_INVALID_GUID: string;
ERROR_PASSWORD_MISSING_MESSAGE: string;
ERROR_LIMIT_EXCEEDED_MESSAGE: string;
ERROR_USER_NOT_LOGGED_IN_MESSAGE: string;
ERROR_INVALID_GUID_MESSAGE: string;
ERROR_DEFAULT_MESSAGE: string;
ERR_SETTINGS_HASH_OUTDATED: string;
ERR_NO_AUTH: string;
};
static SESSION_STORE: {
SESSION_ID: string;
};
static REACTION_ACTION: typeof REACTION_ACTION;
static ExtensionErrors: {
INVALID_EXTENSION: {
code: string;
name: string;
message: string;
details: {};
};
EXTENSION_NOT_FOUND: {
code: string;
name: string;
message: string;
details: {};
};
};
static FeatureRestrictionErrors: {
INVALID_FEATURE: {
code: string;
name: string;
message: string;
details: {};
};
FEATURE_NOT_FOUND: {
code: string;
name: string;
message: string;
details: {};
};
};
static WS: {
CONVERSATION: {
TYPE: {
CHAT: string;
GROUP_CHAT: string;
};
};
};
static JWT_API: {
KEYS: {
PASSTHROUGH: string;
EXPAND: string;
};
};
static PROSODY_API: {
DOMAIN_PREFIX: string;
PATH: {
ROOM: string;
ROOM_SIZE: string;
SESSIONS: string;
};
RESPONSE: {
PARTICIPANTS: string;
};
QUERY_PARAMETERS: {
DOMAIN: string;
ROOM: string;
};
};
static ProsodyApiErrors: {
INVALID_SESSIONID: {
code: string;
name: string;
message: string;
details: string;
};
INVALID_TYPE: {
code: string;
name: string;
message: string;
details: string;
};
};
static ONLINE_MEMBER_COUNT_API: {
ENDPOINTS: {
GET_ONLINE_MEMBER_COUNT: string;
};
RESPONSE: {
ONLINE_USERS_COUNT: string;
GROUPS: string;
};
ERRORS: {
INVALID_GROUPLIST: {
code: string;
name: string;
message: string;
details: string;
};
};
};
static ReceiptErrors: {
MISSING_PARAMETERS: {
code: string;
name: string;
message: string;
details: {};
};
INVALID_PARAMETER: {
code: string;
name: string;
message: string;
details: {};
};
NO_WEBSOCKET_CONNECTION: {
code: string;
name: string;
message: string;
details: {};
};
RECEIPTS_TEMPORARILY_BLOCKED: {
code: string;
name: string;
message: string;
details: {};
};
UNKNOWN_ERROR_OCCURRED: {
code: string;
name: string;
message: string;
details: {};
};
};
static ANALYTICS: {
analyticsHost: string;
analyticsVersion: string;
};
static API_ERROR_CODES: {
AUTH_ERR_AUTH_TOKEN_NOT_FOUND: string;
};
static ATTACHMENTS_CONSTANTS: {
KEYS: {
EXTENSION: string;
MIME_TYPE: string;
NAME: string;
SIZE: string;
URL: string;
};
};
static BlockedUsersConstants: {
REQUEST_KEYS: {
DIRECTIONS: {
BOTH: string;
HAS_BLOCKED_ME: string;
BLOCKED_BY_ME: string;
};
};
};
static CALLING_COMPONENT_VERSION: number;
static COMMON_UTILITY_CONSTANTS: {
TYPE_CONSTANTS: {
BOOLEAN: string;
STRING: string;
OBJECT: string;
NUMBER: string;
};
};
static DEFAULT_VALUES: {
ZERO: number;
MSGS_LIMIT: number;
REACTIONS_LIMIT: number;
MSGS_MAX_LIMIT: number;
USERS_LIMIT: number;
USERS_MAX_LIMIT: number;
GROUPS_LIMIT: number;
GROUPS_MAX_LIMIT: number;
CONVERSATION_MAX_LIMIT: number;
CALL_TIMEOUT: number;
DEFAULT_MSG_ID: number;
DEFAULT_MAX_TYPING_INDICATOR_LIMIT: number;
REGION_DEFAULT: string;
REGION_DEFAULT_EU: string;
REGION_DEFAULT_US: string;
REGION_DEFAULT_IN: string;
REGION_DEFAULT_PRIVATE: string;
REACTIONS_MAX_LIMIT: number;
};
static DELIVERY_RECEIPTS: {
RECEIVER_ID: string;
RECEIVER_TYPE: string;
RECIPIENT: string;
MESSAGE_ID: string;
RECEIVED: string;
DELIVERED_AT: string;
ID: string;
TIME: string;
DELIVERED_TO_ME_AT: string;
};
static GroupErrors: {
NOT_A_GROUP: CometChatException;
INVALID_SCOPE: CometChatException;
INVALID_GROUP_TYPE: CometChatException;
};
static GroupMemersConstans: {
KEYS: {
SCOPE: string;
UID: string;
GUID: string;
USER: string;
NAME: string;
};
};
static MessageCategory: typeof MessageCategory;
static MessageErrors: {
INVALID_RECEIVER_TYPE: {
code: string;
name: string;
message: string;
details: string;
};
};
static PARAMETER_ERROR: {
PARAMETER_REQUIRED: {
code: string;
name: string;
message: string;
details: {};
};
};
static READ_RECEIPTS: {
RECEIVER_ID: string;
RECEIVER_TYPE: string;
RECIPIENT: string;
MESSAGE_ID: string;
READ: string;
READ_AT: string;
ID: string;
TIME: string;
READ_BY_ME_AT: string;
};
static UserErrors: {
INVALID_STATUS: CometChatException;
INVALID_DIRECTION: CometChatException;
USER_NOT_LOGGED_IN: CometChatException;
};
static constants: {
DEFAULT_STORE: string;
MSG_VER_PRE: string;
MSG_VER_POST: string;
};
static GoalType: typeof GoalType;
static AttachmentType: typeof AttachmentType;
static ModerationStatus: typeof ModerationStatus;
static CometChatException: typeof CometChatException;
static TextMessage: typeof TextMessage;
static MediaMessage: typeof MediaMessage;
static CustomMessage: typeof CustomMessage;
static BaseMessage: typeof BaseMessage;
static Action: typeof Action;
static Call: typeof Call;
static TypingIndicator: typeof TypingIndicator;
static TransientMessage: typeof TransientMessage;
static InteractiveMessage: typeof InteractiveMessage;
static InteractionGoal: typeof InteractionGoal;
static Interaction: typeof Interaction;
static InteractionReceipt: typeof InteractionReceipt;
static MessageReceipt: typeof MessageReceipt;
static AIAssistantMessage: typeof AIAssistantMessage;
static AIToolCall: typeof AIToolCall;
static AIToolCallFunction: typeof AIToolCallFunction;
static AIAssistantMessageData: typeof AIAssistantMessageData;
static AIToolResultMessage: typeof AIToolResultMessage;
static AIToolResultMessageData: typeof AIToolResultMessageData;
static AIToolArgumentMessage: typeof AIToolArgumentMessage;
static AIToolArgumentMessageData: typeof AIToolArgumentMessageData;
static Group: typeof Group;
static User: typeof User;
static GroupMember: typeof GroupMember;
static Conversation: typeof Conversation;
static ReactionCount: typeof ReactionCount;
static ReactionEvent: typeof ReactionEvent;
static Reaction: typeof Reaction;
static USER_STATUS: {
ONLINE: string;
OFFLINE: string;
};
static MessagesRequest: typeof MessagesRequest;
static MessagesRequestBuilder: typeof MessagesRequestBuilder;
static ReactionsRequest: typeof ReactionsRequest;
static ReactionsRequestBuilder: typeof ReactionsRequestBuilder;
static UsersRequest: typeof UsersRequest;
static UsersRequestBuilder: typeof UsersRequestBuilder;
static ConversationsRequest: typeof ConversationsRequest;
static ConversationsRequestBuilder: typeof ConversationsRequestBuilder;
static BlockedUsersRequest: typeof BlockedUsersRequest;
static BlockedUsersRequestBuilder: typeof BlockedUsersRequestBuilder;
static GroupsRequest: typeof GroupsRequest;
static GroupsRequestBuilder: typeof GroupsRequestBuilder;
static GroupMembersRequest: typeof GroupMembersRequest;
static GroupMembersRequestBuilder: typeof GroupMembersRequestBuilder;
static BannedMembersRequest: typeof BannedMembersRequest;
static BannedMembersRequestBuilder: typeof BannedMembersRequestBuilder;
static CallSettings: typeof CallSettings;
static CallSettingsBuilder: typeof CallSettingsBuilder;
static MainVideoContainerSetting: typeof MainVideoContainerSetting;
static VirtualBackground: typeof VirtualBackground;
static VirtualBackgroundBuilder: typeof VirtualBackgroundBuilder;
static AppSettings: typeof AppSettings;
static AppSettingsBuilder: typeof AppSettingsBuilder;
static MessageListener: typeof MessageListener;
static UserListener: typeof UserListener;
static GroupListener: typeof GroupListener;
static OngoingCallListener: typeof OngoingCallListener;
static CallListener: typeof CallListener;
static ConnectionListener: typeof ConnectionListener;
static LoginListener: typeof LoginListener;
static AIAssistantListener: typeof AIAssistantListener;
static CallController: typeof CallController;
static CometChatHelper: typeof CometChatHelper;
static Attachment: typeof Attachment;
static MediaDevice: typeof MediaDevice;
static MESSAGE_TYPE: {
TEXT: string;
MEDIA: string;
IMAGE: string;
VIDEO: string;
AUDIO: string;
FILE: string;
CUSTOM: string;
ASSISTANT: string;
TOOL_RESULT: string;
TOOL_ARGUMENTS: string;
};
static CATEGORY_MESSAGE: string;
static CATEGORY_ACTION: string;
static CATEGORY_CALL: string;
static CATEGORY_CUSTOM: string;
static CATEGORY_INTERACTIVE: string;
static ACTION_TYPE: {
MEMBER_ADDED: string;
MEMBER_JOINED: string;
MEMBER_LEFT: string;
MEMBER_KICKED: string;
MEMBER_BANNED: string;
MEMBER_UNBANNED: string;
MEMBER_INVITED: string;
MEMBER_SCOPE_CHANGED: string;
MESSAGE_EDITED: string;
MESSSAGE_DELETED: string;
TYPE_USER: string;
TYPE_GROUP: string;
TYPE_GROUP_MEMBER: string;
};
static CALL_TYPE: {
AUDIO: string;
VIDEO: string;
};
static SORT_BY: {
NAME: string;
STATUS: string;
};
static SORT_ORDER: {
ASCENDING: string;
DESCENDING: string;
};
static CALL_MODE: {
DEFAULT: string;
SPOTLIGHT: string;
SINGLE: string;
TILE: string;
GRID: string;
};
static RECEIVER_TYPE: {
USER: string;
GROUP: string;
};
static CONNECTION_STATUS: {
CONNECTED: string;
CONNECTING: string;
DISCONNECTED: string;
FEATURE_THROTTLED: string;
};
static CALL_STATUS: {
INITIATED: string;
ONGOING: string;
UNANSWERED: string;
REJECTED: string;
BUSY: string;
CANCELLED: string;
ENDED: string;
};
static GROUP_MEMBER_SCOPE: {
ADMIN: string;
MODERATOR: string;
PARTICIPANT: string;
};
static GROUP_TYPE: {
PUBLIC: string;
PRIVATE: string;
PROTECTED: string;
PASSWORD: string;
};
/**
* Setter method for CometChat authToken.
* @internal
* @param {string} authToken
* @memberof CometChat
*/
static setAuthToken(authToken: string): void;
/**
*Getter method for CometChat authToken.
* @internal
* @returns
* @memberof CometChat
*/
getAuthToken(): string;
/**
* Getter for appId
* @internal
* @returns {string}
*/
static getAppId(): string;
/**
*Getter for apiKey.
* @internal
* @returns
* @memberof CometChat
*/
getApiKey(): string;
/**
*Getter method for CometChat mode.
* @internal
* @returns
* @memberof CometChat
*/
static getMode(): string;
/**
*Setter method for CometChat mode.
* @internal
* @returns
* @memberof CometChat
*/
static setMode(mode: string): void;
/**
* Getter for sessionId.
* @internal
* @returns
* @memberof CometChat
*/
static getSessionId(): string;
/**
* Storage event when a key is added/updated in localstorage.
* @internal
* @memberof CometChat
*/
static onStorageEvent(storageEvent: any): void;
/**
* This method triggers before a page unloads.
* @internal
* @memberof CometChat
*/
static beforeUnload(unloadEvent: any): void;
/**
* This method checks if Analytics Ping has started.
* @internal
* @returns {boolean}
*/
static didAnalyticsPingStart(): boolean;
/**
* This method gets data from session storage.
* @internal
* @returns {string | null}
* @memberof CometChat
*/
static getDataFromSessionStorage(key: any): string;
/**
* This method adds data in the session storage.
* @internal
* @memberof CometChat
*/
static addDataToSessionStorage(key: any, value: any): void;
/**
* This method removes data from the session storage.
* @internal
* @memberof CometChat
*/
static removeDataFromSessionStorage(key: any): void;
/**--------------------------------*
* Core apis
* --------------------------------**/
/**
* Initialize the CometChat app with appId & Object of AppSettings Class.
* @param {string} appId
* @param {AppSettings} appSettings
* @returns {CometChat}
* @memberof CometChat
*/
static init(appId: any, appSettings: AppSettings): Promise<boolean>;
/**
* Function to check whether CometChat class initialized before.
* @returns {boolean}
* @memberof CometChat
*/
static isInitialized(): boolean;
/**
* Returns the singleton object of CometChat class. If CometChat object is not created yet? it will create and returns it.
*
* @internal
* @param {string} appId - An optional argument needed for first time initialization.
* @returns {CometChat}
*/
static getInstance(appId?: string): CometChat;
/**
* Function to register the FCM token for Push Notification.
* @param {string} token
* @param {JSON Object} Settings