Skip to main content

ChatKitty

ChatKitty JS SDK / Exports / ChatKitty

Interface: ChatKitty

Implemented by

Table of contents

Properties

Methods

Properties

Calls

Calls: Calls

Defined in

lib/chatkitty.ts:2235


currentUser

Optional currentUser: CurrentUser

Defined in

lib/chatkitty.ts:2234

Methods

addChannelModerator

addChannelModerator(request): Promise<AddChannelModeratorResult>

Parameters

NameType
requestAddChannelModeratorRequest

Returns

Promise<AddChannelModeratorResult>

Defined in

lib/chatkitty.ts:2289


blockUser

blockUser(request): Promise<BlockUserResult>

Parameters

NameType
requestBlockUserRequest

Returns

Promise<BlockUserResult>

Defined in

lib/chatkitty.ts:2441


clearChannelHistory

clearChannelHistory(request): Promise<ClearChannelHistoryResult>

Parameters

NameType
requestClearChannelHistoryRequest

Returns

Promise<ClearChannelHistoryResult>

Defined in

lib/chatkitty.ts:2309


createChannel

createChannel(request): Promise<CreateChannelResult>

Parameters

NameType
requestCreateChannelRequest

Returns

Promise<CreateChannelResult>

Defined in

lib/chatkitty.ts:2275


createThread

createThread(request): Promise<CreateThreadResult>

Parameters

NameType
requestCreateThreadRequest

Returns

Promise<CreateThreadResult>

Defined in

lib/chatkitty.ts:2351


deleteChannel

deleteChannel(request): Promise<DeleteChannelResult>

Parameters

NameType
requestDeleteChannelRequest

Returns

Promise<DeleteChannelResult>

Defined in

lib/chatkitty.ts:2271


deleteMessage

deleteMessage(request): Promise<DeleteMessageResult>

Parameters

NameType
requestDeleteMessageRequest

Returns

Promise<DeleteMessageResult>

Defined in

lib/chatkitty.ts:2377


deleteMessageForMe

deleteMessageForMe(request): Promise<DeleteMessageForMeResult>

Parameters

NameType
requestDeleteMessageForMeRequest

Returns

Promise<DeleteMessageForMeResult>

Defined in

lib/chatkitty.ts:2373


deleteUserBlockListItem

deleteUserBlockListItem(request): Promise<DeleteUserBlockListItemResult>

Parameters

NameType
requestDeleteUserBlockListItemRequest

Returns

Promise<DeleteUserBlockListItemResult>

Defined in

lib/chatkitty.ts:2445


editMessage

editMessage(request): Promise<EditMessageResult>

Parameters

NameType
requestEditMessageRequest

Returns

Promise<EditMessageResult>

Defined in

lib/chatkitty.ts:2337


endSession

endSession(): Promise<void>

Returns

Promise<void>

Defined in

lib/chatkitty.ts:2241


getChannel

getChannel(id): Promise<GetChannelResult>

Parameters

NameType
idnumber

Returns

Promise<GetChannelResult>

Defined in

lib/chatkitty.ts:2281


getChannelMembers

getChannelMembers(request): Promise<GetUsersResult>

Parameters

NameType
requestGetChannelMembersRequest

Returns

Promise<GetUsersResult>

Defined in

lib/chatkitty.ts:2409


getChannelUnread

getChannelUnread(request): Promise<GetChannelUnreadResult>

Parameters

NameType
requestGetChannelUnreadRequest

Returns

Promise<GetChannelUnreadResult>

Defined in

lib/chatkitty.ts:2297


getChannels

getChannels(request?): Promise<GetChannelsResult>

Parameters

NameType
request?GetChannelsRequest

Returns

Promise<GetChannelsResult>

Defined in

lib/chatkitty.ts:2279


getCurrentUser

getCurrentUser(): Promise<GetCurrentUserResult>

Returns

Promise<GetCurrentUserResult>

Defined in

lib/chatkitty.ts:2243


getLastReadMessage

getLastReadMessage(request): Promise<GetLastReadMessageResult>

Parameters

NameType
requestGetLastReadMessageRequest

Returns

Promise<GetLastReadMessageResult>

Defined in

lib/chatkitty.ts:2333


getMessageChannel

getMessageChannel(request): Promise<GetMessageChannelResult>

Parameters

NameType
requestGetMessageChannelRequest

Returns

Promise<GetMessageChannelResult>

Defined in

lib/chatkitty.ts:2343


getMessageParent

getMessageParent(request): Promise<GetMessageParentResult>

Parameters

NameType
requestGetMessageParentRequest

Returns

Promise<GetMessageParentResult>

Defined in

lib/chatkitty.ts:2347


getMessageRepliesCount

getMessageRepliesCount(request): Promise<GetCountResult>

Parameters

NameType
requestGetMessageRepliesCountRequest

Returns

Promise<GetCountResult>

Defined in

lib/chatkitty.ts:2339


getMessages

getMessages(request): Promise<GetMessagesResult>

Parameters

NameType
requestGetMessagesRequest

Returns

Promise<GetMessagesResult>

Defined in

lib/chatkitty.ts:2321


getReactions

getReactions(request): Promise<GetReactionsResult>

Parameters

NameType
requestGetReactionsRequest

Returns

Promise<GetReactionsResult>

Defined in

lib/chatkitty.ts:2365


getReadReceipts

getReadReceipts(request): Promise<GetReadReceiptsResult>

Parameters

NameType
requestGetReadReceiptsRequest

Returns

Promise<GetReadReceiptsResult>

Defined in

lib/chatkitty.ts:2413


getThreadChannel

getThreadChannel(request): Promise<GetThreadChannelResult>

Parameters

NameType
requestGetThreadChannelRequest

Returns

Promise<GetThreadChannelResult>

Defined in

lib/chatkitty.ts:2355


getThreadMessage

getThreadMessage(request): Promise<GetThreadMessageResult>

Parameters

NameType
requestGetThreadMessageRequest

Returns

Promise<GetThreadMessageResult>

Defined in

lib/chatkitty.ts:2357


getThreads

getThreads(request): Promise<GetThreadsResult>

Parameters

NameType
requestGetChannelThreadsRequest

Returns

Promise<GetThreadsResult>

Defined in

lib/chatkitty.ts:2353


getUnreadChannelsCount

getUnreadChannelsCount(request?): Promise<GetCountResult>

Parameters

NameType
request?GetUnreadChannelsRequest

Returns

Promise<GetCountResult>

Defined in

lib/chatkitty.ts:2293


getUnreadMessagesCount

getUnreadMessagesCount(request?): Promise<GetCountResult>

Parameters

NameType
request?GetUnreadMessagesCountRequest

Returns

Promise<GetCountResult>

Defined in

lib/chatkitty.ts:2323


getUser

getUser(param): Promise<GetUserResult>

Parameters

NameType
paramnumber

Returns

Promise<GetUserResult>

Defined in

lib/chatkitty.ts:2435


getUserBlockList

getUserBlockList(): Promise<GetUserBlockListResult>

Returns

Promise<GetUserBlockListResult>

Defined in

lib/chatkitty.ts:2443


getUserIsChannelMember

getUserIsChannelMember(request): Promise<GetUserIsChannelMemberResult>

Parameters

NameType
requestGetUserIsChannelMemberRequest

Returns

Promise<GetUserIsChannelMemberResult>

Defined in

lib/chatkitty.ts:2437


getUsers

getUsers(request?): Promise<GetUsersResult>

Parameters

NameType
request?GetUsersRequest

Returns

Promise<GetUsersResult>

Defined in

lib/chatkitty.ts:2417


getUsersCount

getUsersCount(request?): Promise<GetCountResult>

Parameters

NameType
request?GetUsersRequest

Returns

Promise<GetCountResult>

Defined in

lib/chatkitty.ts:2419


hideChannel

hideChannel(request): Promise<HideChannelResult>

Parameters

NameType
requestHideChannelRequest

Returns

Promise<HideChannelResult>

Defined in

lib/chatkitty.ts:2313


inviteUser

inviteUser(request): Promise<InviteUserResult>

Parameters

NameType
requestInviteUserRequest

Returns

Promise<InviteUserResult>

Defined in

lib/chatkitty.ts:2425


joinChannel

joinChannel(request): Promise<JoinChannelResult>

Parameters

NameType
requestJoinChannelRequest

Returns

Promise<JoinChannelResult>

Defined in

lib/chatkitty.ts:2283


leaveChannel

leaveChannel(request): Promise<LeaveChannelResult>

Parameters

NameType
requestLeaveChannelRequest

Returns

Promise<LeaveChannelResult>

Defined in

lib/chatkitty.ts:2285


muteChannel

muteChannel(request): Promise<MuteChannelResult>

Parameters

NameType
requestMuteChannelRequest

Returns

Promise<MuteChannelResult>

Defined in

lib/chatkitty.ts:2303


onChannelHidden

onChannelHidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2393


onChannelJoined

onChannelJoined(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2389


onChannelLeft

onChannelLeft(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2401


onChannelUnhidden

onChannelUnhidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2397


onChannelUpdated

onChannelUpdated(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2405


onCurrentUserChanged

onCurrentUserChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2245


onCurrentUserOffline

onCurrentUserOffline(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<CurrentUser> | () => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2255


onCurrentUserOnline

onCurrentUserOnline(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<CurrentUser> | () => void

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2251


onNotificationReceived

onNotificationReceived(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2383


onParticipantStartedTyping

onParticipantStartedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2427


onParticipantStoppedTyping

onParticipantStoppedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2431


onUserPresenceChanged

onUserPresenceChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

lib/chatkitty.ts:2421


reactToMessage

reactToMessage(request): Promise<ReactToMessageResult>

Parameters

NameType
requestReactToMessageRequest

Returns

Promise<ReactToMessageResult>

Defined in

lib/chatkitty.ts:2361


readChannel

readChannel(request): Promise<ReadChannelResult>

Parameters

NameType
requestReadChannelRequest

Returns

Promise<ReadChannelResult>

Defined in

lib/chatkitty.ts:2301


readMessage

readMessage(request): Promise<ReadMessageResult>

Parameters

NameType
requestReadMessageRequest

Returns

Promise<ReadMessageResult>

Defined in

lib/chatkitty.ts:2331


readThread

readThread(request): Promise<ReadThreadResult>

Parameters

NameType
requestReadThreadRequest

Returns

Promise<ReadThreadResult>

Defined in

lib/chatkitty.ts:2359


removeReaction

removeReaction(request): Promise<RemoveReactionResult>

Parameters

NameType
requestRemoveReactionRequest

Returns

Promise<RemoveReactionResult>

Defined in

lib/chatkitty.ts:2369


sendKeystrokes

sendKeystrokes(request): void

Parameters

NameType
requestSendKeystrokesRequest

Returns

void

Defined in

lib/chatkitty.ts:2381


sendMessage

sendMessage(request): Promise<SendMessageResult>

Parameters

NameType
requestSendMessageRequest

Returns

Promise<SendMessageResult>

Defined in

lib/chatkitty.ts:2319


startChatSession

startChatSession(request): StartChatSessionResult

Parameters

NameType
requestStartChatSessionRequest

Returns

StartChatSessionResult

Defined in

lib/chatkitty.ts:2315


startSession

startSession(request): Promise<StartSessionResult>

Parameters

NameType
requestStartSessionRequest

Returns

Promise<StartSessionResult>

Defined in

lib/chatkitty.ts:2237


triggerEvent

triggerEvent(request): Promise<TriggerEventResult>

Parameters

NameType
requestTriggerEventRequest

Returns

Promise<TriggerEventResult>

Defined in

lib/chatkitty.ts:2327


unmuteChannel

unmuteChannel(request): Promise<UnmuteChannelResult>

Parameters

NameType
requestUnmuteChannelRequest

Returns

Promise<UnmuteChannelResult>

Defined in

lib/chatkitty.ts:2305


updateChannel

updateChannel(request): Promise<UpdateChannelResult>

Parameters

NameType
requestUpdateChannelRequest

Returns

Promise<UpdateChannelResult>

Defined in

lib/chatkitty.ts:2267


updateCurrentUser

updateCurrentUser(update): Promise<UpdateCurrentUserResult>

Parameters

NameType
update(user: CurrentUser) => CurrentUser

Returns

Promise<UpdateCurrentUserResult>

Defined in

lib/chatkitty.ts:2259


updateCurrentUserDisplayPicture

updateCurrentUserDisplayPicture(request): Promise<UpdateCurrentUserDisplayPictureResult>

Parameters

NameType
requestUpdateCurrentUserDisplayPictureRequest

Returns

Promise<UpdateCurrentUserDisplayPictureResult>

Defined in

lib/chatkitty.ts:2263