Skip to main content

ChatKitty

ChatKitty JS Core SDK / Exports / ChatKitty

Class: ChatKitty

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ChatKitty(configuration)

Parameters

NameType
configurationChatKittyConfiguration

Defined in

lib/chatkitty.ts:255

Properties

currentUser

Optional currentUser: CurrentUser

Defined in

lib/chatkitty.ts:253

Methods

addChannelModerator

addChannelModerator(request): Promise<AddChannelModeratorResult>

Parameters

NameType
requestAddChannelModeratorRequest

Returns

Promise<AddChannelModeratorResult>

Defined in

lib/chatkitty.ts:664


blockUser

blockUser(request): Promise<BlockUserResult>

Parameters

NameType
requestBlockUserRequest

Returns

Promise<BlockUserResult>

Defined in

lib/chatkitty.ts:1998


checkChannelUnread

checkChannelUnread(request): Promise<CheckChannelUnreadResult>

Parameters

NameType
requestCheckChannelUnreadRequest

Returns

Promise<CheckChannelUnreadResult>

Defined in

lib/chatkitty.ts:718


checkUserIsChannelMember

checkUserIsChannelMember(request): Promise<CheckUserIsChannelMemberResult>

Parameters

NameType
requestCheckUserIsChannelMemberRequest

Returns

Promise<CheckUserIsChannelMemberResult>

Defined in

lib/chatkitty.ts:1973


clearChannelHistory

clearChannelHistory(request): Promise<ClearChannelHistoryResult>

Parameters

NameType
requestClearChannelHistoryRequest

Returns

Promise<ClearChannelHistoryResult>

Defined in

lib/chatkitty.ts:803


countMessageReplies

countMessageReplies(request): Promise<CountResult>

Parameters

NameType
requestCountMessageRepliesRequest

Returns

Promise<CountResult>

Defined in

lib/chatkitty.ts:1423


countUnreadChannels

countUnreadChannels(request?): Promise<CountResult>

Parameters

NameType
request?ListUnreadChannelsRequest

Returns

Promise<CountResult>

Defined in

lib/chatkitty.ts:687


countUnreadMessages

countUnreadMessages(request?): Promise<CountResult>

Parameters

NameType
request?CountUnreadMessagesRequest

Returns

Promise<CountResult>

Defined in

lib/chatkitty.ts:1324


createChannel

createChannel(request): Promise<CreateChannelResult>

Parameters

NameType
requestCreateChannelRequest

Returns

Promise<CreateChannelResult>

Defined in

lib/chatkitty.ts:525


createThread

createThread(request): Promise<CreateThreadResult>

Parameters

NameType
requestCreateThreadRequest

Returns

Promise<CreateThreadResult>

Defined in

lib/chatkitty.ts:1477


deleteChannel

deleteChannel(request): Promise<DeleteChannelResult>

Parameters

NameType
requestDeleteChannelRequest

Returns

Promise<DeleteChannelResult>

Defined in

lib/chatkitty.ts:510


deleteMessage

deleteMessage(request): Promise<DeleteMessageResult>

Parameters

NameType
requestDeleteMessageRequest

Returns

Promise<DeleteMessageResult>

Defined in

lib/chatkitty.ts:1602


deleteUserBlockedRecord

deleteUserBlockedRecord(request): Promise<DeleteUserBlockedRecordResult>

Parameters

NameType
requestDeleteUserBlockedRecordRequest

Returns

Promise<DeleteUserBlockedRecordResult>

Defined in

lib/chatkitty.ts:2031


editMessage

editMessage(request): Promise<EditMessageResult>

Parameters

NameType
requestEditMessageRequest

Returns

Promise<EditMessageResult>

Defined in

lib/chatkitty.ts:1409


endSession

endSession(): Promise<void>

Returns

Promise<void>

Defined in

lib/chatkitty.ts:330


hideChannel

hideChannel(request): Promise<HideChannelResult>

Parameters

NameType
requestHideChannelRequest

Returns

Promise<HideChannelResult>

Defined in

lib/chatkitty.ts:823


inviteUser

inviteUser(request): Promise<InviteUserResult>

Parameters

NameType
requestInviteUserRequest

Returns

Promise<InviteUserResult>

Defined in

lib/chatkitty.ts:1893


joinChannel

joinChannel(request): Promise<JoinChannelResult>

Parameters

NameType
requestJoinChannelRequest

Returns

Promise<JoinChannelResult>

Defined in

lib/chatkitty.ts:610


leaveChannel

leaveChannel(request): Promise<LeaveChannelResult>

Parameters

NameType
requestLeaveChannelRequest

Returns

Promise<LeaveChannelResult>

Defined in

lib/chatkitty.ts:637


listChannelMembers

listChannelMembers(request): Promise<ListUsersResult>

Parameters

NameType
requestListChannelMembersRequest

Returns

Promise<ListUsersResult>

Defined in

lib/chatkitty.ts:1770


listChannels

listChannels(request?): Promise<ListChannelsResult>

Parameters

NameType
request?ListChannelsRequest

Returns

Promise<ListChannelsResult>

Defined in

lib/chatkitty.ts:551


listMessages

listMessages(request): Promise<ListMessagesResult>

Parameters

NameType
requestListMessagesRequest

Returns

Promise<ListMessagesResult>

Defined in

lib/chatkitty.ts:1286


listReactions

listReactions(request): Promise<ListReactionsResult>

Parameters

NameType
requestListReactionsRequest

Returns

Promise<ListReactionsResult>

Defined in

lib/chatkitty.ts:1573


listReadReceipts

listReadReceipts(request): Promise<ListReadReceiptsResult>

Parameters

NameType
requestListReadReceiptsRequest

Returns

Promise<ListReadReceiptsResult>

Defined in

lib/chatkitty.ts:1793


listThreadChannel

listThreadChannel(request): Promise<RetrieveThreadChannelResult>

Parameters

NameType
requestRetrieveThreadChannelRequest

Returns

Promise<RetrieveThreadChannelResult>

Defined in

lib/chatkitty.ts:1511


listThreadMessage

listThreadMessage(request): Promise<RetrieveThreadMessageResult>

Parameters

NameType
requestRetrieveThreadMessageRequest

Returns

Promise<RetrieveThreadMessageResult>

Defined in

lib/chatkitty.ts:1527


listThreads

listThreads(request): Promise<ListThreadsResult>

Parameters

NameType
requestListChannelThreadsRequest

Returns

Promise<ListThreadsResult>

Defined in

lib/chatkitty.ts:1488


listUserBlockedRecords

listUserBlockedRecords(): Promise<ListUserBlockedRecordsResult>

Returns

Promise<ListUserBlockedRecordsResult>

Defined in

lib/chatkitty.ts:2011


listUsers

listUsers(request?): Promise<ListUsersResult>

Parameters

NameType
request?ListUsersRequest

Returns

Promise<ListUsersResult>

Defined in

lib/chatkitty.ts:1815


listUsersCount

listUsersCount(request?): Promise<CountResult>

Parameters

NameType
request?ListUsersRequest

Returns

Promise<CountResult>

Defined in

lib/chatkitty.ts:1842


muteChannel

muteChannel(request): Promise<MuteChannelResult>

Parameters

NameType
requestMuteChannelRequest

Returns

Promise<MuteChannelResult>

Defined in

lib/chatkitty.ts:757


onChannelHidden

onChannelHidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<Channel> | (channel: Channel) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1674


onChannelJoined

onChannelJoined(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<Channel> | (channel: Channel) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1650


onChannelLeft

onChannelLeft(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<Channel> | (channel: Channel) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1722


onChannelUnhidden

onChannelUnhidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<Channel> | (channel: Channel) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1698


onChannelUpdated

onChannelUpdated(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<Channel> | (channel: Channel) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1746


onCurrentUserChanged

onCurrentUserChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<null | CurrentUser> | (user: null | CurrentUser) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:366


onCurrentUserOffline

onCurrentUserOffline(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<CurrentUser> | () => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:398


onCurrentUserOnline

onCurrentUserOnline(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<CurrentUser> | () => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:382


onNotificationReceived

onNotificationReceived(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<Notification> | (notification: Notification) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1624


onParticipantStartedTyping

onParticipantStartedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<User> | (participant: User) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1914


onParticipantStoppedTyping

onParticipantStoppedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<User> | (participant: User) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1938


onUserPresenceChanged

onUserPresenceChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<User> | (user: User) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1869


reactToMessage

reactToMessage(request): Promise<ReactToMessageResult>

Parameters

NameType
requestReactToMessageRequest

Returns

Promise<ReactToMessageResult>

Defined in

lib/chatkitty.ts:1560


readChannel

readChannel(request): Promise<ReadChannelResult>

Parameters

NameType
requestReadChannelRequest

Returns

Promise<ReadChannelResult>

Defined in

lib/chatkitty.ts:740


readMessage

readMessage(request): Promise<ReadMessageResult>

Parameters

NameType
requestReadMessageRequest

Returns

Promise<ReadMessageResult>

Defined in

lib/chatkitty.ts:1379


readThread

readThread(request): Promise<ReadThreadResult>

Parameters

NameType
requestReadThreadRequest

Returns

Promise<ReadThreadResult>

Defined in

lib/chatkitty.ts:1543


removeReaction

removeReaction(request): Promise<RemoveReactionResult>

Parameters

NameType
requestRemoveReactionRequest

Returns

Promise<RemoveReactionResult>

Defined in

lib/chatkitty.ts:1587


retrieveChannel

retrieveChannel(id): Promise<RetrieveChannelResult>

Parameters

NameType
idnumber

Returns

Promise<RetrieveChannelResult>

Defined in

lib/chatkitty.ts:596


retrieveCurrentUser

retrieveCurrentUser(): Promise<RetrieveCurrentUserResult>

Returns

Promise<RetrieveCurrentUserResult>

Defined in

lib/chatkitty.ts:346


retrieveLastReadMessage

retrieveLastReadMessage(request): Promise<RetrieveLastReadMessageResult>

Parameters

NameType
requestRetrieveLastReadMessageRequest

Returns

Promise<RetrieveLastReadMessageResult>

Defined in

lib/chatkitty.ts:1390


retrieveMessageChannel

retrieveMessageChannel(request): Promise<RetrieveMessageChannelResult>

Parameters

NameType
requestRetrieveMessageChannelRequest

Returns

Promise<RetrieveMessageChannelResult>

Defined in

lib/chatkitty.ts:1439


retrieveMessageParent

retrieveMessageParent(request): Promise<RetrieveMessageParentResult>

Parameters

NameType
requestRetrieveMessageParentRequest

Returns

Promise<RetrieveMessageParentResult>

Defined in

lib/chatkitty.ts:1455


retrieveUser

retrieveUser(param): Promise<RetrieveUserResult>

Parameters

NameType
paramnumber

Returns

Promise<RetrieveUserResult>

Defined in

lib/chatkitty.ts:1962


sendKeystrokes

sendKeystrokes(request): void

Parameters

NameType
requestSendKeystrokesRequest

Returns

void

Defined in

lib/chatkitty.ts:1614


sendMessage

sendMessage(request): Promise<SendMessageResult>

Parameters

NameType
requestSendMessageRequest

Returns

Promise<SendMessageResult>

Defined in

lib/chatkitty.ts:1168


startChatSession

startChatSession(request): StartedChatSessionResult

Parameters

NameType
requestStartChatSessionRequest

Returns

StartedChatSessionResult

Defined in

lib/chatkitty.ts:835


startSession

startSession(request): Promise<StartSessionResult>

Parameters

NameType
requestStartSessionRequest

Returns

Promise<StartSessionResult>

Defined in

lib/chatkitty.ts:288


triggerEvent

triggerEvent(request): Promise<TriggerEventResult>

Parameters

NameType
requestTriggerEventRequest

Returns

Promise<TriggerEventResult>

Defined in

lib/chatkitty.ts:1355


unmuteChannel

unmuteChannel(request): Promise<UnmuteChannelResult>

Parameters

NameType
requestUnmuteChannelRequest

Returns

Promise<UnmuteChannelResult>

Defined in

lib/chatkitty.ts:780


updateChannel

updateChannel(request): Promise<UpdateChannelResult>

Parameters

NameType
requestUpdateChannelRequest

Returns

Promise<UpdateChannelResult>

Defined in

lib/chatkitty.ts:495


updateCurrentUser

updateCurrentUser(update): Promise<UpdateCurrentUserResult>

Parameters

NameType
update(user: CurrentUser) => CurrentUser

Returns

Promise<UpdateCurrentUserResult>

Defined in

lib/chatkitty.ts:414


updateCurrentUserDisplayPicture

updateCurrentUserDisplayPicture(request): Promise<UpdateCurrentUserDisplayPictureResult>

Parameters

NameType
requestUpdateCurrentUserDisplayPictureRequest

Returns

Promise<UpdateCurrentUserDisplayPictureResult>

Defined in

lib/chatkitty.ts:439


getInstance

Static getInstance(apiKey): ChatKitty

Parameters

NameType
apiKeystring

Returns

ChatKitty

Defined in

lib/chatkitty.ts:215