default

ChatKitty JS SDK / Exports / default

Class: default

Implements

• ChatKitty

Table of contents

Constructors

• constructor

Properties

• Calls
• currentUser

Methods

• addChannelModerator
• blockUser
• clearChannelHistory
• createChannel
• createThread
• deleteChannel
• deleteMessage
• deleteMessageForMe
• deleteUserBlockListItem
• editMessage
• endSession
• getChannel
• getChannelMembers
• getChannelUnread
• getChannels
• getCurrentUser
• getLastReadMessage
• getMessageChannel
• getMessageParent
• getMessageRepliesCount
• getMessages
• getReactions
• getReadReceipts
• getThreadChannel
• getThreadMessage
• getThreads
• getUnreadChannelsCount
• getUnreadMessagesCount
• getUser
• getUserBlockList
• getUserIsChannelMember
• getUsers
• getUsersCount
• hideChannel
• inviteUser
• joinChannel
• leaveChannel
• muteChannel
• onChannelHidden
• onChannelJoined
• onChannelLeft
• onChannelUnhidden
• onChannelUpdated
• onCurrentUserChanged
• onCurrentUserOffline
• onCurrentUserOnline
• onNotificationReceived
• onParticipantStartedTyping
• onParticipantStoppedTyping
• onUserPresenceChanged
• reactToMessage
• readChannel
• readMessage
• readThread
• removeReaction
• sendKeystrokes
• sendMessage
• startChatSession
• startSession
• triggerEvent
• unmuteChannel
• updateChannel
• updateCurrentUser
• updateCurrentUserDisplayPicture
• getInstance

Constructors

constructor

• new default(configuration)

Parameters

Name	Type
configuration	ChatKittyConfiguration

Defined in

lib/chatkitty.ts:327

Properties

Calls

• Calls: Calls

Implementation of

ChatKitty.Calls

Defined in

lib/chatkitty.ts:254

---

currentUser

• Optional currentUser: CurrentUser

Implementation of

ChatKitty.currentUser

Defined in

lib/chatkitty.ts:252

Methods

addChannelModerator

▸ addChannelModerator(request): Promise<AddChannelModeratorResult>

Parameters

Name	Type
request	AddChannelModeratorRequest

Returns

Promise<AddChannelModeratorResult>

Implementation of

ChatKitty.addChannelModerator

Defined in

lib/chatkitty.ts:740

---

blockUser

▸ blockUser(request): Promise<BlockUserResult>

Parameters

Name	Type
request	BlockUserRequest

Returns

Promise<BlockUserResult>

Implementation of

ChatKitty.blockUser

Defined in

lib/chatkitty.ts:2089

---

clearChannelHistory

▸ clearChannelHistory(request): Promise<ClearChannelHistoryResult>

Parameters

Name	Type
request	ClearChannelHistoryRequest

Returns

Promise<ClearChannelHistoryResult>

Implementation of

ChatKitty.clearChannelHistory

Defined in

lib/chatkitty.ts:881

---

createChannel

▸ createChannel(request): Promise<CreateChannelResult>

Parameters

Name	Type
request	CreateChannelRequest

Returns

Promise<CreateChannelResult>

Implementation of

ChatKitty.createChannel

Defined in

lib/chatkitty.ts:603

---

createThread

▸ createThread(request): Promise<CreateThreadResult>

Parameters

Name	Type
request	CreateThreadRequest

Returns

Promise<CreateThreadResult>

Implementation of

ChatKitty.createThread

Defined in

lib/chatkitty.ts:1552

---

deleteChannel

▸ deleteChannel(request): Promise<DeleteChannelResult>

Parameters

Name	Type
request	DeleteChannelRequest

Returns

Promise<DeleteChannelResult>

Implementation of

ChatKitty.deleteChannel

Defined in

lib/chatkitty.ts:586

---

deleteMessage

▸ deleteMessage(request): Promise<DeleteMessageResult>

Parameters

Name	Type
request	DeleteMessageRequest

Returns

Promise<DeleteMessageResult>

Implementation of

ChatKitty.deleteMessage

Defined in

lib/chatkitty.ts:1691

---

deleteMessageForMe

▸ deleteMessageForMe(request): Promise<DeleteMessageForMeResult>

Parameters

Name	Type
request	DeleteMessageForMeRequest

Returns

Promise<DeleteMessageForMeResult>

Implementation of

ChatKitty.deleteMessageForMe

Defined in

lib/chatkitty.ts:1677

---

deleteUserBlockListItem

▸ deleteUserBlockListItem(request): Promise<DeleteUserBlockListItemResult>

Parameters

Name	Type
request	DeleteUserBlockListItemRequest

Returns

Promise<DeleteUserBlockListItemResult>

Implementation of

ChatKitty.deleteUserBlockListItem

Defined in

lib/chatkitty.ts:2122

---

editMessage

▸ editMessage(request): Promise<EditMessageResult>

Parameters

Name	Type
request	EditMessageRequest

Returns

Promise<EditMessageResult>

Implementation of

ChatKitty.editMessage

Defined in

lib/chatkitty.ts:1484

---

endSession

▸ endSession(): Promise<void>

Returns

Promise<void>

Implementation of

ChatKitty.endSession

Defined in

lib/chatkitty.ts:404

---

getChannel

▸ getChannel(id): Promise<GetChannelResult>

Parameters

Name	Type
id	number

Returns

Promise<GetChannelResult>

Implementation of

ChatKitty.getChannel

Defined in

lib/chatkitty.ts:670

---

getChannelMembers

▸ getChannelMembers(request): Promise<GetUsersResult>

Parameters

Name	Type
request	GetChannelMembersRequest

Returns

Promise<GetUsersResult>

Implementation of

ChatKitty.getChannelMembers

Defined in

lib/chatkitty.ts:1861

---

getChannelUnread

▸ getChannelUnread(request): Promise<GetChannelUnreadResult>

Parameters

Name	Type
request	GetChannelUnreadRequest

Returns

Promise<GetChannelUnreadResult>

Implementation of

ChatKitty.getChannelUnread

Defined in

lib/chatkitty.ts:794

---

getChannels

▸ getChannels(request?): Promise<GetChannelsResult>

Parameters

Name	Type
request?	GetChannelsRequest

Returns

Promise<GetChannelsResult>

Implementation of

ChatKitty.getChannels

Defined in

lib/chatkitty.ts:627

---

getCurrentUser

▸ getCurrentUser(): Promise<GetCurrentUserResult>

Returns

Promise<GetCurrentUserResult>

Implementation of

ChatKitty.getCurrentUser

Defined in

lib/chatkitty.ts:420

---

getLastReadMessage

▸ getLastReadMessage(request): Promise<GetLastReadMessageResult>

Parameters

Name	Type
request	GetLastReadMessageRequest

Returns

Promise<GetLastReadMessageResult>

Implementation of

ChatKitty.getLastReadMessage

Defined in

lib/chatkitty.ts:1465

---

getMessageChannel

▸ getMessageChannel(request): Promise<GetMessageChannelResult>

Parameters

Name	Type
request	GetMessageChannelRequest

Returns

Promise<GetMessageChannelResult>

Implementation of

ChatKitty.getMessageChannel

Defined in

lib/chatkitty.ts:1514

---

getMessageParent

▸ getMessageParent(request): Promise<GetMessageParentResult>

Parameters

Name	Type
request	GetMessageParentRequest

Returns

Promise<GetMessageParentResult>

Implementation of

ChatKitty.getMessageParent

Defined in

lib/chatkitty.ts:1530

---

getMessageRepliesCount

▸ getMessageRepliesCount(request): Promise<GetCountResult>

Parameters

Name	Type
request	GetMessageRepliesCountRequest

Returns

Promise<GetCountResult>

Implementation of

ChatKitty.getMessageRepliesCount

Defined in

lib/chatkitty.ts:1498

---

getMessages

▸ getMessages(request): Promise<GetMessagesResult>

Parameters

Name	Type
request	GetMessagesRequest

Returns

Promise<GetMessagesResult>

Implementation of

ChatKitty.getMessages

Defined in

lib/chatkitty.ts:1361

---

getReactions

▸ getReactions(request): Promise<GetReactionsResult>

Parameters

Name	Type
request	GetReactionsRequest

Returns

Promise<GetReactionsResult>

Implementation of

ChatKitty.getReactions

Defined in

lib/chatkitty.ts:1646

---

getReadReceipts

▸ getReadReceipts(request): Promise<GetReadReceiptsResult>

Parameters

Name	Type
request	GetReadReceiptsRequest

Returns

Promise<GetReadReceiptsResult>

Implementation of

ChatKitty.getReadReceipts

Defined in

lib/chatkitty.ts:1884

---

getThreadChannel

▸ getThreadChannel(request): Promise<GetThreadChannelResult>

Parameters

Name	Type
request	GetThreadChannelRequest

Returns

Promise<GetThreadChannelResult>

Implementation of

ChatKitty.getThreadChannel

Defined in

lib/chatkitty.ts:1588

---

getThreadMessage

▸ getThreadMessage(request): Promise<GetThreadMessageResult>

Parameters

Name	Type
request	GetThreadMessageRequest

Returns

Promise<GetThreadMessageResult>

Implementation of

ChatKitty.getThreadMessage

Defined in

lib/chatkitty.ts:1602

---

getThreads

▸ getThreads(request): Promise<GetThreadsResult>

Parameters

Name	Type
request	GetChannelThreadsRequest

Returns

Promise<GetThreadsResult>

Implementation of

ChatKitty.getThreads

Defined in

lib/chatkitty.ts:1563

---

getUnreadChannelsCount

▸ getUnreadChannelsCount(request?): Promise<GetCountResult>

Parameters

Name	Type
request?	GetUnreadChannelsRequest

Returns

Promise<GetCountResult>

Implementation of

ChatKitty.getUnreadChannelsCount

Defined in

lib/chatkitty.ts:763

---

getUnreadMessagesCount

▸ getUnreadMessagesCount(request?): Promise<GetCountResult>

Parameters

Name	Type
request?	GetUnreadMessagesCountRequest

Returns

Promise<GetCountResult>

Implementation of

ChatKitty.getUnreadMessagesCount

Defined in

lib/chatkitty.ts:1397

---

getUser

▸ getUser(param): Promise<GetUserResult>

Parameters

Name	Type
param	number

Returns

Promise<GetUserResult>

Implementation of

ChatKitty.getUser

Defined in

lib/chatkitty.ts:2053

---

getUserBlockList

▸ getUserBlockList(): Promise<GetUserBlockListResult>

Returns

Promise<GetUserBlockListResult>

Implementation of

ChatKitty.getUserBlockList

Defined in

lib/chatkitty.ts:2102

---

getUserIsChannelMember

▸ getUserIsChannelMember(request): Promise<GetUserIsChannelMemberResult>

Parameters

Name	Type
request	GetUserIsChannelMemberRequest

Returns

Promise<GetUserIsChannelMemberResult>

Implementation of

ChatKitty.getUserIsChannelMember

Defined in

lib/chatkitty.ts:2064

---

getUsers

▸ getUsers(request?): Promise<GetUsersResult>

Parameters

Name	Type
request?	GetUsersRequest

Returns

Promise<GetUsersResult>

Implementation of

ChatKitty.getUsers

Defined in

lib/chatkitty.ts:1906

---

getUsersCount

▸ getUsersCount(request?): Promise<GetCountResult>

Parameters

Name	Type
request?	GetUsersRequest

Returns

Promise<GetCountResult>

Implementation of

ChatKitty.getUsersCount

Defined in

lib/chatkitty.ts:1933

---

hideChannel

▸ hideChannel(request): Promise<HideChannelResult>

Parameters

Name	Type
request	HideChannelRequest

Returns

Promise<HideChannelResult>

Implementation of

ChatKitty.hideChannel

Defined in

lib/chatkitty.ts:901

---

inviteUser

▸ inviteUser(request): Promise<InviteUserResult>

Parameters

Name	Type
request	InviteUserRequest

Returns

Promise<InviteUserResult>

Implementation of

ChatKitty.inviteUser

Defined in

lib/chatkitty.ts:1984

---

joinChannel

▸ joinChannel(request): Promise<JoinChannelResult>

Parameters

Name	Type
request	JoinChannelRequest

Returns

Promise<JoinChannelResult>

Implementation of

ChatKitty.joinChannel

Defined in

lib/chatkitty.ts:684

---

leaveChannel

▸ leaveChannel(request): Promise<LeaveChannelResult>

Parameters

Name	Type
request	LeaveChannelRequest

Returns

Promise<LeaveChannelResult>

Implementation of

ChatKitty.leaveChannel

Defined in

lib/chatkitty.ts:711

---

muteChannel

▸ muteChannel(request): Promise<MuteChannelResult>

Parameters

Name	Type
request	MuteChannelRequest

Returns

Promise<MuteChannelResult>

Implementation of

ChatKitty.muteChannel

Defined in

lib/chatkitty.ts:833

---

onChannelHidden

▸ onChannelHidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onChannelHidden

Defined in

lib/chatkitty.ts:1765

---

onChannelJoined

▸ onChannelJoined(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onChannelJoined

Defined in

lib/chatkitty.ts:1741

---

onChannelLeft

▸ onChannelLeft(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onChannelLeft

Defined in

lib/chatkitty.ts:1813

---

onChannelUnhidden

▸ onChannelUnhidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onChannelUnhidden

Defined in

lib/chatkitty.ts:1789

---

onChannelUpdated

▸ onChannelUpdated(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onChannelUpdated

Defined in

lib/chatkitty.ts:1837

---

onCurrentUserChanged

▸ onCurrentUserChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onCurrentUserChanged

Defined in

lib/chatkitty.ts:440

---

onCurrentUserOffline

▸ onCurrentUserOffline(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onCurrentUserOffline

Defined in

lib/chatkitty.ts:472

---

onCurrentUserOnline

▸ onCurrentUserOnline(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onCurrentUserOnline

Defined in

lib/chatkitty.ts:456

---

onNotificationReceived

▸ onNotificationReceived(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onNotificationReceived

Defined in

lib/chatkitty.ts:1715

---

onParticipantStartedTyping

▸ onParticipantStartedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onParticipantStartedTyping

Defined in

lib/chatkitty.ts:2005

---

onParticipantStoppedTyping

▸ onParticipantStoppedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onParticipantStoppedTyping

Defined in

lib/chatkitty.ts:2029

---

onUserPresenceChanged

▸ onUserPresenceChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Implementation of

ChatKitty.onUserPresenceChanged

Defined in

lib/chatkitty.ts:1960

---

reactToMessage

▸ reactToMessage(request): Promise<ReactToMessageResult>

Parameters

Name	Type
request	ReactToMessageRequest

Returns

Promise<ReactToMessageResult>

Implementation of

ChatKitty.reactToMessage

Defined in

lib/chatkitty.ts:1633

---

readChannel

▸ readChannel(request): Promise<ReadChannelResult>

Parameters

Name	Type
request	ReadChannelRequest

Returns

Promise<ReadChannelResult>

Implementation of

ChatKitty.readChannel

Defined in

lib/chatkitty.ts:816

---

readMessage

▸ readMessage(request): Promise<ReadMessageResult>

Parameters

Name	Type
request	ReadMessageRequest

Returns

Promise<ReadMessageResult>

Implementation of

ChatKitty.readMessage

Defined in

lib/chatkitty.ts:1454

---

readThread

▸ readThread(request): Promise<ReadThreadResult>

Parameters

Name	Type
request	ReadThreadRequest

Returns

Promise<ReadThreadResult>

Implementation of

ChatKitty.readThread

Defined in

lib/chatkitty.ts:1616

---

removeReaction

▸ removeReaction(request): Promise<RemoveReactionResult>

Parameters

Name	Type
request	RemoveReactionRequest

Returns

Promise<RemoveReactionResult>

Implementation of

ChatKitty.removeReaction

Defined in

lib/chatkitty.ts:1662

---

sendKeystrokes

▸ sendKeystrokes(request): void

Parameters

Name	Type
request	SendKeystrokesRequest

Returns

void

Implementation of

ChatKitty.sendKeystrokes

Defined in

lib/chatkitty.ts:1705

---

sendMessage

▸ sendMessage(request): Promise<SendMessageResult>

Parameters

Name	Type
request	SendMessageRequest

Returns

Promise<SendMessageResult>

Implementation of

ChatKitty.sendMessage

Defined in

lib/chatkitty.ts:1243

---

startChatSession

▸ startChatSession(request): StartChatSessionResult

Parameters

Name	Type
request	StartChatSessionRequest

Returns

StartChatSessionResult

Implementation of

ChatKitty.startChatSession

Defined in

lib/chatkitty.ts:913

---

startSession

▸ startSession(request): Promise<StartSessionResult>

Parameters

Name	Type
request	StartSessionRequest

Returns

Promise<StartSessionResult>

Implementation of

ChatKitty.startSession

Defined in

lib/chatkitty.ts:360

---

triggerEvent

▸ triggerEvent(request): Promise<TriggerEventResult>

Parameters

Name	Type
request	TriggerEventRequest

Returns

Promise<TriggerEventResult>

Implementation of

ChatKitty.triggerEvent

Defined in

lib/chatkitty.ts:1428

---

unmuteChannel

▸ unmuteChannel(request): Promise<UnmuteChannelResult>

Parameters

Name	Type
request	UnmuteChannelRequest

Returns

Promise<UnmuteChannelResult>

Implementation of

ChatKitty.unmuteChannel

Defined in

lib/chatkitty.ts:856

---

updateChannel

▸ updateChannel(request): Promise<UpdateChannelResult>

Parameters

Name	Type
request	UpdateChannelRequest

Returns

Promise<UpdateChannelResult>

Implementation of

ChatKitty.updateChannel

Defined in

lib/chatkitty.ts:569

---

updateCurrentUser

▸ updateCurrentUser(update): Promise<UpdateCurrentUserResult>

Parameters

Name	Type
update	(user: CurrentUser) => CurrentUser

Returns

Promise<UpdateCurrentUserResult>

Implementation of

ChatKitty.updateCurrentUser

Defined in

lib/chatkitty.ts:488

---

updateCurrentUserDisplayPicture

▸ updateCurrentUserDisplayPicture(request): Promise<UpdateCurrentUserDisplayPictureResult>

Parameters

Name	Type
request	UpdateCurrentUserDisplayPictureRequest

Returns

Promise<UpdateCurrentUserDisplayPictureResult>

Implementation of

ChatKitty.updateCurrentUserDisplayPicture

Defined in

lib/chatkitty.ts:513

---

getInstance

▸ Static getInstance(apiKey): ChatKitty

Parameters

Name	Type
apiKey	string

Returns

ChatKitty

Defined in

lib/chatkitty.ts:214