ChatKitty

ChatKitty JS Core SDK / Exports / ChatKitty

Class: ChatKitty

Table of contents

Constructors

• constructor

Properties

• currentUser

Methods

• addChannelModerator
• blockUser
• checkChannelUnread
• checkUserIsChannelMember
• clearChannelHistory
• countMessageReplies
• countUnreadChannels
• countUnreadMessages
• createChannel
• createThread
• deleteChannel
• deleteMessage
• deleteUserBlockedRecord
• editMessage
• endSession
• hideChannel
• inviteUser
• joinChannel
• leaveChannel
• listChannelMembers
• listChannels
• listMessages
• listReactions
• listReadReceipts
• listThreadChannel
• listThreadMessage
• listThreads
• listUserBlockedRecords
• listUsers
• listUsersCount
• muteChannel
• onChannelHidden
• onChannelJoined
• onChannelLeft
• onChannelUnhidden
• onChannelUpdated
• onCurrentUserChanged
• onCurrentUserOffline
• onCurrentUserOnline
• onNotificationReceived
• onParticipantStartedTyping
• onParticipantStoppedTyping
• onUserPresenceChanged
• reactToMessage
• readChannel
• readMessage
• readThread
• removeReaction
• retrieveChannel
• retrieveChannelContext
• retrieveCurrentUser
• retrieveLastReadMessage
• retrieveMessageChannel
• retrieveMessageParent
• retrieveUser
• sendKeystrokes
• sendMessage
• startChatSession
• startSession
• triggerEvent
• unmuteChannel
• unreadMessage
• updateChannel
• updateCurrentUser
• updateCurrentUserDisplayPicture
• updateMessageProperties
• getInstance

Constructors

constructor

• new ChatKitty(configuration)

Parameters

Name	Type
configuration	ChatKittyConfiguration

Defined in

lib/chatkitty.ts:261

Properties

currentUser

• Optional currentUser: CurrentUser

Defined in

lib/chatkitty.ts:259

Methods

addChannelModerator

▸ addChannelModerator(request): Promise<AddChannelModeratorResult>

Parameters

Name	Type
request	AddChannelModeratorRequest

Returns

Promise<AddChannelModeratorResult>

Defined in

lib/chatkitty.ts:679

---

blockUser

▸ blockUser(request): Promise<BlockUserResult>

Parameters

Name	Type
request	BlockUserRequest

Returns

Promise<BlockUserResult>

Defined in

lib/chatkitty.ts:2076

---

checkChannelUnread

▸ checkChannelUnread(request): Promise<CheckChannelUnreadResult>

Parameters

Name	Type
request	CheckChannelUnreadRequest

Returns

Promise<CheckChannelUnreadResult>

Defined in

lib/chatkitty.ts:733

---

checkUserIsChannelMember

▸ checkUserIsChannelMember(request): Promise<CheckUserIsChannelMemberResult>

Parameters

Name	Type
request	CheckUserIsChannelMemberRequest

Returns

Promise<CheckUserIsChannelMemberResult>

Defined in

lib/chatkitty.ts:2051

---

clearChannelHistory

▸ clearChannelHistory(request): Promise<ClearChannelHistoryResult>

Parameters

Name	Type
request	ClearChannelHistoryRequest

Returns

Promise<ClearChannelHistoryResult>

Defined in

lib/chatkitty.ts:818

---

countMessageReplies

▸ countMessageReplies(request): Promise<CountResult>

Parameters

Name	Type
request	CountMessageRepliesRequest

Returns

Promise<CountResult>

Defined in

lib/chatkitty.ts:1501

---

countUnreadChannels

▸ countUnreadChannels(request?): Promise<CountResult>

Parameters

Name	Type
request?	ListUnreadChannelsRequest

Returns

Promise<CountResult>

Defined in

lib/chatkitty.ts:702

---

countUnreadMessages

▸ countUnreadMessages(request?): Promise<CountResult>

Parameters

Name	Type
request?	CountUnreadMessagesRequest

Returns

Promise<CountResult>

Defined in

lib/chatkitty.ts:1376

---

createChannel

▸ createChannel(request): Promise<CreateChannelResult>

Parameters

Name	Type
request	CreateChannelRequest

Returns

Promise<CreateChannelResult>

Defined in

lib/chatkitty.ts:522

---

createThread

▸ createThread(request): Promise<CreateThreadResult>

Parameters

Name	Type
request	CreateThreadRequest

Returns

Promise<CreateThreadResult>

Defined in

lib/chatkitty.ts:1555

---

deleteChannel

▸ deleteChannel(request): Promise<DeleteChannelResult>

Parameters

Name	Type
request	DeleteChannelRequest

Returns

Promise<DeleteChannelResult>

Defined in

lib/chatkitty.ts:507

---

deleteMessage

▸ deleteMessage(request): Promise<DeleteMessageResult>

Parameters

Name	Type
request	DeleteMessageRequest

Returns

Promise<DeleteMessageResult>

Defined in

lib/chatkitty.ts:1680

---

deleteUserBlockedRecord

▸ deleteUserBlockedRecord(request): Promise<DeleteUserBlockedRecordResult>

Parameters

Name	Type
request	DeleteUserBlockedRecordRequest

Returns

Promise<DeleteUserBlockedRecordResult>

Defined in

lib/chatkitty.ts:2109

---

editMessage

▸ editMessage(request): Promise<EditMessageResult>

Parameters

Name	Type
request	EditMessageRequest

Returns

Promise<EditMessageResult>

Defined in

lib/chatkitty.ts:1473

---

endSession

▸ endSession(): Promise<void>

Returns

Promise<void>

Defined in

lib/chatkitty.ts:336

---

hideChannel

▸ hideChannel(request): Promise<HideChannelResult>

Parameters

Name	Type
request	HideChannelRequest

Returns

Promise<HideChannelResult>

Defined in

lib/chatkitty.ts:838

---

inviteUser

▸ inviteUser(request): Promise<InviteUserResult>

Parameters

Name	Type
request	InviteUserRequest

Returns

Promise<InviteUserResult>

Defined in

lib/chatkitty.ts:1971

---

joinChannel

▸ joinChannel(request): Promise<JoinChannelResult>

Parameters

Name	Type
request	JoinChannelRequest

Returns

Promise<JoinChannelResult>

Defined in

lib/chatkitty.ts:625

---

leaveChannel

▸ leaveChannel(request): Promise<LeaveChannelResult>

Parameters

Name	Type
request	LeaveChannelRequest

Returns

Promise<LeaveChannelResult>

Defined in

lib/chatkitty.ts:652

---

listChannelMembers

▸ listChannelMembers(request): Promise<ListUsersResult>

Parameters

Name	Type
request	ListChannelMembersRequest

Returns

Promise<ListUsersResult>

Defined in

lib/chatkitty.ts:1848

---

listChannels

▸ listChannels(request?): Promise<ListChannelsResult>

Parameters

Name	Type
request?	ListChannelsRequest

Returns

Promise<ListChannelsResult>

Defined in

lib/chatkitty.ts:548

---

listMessages

▸ listMessages(request): Promise<ListMessagesResult>

Parameters

Name	Type
request	ListMessagesRequest

Returns

Promise<ListMessagesResult>

Defined in

lib/chatkitty.ts:1330

---

listReactions

▸ listReactions(request): Promise<ListReactionsResult>

Parameters

Name	Type
request	ListReactionsRequest

Returns

Promise<ListReactionsResult>

Defined in

lib/chatkitty.ts:1651

---

listReadReceipts

▸ listReadReceipts(request): Promise<ListReadReceiptsResult>

Parameters

Name	Type
request	ListReadReceiptsRequest

Returns

Promise<ListReadReceiptsResult>

Defined in

lib/chatkitty.ts:1871

---

listThreadChannel

▸ listThreadChannel(request): Promise<RetrieveThreadChannelResult>

Parameters

Name	Type
request	RetrieveThreadChannelRequest

Returns

Promise<RetrieveThreadChannelResult>

Defined in

lib/chatkitty.ts:1589

---

listThreadMessage

▸ listThreadMessage(request): Promise<RetrieveThreadMessageResult>

Parameters

Name	Type
request	RetrieveThreadMessageRequest

Returns

Promise<RetrieveThreadMessageResult>

Defined in

lib/chatkitty.ts:1605

---

listThreads

▸ listThreads(request): Promise<ListThreadsResult>

Parameters

Name	Type
request	ListChannelThreadsRequest

Returns

Promise<ListThreadsResult>

Defined in

lib/chatkitty.ts:1566

---

listUserBlockedRecords

▸ listUserBlockedRecords(): Promise<ListUserBlockedRecordsResult>

Returns

Promise<ListUserBlockedRecordsResult>

Defined in

lib/chatkitty.ts:2089

---

listUsers

▸ listUsers(request?): Promise<ListUsersResult>

Parameters

Name	Type
request?	ListUsersRequest

Returns

Promise<ListUsersResult>

Defined in

lib/chatkitty.ts:1893

---

listUsersCount

▸ listUsersCount(request?): Promise<CountResult>

Parameters

Name	Type
request?	ListUsersRequest

Returns

Promise<CountResult>

Defined in

lib/chatkitty.ts:1920

---

muteChannel

▸ muteChannel(request): Promise<MuteChannelResult>

Parameters

Name	Type
request	MuteChannelRequest

Returns

Promise<MuteChannelResult>

Defined in

lib/chatkitty.ts:772

---

onChannelHidden

▸ onChannelHidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<Channel> | (channel: Channel) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1752

---

onChannelJoined

▸ onChannelJoined(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<Channel> | (channel: Channel) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1728

---

onChannelLeft

▸ onChannelLeft(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<Channel> | (channel: Channel) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1800

---

onChannelUnhidden

▸ onChannelUnhidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<Channel> | (channel: Channel) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1776

---

onChannelUpdated

▸ onChannelUpdated(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<Channel> | (channel: Channel) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1824

---

onCurrentUserChanged

▸ onCurrentUserChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<null | CurrentUser> | (user: null | CurrentUser) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:363

---

onCurrentUserOffline

▸ onCurrentUserOffline(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<CurrentUser> | () => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:395

---

onCurrentUserOnline

▸ onCurrentUserOnline(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<CurrentUser> | () => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:379

---

onNotificationReceived

▸ onNotificationReceived(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<Notification> | (notification: Notification) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1702

---

onParticipantStartedTyping

▸ onParticipantStartedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<User> | (participant: User) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1992

---

onParticipantStoppedTyping

▸ onParticipantStoppedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<User> | (participant: User) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2016

---

onUserPresenceChanged

▸ onUserPresenceChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters

Name	Type
onNextOrObserver	ChatKittyObserver<User> | (user: User) => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:1947

---

reactToMessage

▸ reactToMessage(request): Promise<ReactToMessageResult>

Parameters

Name	Type
request	ReactToMessageRequest

Returns

Promise<ReactToMessageResult>

Defined in

lib/chatkitty.ts:1638

---

readChannel

▸ readChannel(request): Promise<ReadChannelResult>

Parameters

Name	Type
request	ReadChannelRequest

Returns

Promise<ReadChannelResult>

Defined in

lib/chatkitty.ts:755

---

readMessage

▸ readMessage(request): Promise<ReadMessageResult>

Parameters

Name	Type
request	ReadMessageRequest

Returns

Promise<ReadMessageResult>

Defined in

lib/chatkitty.ts:1431

---

readThread

▸ readThread(request): Promise<ReadThreadResult>

Parameters

Name	Type
request	ReadThreadRequest

Returns

Promise<ReadThreadResult>

Defined in

lib/chatkitty.ts:1621

---

removeReaction

▸ removeReaction(request): Promise<RemoveReactionResult>

Parameters

Name	Type
request	RemoveReactionRequest

Returns

Promise<RemoveReactionResult>

Defined in

lib/chatkitty.ts:1665

---

retrieveChannel

▸ retrieveChannel(id): Promise<RetrieveChannelResult>

Parameters

Name	Type
id	number

Returns

Promise<RetrieveChannelResult>

Defined in

lib/chatkitty.ts:593

---

retrieveChannelContext

▸ retrieveChannelContext(request): Promise<RetrieveChannelContextResult>

Parameters

Name	Type
request	RetrieveChannelContextRequest

Returns

Promise<RetrieveChannelContextResult>

Defined in

lib/chatkitty.ts:607

---

retrieveCurrentUser

▸ retrieveCurrentUser(): Promise<RetrieveCurrentUserResult>

Returns

Promise<RetrieveCurrentUserResult>

Defined in

lib/chatkitty.ts:343

---

retrieveLastReadMessage

▸ retrieveLastReadMessage(request): Promise<RetrieveLastReadMessageResult>

Parameters

Name	Type
request	RetrieveLastReadMessageRequest

Returns

Promise<RetrieveLastReadMessageResult>

Defined in

lib/chatkitty.ts:1454

---

retrieveMessageChannel

▸ retrieveMessageChannel(request): Promise<RetrieveMessageChannelResult>

Parameters

Name	Type
request	RetrieveMessageChannelRequest

Returns

Promise<RetrieveMessageChannelResult>

Defined in

lib/chatkitty.ts:1517

---

retrieveMessageParent

▸ retrieveMessageParent(request): Promise<RetrieveMessageParentResult>

Parameters

Name	Type
request	RetrieveMessageParentRequest

Returns

Promise<RetrieveMessageParentResult>

Defined in

lib/chatkitty.ts:1533

---

retrieveUser

▸ retrieveUser(param): Promise<RetrieveUserResult>

Parameters

Name	Type
param	number

Returns

Promise<RetrieveUserResult>

Defined in

lib/chatkitty.ts:2040

---

sendKeystrokes

▸ sendKeystrokes(request): void

Parameters

Name	Type
request	SendKeystrokesRequest

Returns

void

Defined in

lib/chatkitty.ts:1692

---

sendMessage

▸ sendMessage(request): Promise<SendMessageResult>

Parameters

Name	Type
request	SendMessageRequest

Returns

Promise<SendMessageResult>

Defined in

lib/chatkitty.ts:1212

---

startChatSession

▸ startChatSession(request): StartedChatSessionResult

Parameters

Name	Type
request	StartChatSessionRequest

Returns

StartedChatSessionResult

Defined in

lib/chatkitty.ts:850

---

startSession

▸ startSession(request): Promise<StartSessionResult>

Parameters

Name	Type
request	StartSessionRequest

Returns

Promise<StartSessionResult>

Defined in

lib/chatkitty.ts:294

---

triggerEvent

▸ triggerEvent(request): Promise<TriggerEventResult>

Parameters

Name	Type
request	TriggerEventRequest

Returns

Promise<TriggerEventResult>

Defined in

lib/chatkitty.ts:1407

---

unmuteChannel

▸ unmuteChannel(request): Promise<UnmuteChannelResult>

Parameters

Name	Type
request	UnmuteChannelRequest

Returns

Promise<UnmuteChannelResult>

Defined in

lib/chatkitty.ts:795

---

unreadMessage

▸ unreadMessage(request): Promise<UnreadMessageResult>

Parameters

Name	Type
request	UnreadMessageRequest

Returns

Promise<UnreadMessageResult>

Defined in

lib/chatkitty.ts:1442

---

updateChannel

▸ updateChannel(request): Promise<UpdateChannelResult>

Parameters

Name	Type
request	UpdateChannelRequest

Returns

Promise<UpdateChannelResult>

Defined in

lib/chatkitty.ts:492

---

updateCurrentUser

▸ updateCurrentUser(update): Promise<UpdateCurrentUserResult>

Parameters

Name	Type
update	(user: CurrentUser) => CurrentUser

Returns

Promise<UpdateCurrentUserResult>

Defined in

lib/chatkitty.ts:411

---

updateCurrentUserDisplayPicture

▸ updateCurrentUserDisplayPicture(request): Promise<UpdateCurrentUserDisplayPictureResult>

Parameters

Name	Type
request	UpdateCurrentUserDisplayPictureRequest

Returns

Promise<UpdateCurrentUserDisplayPictureResult>

Defined in

lib/chatkitty.ts:436

---

updateMessageProperties

▸ updateMessageProperties(request): Promise<unknown>

Parameters

Name	Type
request	UpdateMessagePropertiesRequest

Returns

Promise<unknown>

Defined in

lib/chatkitty.ts:1487

---

getInstance

▸ Static getInstance(apiKey): ChatKitty

Parameters

Name	Type
apiKey	string

Returns

ChatKitty

Defined in

lib/chatkitty.ts:221