Skip to main content

Interface: SdkClient

Methods​

addChannelModerator()​

addChannelModerator(request): Promise<AddChannelModeratorResult>

Parameters​

request​

AddChannelModeratorRequest

Returns​

Promise<AddChannelModeratorResult>

blockChannelUser()​

blockChannelUser(request): Promise<BlockChannelUserResult>

Parameters​

request​

BlockChannelUserRequest

Returns​

Promise<BlockChannelUserResult>

blockUser()​

blockUser(request): Promise<BlockUserResult>

Parameters​

request​

BlockUserRequest

Returns​

Promise<BlockUserResult>

checkChannelUnread()​

checkChannelUnread(request): Promise<CheckChannelUnreadResult>

Parameters​

request​

CheckChannelUnreadRequest

Returns​

Promise<CheckChannelUnreadResult>

checkUserIsChannelMember()​

checkUserIsChannelMember(request): Promise<CheckUserIsChannelMemberResult>

Parameters​

request​

CheckUserIsChannelMemberRequest

Returns​

Promise<CheckUserIsChannelMemberResult>

clearChannelHistory()​

clearChannelHistory(request): Promise<ClearChannelHistoryResult>

Parameters​

request​

ClearChannelHistoryRequest

Returns​

Promise<ClearChannelHistoryResult>

countMessageReplies()​

countMessageReplies(request): Promise<CountResult>

Parameters​

request​

CountMessageRepliesRequest

Returns​

Promise<CountResult>

countUnreadChannels()​

countUnreadChannels(request?): Promise<CountResult>

Parameters​

request?​

ListUnreadChannelsRequest

Returns​

Promise<CountResult>

countUnreadMessages()​

countUnreadMessages(request?): Promise<CountResult>

Parameters​

request?​

CountUnreadMessagesRequest

Returns​

Promise<CountResult>

createChannel()​

createChannel(request): Promise<CreateChannelResult>

Parameters​

request​

CreateChannelRequest

Returns​

Promise<CreateChannelResult>

createThread()​

createThread(request): Promise<CreateThreadResult>

Parameters​

request​

CreateThreadRequest

Returns​

Promise<CreateThreadResult>

deleteChannel()​

deleteChannel(request): Promise<DeleteChannelResult>

Parameters​

request​

DeleteChannelRequest

Returns​

Promise<DeleteChannelResult>

deleteChannelModerator()​

deleteChannelModerator(request): Promise<DeleteChannelModeratorResult>

Parameters​

request​

DeleteChannelModeratorRequest

Returns​

Promise<DeleteChannelModeratorResult>

deleteMessage()​

deleteMessage(request): Promise<DeleteMessageResult>

Parameters​

request​

DeleteMessageRequest

Returns​

Promise<DeleteMessageResult>

deleteUser()​

deleteUser(request): Promise<DeleteUserResult>

Parameters​

request​

DeleteUserRequest

Returns​

Promise<DeleteUserResult>

deleteUserBlockedRecord()​

deleteUserBlockedRecord(request): Promise<DeleteUserBlockedRecordResult>

Parameters​

request​

DeleteUserBlockedRecordRequest

Returns​

Promise<DeleteUserBlockedRecordResult>

editMessage()​

editMessage(request): Promise<EditMessageResult>

Parameters​

request​

EditMessageRequest

Returns​

Promise<EditMessageResult>

endSession()​

endSession(): Promise<void>

Returns​

Promise<void>

hideChannel()​

hideChannel(request): Promise<HideChannelResult>

Parameters​

request​

HideChannelRequest

Returns​

Promise<HideChannelResult>

inviteUser()​

inviteUser(request): Promise<InviteUserResult>

Parameters​

request​

InviteUserRequest

Returns​

Promise<InviteUserResult>

joinChannel()​

joinChannel(request): Promise<JoinChannelResult>

Parameters​

request​

JoinChannelRequest

Returns​

Promise<JoinChannelResult>

leaveChannel()​

leaveChannel(request): Promise<LeaveChannelResult>

Parameters​

request​

LeaveChannelRequest

Returns​

Promise<LeaveChannelResult>

listChannelBlockRecords()​

listChannelBlockRecords(request): Promise<ListChannelBlockRecordsResult>

Parameters​

request​

ListChannelBlockRecordsRequest

Returns​

Promise<ListChannelBlockRecordsResult>

listChannelMembers()​

listChannelMembers(request): Promise<ListUsersResult>

Parameters​

request​

ListChannelMembersRequest

Returns​

Promise<ListUsersResult>

listChannelModerators()​

listChannelModerators(request): Promise<ListChannelModeratorsResult>

Parameters​

request​

ListChannelModeratorsRequest

Returns​

Promise<ListChannelModeratorsResult>

listChannels()​

listChannels(request?): Promise<ListChannelsResult>

Parameters​

request?​

ListChannelsRequest

Returns​

Promise<ListChannelsResult>

listMessages()​

listMessages(request): Promise<ListMessagesResult>

Parameters​

request​

ListMessagesRequest

Returns​

Promise<ListMessagesResult>

listReactions()​

listReactions(request): Promise<ListReactionsResult>

Parameters​

request​

ListReactionsRequest

Returns​

Promise<ListReactionsResult>

listReadReceipts()​

listReadReceipts(request): Promise<ListReadReceiptsResult>

Parameters​

request​

ListReadReceiptsRequest

Returns​

Promise<ListReadReceiptsResult>

listThreadChannel()​

listThreadChannel(request): Promise<RetrieveThreadChannelResult>

Parameters​

request​

RetrieveThreadChannelRequest

Returns​

Promise<RetrieveThreadChannelResult>

listThreadMessage()​

listThreadMessage(request): Promise<RetrieveThreadMessageResult>

Parameters​

request​

RetrieveThreadMessageRequest

Returns​

Promise<RetrieveThreadMessageResult>

listThreads()​

listThreads(request): Promise<ListThreadsResult>

Parameters​

request​

ListChannelThreadsRequest

Returns​

Promise<ListThreadsResult>

listUserBlockedRecords()​

listUserBlockedRecords(request): Promise<ListUserBlockedRecordsResult>

Parameters​

request​

ListBlockedRecordsRequest

Returns​

Promise<ListUserBlockedRecordsResult>

listUsers()​

listUsers(request?): Promise<ListUsersResult>

Parameters​

request?​

ListUsersRequest

Returns​

Promise<ListUsersResult>

listUsersCount()​

listUsersCount(request?): Promise<CountResult>

Parameters​

request?​

ListUsersRequest

Returns​

Promise<CountResult>

muteChannel()​

muteChannel(request): Promise<MuteChannelResult>

Parameters​

request​

MuteChannelRequest

Returns​

Promise<MuteChannelResult>

onApplicationElementsChanged()​

onApplicationElementsChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<UiElements> | (elements) => void

Returns​

ChatKittyUnsubscribe

onApplicationFeaturesChanged()​

onApplicationFeaturesChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<ChatUIFeatureOptions> | (features) => void

Returns​

ChatKittyUnsubscribe

onApplicationStylesChanged()​

onApplicationStylesChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<ChatUIThemeStylingOptions> | (styles) => void

Returns​

ChatKittyUnsubscribe

onChannelDeleted()​

onChannelDeleted(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<Channel> | (channel) => void

Returns​

ChatKittyUnsubscribe

onChannelHidden()​

onChannelHidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<Channel> | (channel) => void

Returns​

ChatKittyUnsubscribe

onChannelJoined()​

onChannelJoined(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<Channel> | (channel) => void

Returns​

ChatKittyUnsubscribe

onChannelLeft()​

onChannelLeft(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<Channel> | (channel) => void

Returns​

ChatKittyUnsubscribe

onChannelUnhidden()​

onChannelUnhidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<Channel> | (channel) => void

Returns​

ChatKittyUnsubscribe

onChannelUpdated()​

onChannelUpdated(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<Channel> | (channel) => void

Returns​

ChatKittyUnsubscribe

onCurrentUserChanged()​

onCurrentUserChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<CurrentUser> | (user) => void

Returns​

ChatKittyUnsubscribe

onCurrentUserOffline()​

onCurrentUserOffline(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<CurrentUser> | () => void

Returns​

ChatKittyUnsubscribe

onCurrentUserOnline()​

onCurrentUserOnline(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<CurrentUser> | () => void

Returns​

ChatKittyUnsubscribe

onNotificationReceived()​

onNotificationReceived(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<Notification> | (notification) => void

Returns​

ChatKittyUnsubscribe

onParticipantStartedTyping()​

onParticipantStartedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<User> | (participant) => void

Returns​

ChatKittyUnsubscribe

onParticipantStoppedTyping()​

onParticipantStoppedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<User> | (participant) => void

Returns​

ChatKittyUnsubscribe

onReadReceiptCreated()​

onReadReceiptCreated(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<ReadReceipt> | (receipt) => void

Returns​

ChatKittyUnsubscribe

onReadReceiptDeleted()​

onReadReceiptDeleted(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<ReadReceipt> | (receipt) => void

Returns​

ChatKittyUnsubscribe

onUserBlocked()​

onUserBlocked(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<UserBlockedRecord> | (record) => void

Returns​

ChatKittyUnsubscribe

onUserPresenceChanged()​

onUserPresenceChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<User> | (user) => void

Returns​

ChatKittyUnsubscribe

onUserUnblocked()​

onUserUnblocked(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<User> | (user) => void

Returns​

ChatKittyUnsubscribe

onUserUpdated()​

onUserUpdated(onNextOrObserver): ChatKittyUnsubscribe

Parameters​

onNextOrObserver​

ChatKittyObserver<User> | (user) => void

Returns​

ChatKittyUnsubscribe

reactToMessage()​

reactToMessage(request): Promise<ReactToMessageResult>

Parameters​

request​

ReactToMessageRequest

Returns​

Promise<ReactToMessageResult>

readChannel()​

readChannel(request): Promise<ReadChannelResult>

Parameters​

request​

ReadChannelRequest

Returns​

Promise<ReadChannelResult>

readMessage()​

readMessage(request): Promise<ReadMessageResult>

Parameters​

request​

ReadMessageRequest

Returns​

Promise<ReadMessageResult>

readThread()​

readThread(request): Promise<ReadThreadResult>

Parameters​

request​

ReadThreadRequest

Returns​

Promise<ReadThreadResult>

removeReaction()​

removeReaction(request): Promise<RemoveReactionResult>

Parameters​

request​

RemoveReactionRequest

Returns​

Promise<RemoveReactionResult>

reportMessage()​

reportMessage(request): Promise<ReportMessageResult>

Parameters​

request​

ReportMessageRequest

Returns​

Promise<ReportMessageResult>

retrieveChannel()​

retrieveChannel(id): Promise<RetrieveChannelResult>

Parameters​

id​

number

Returns​

Promise<RetrieveChannelResult>

retrieveChannelContext()​

retrieveChannelContext(request): Promise<RetrieveChannelContextResult>

Parameters​

request​

RetrieveChannelContextRequest

Returns​

Promise<RetrieveChannelContextResult>

retrieveCurrentUser()​

retrieveCurrentUser(): Promise<RetrieveCurrentUserResult>

Returns​

Promise<RetrieveCurrentUserResult>

retrieveLastReadMessage()​

retrieveLastReadMessage(request): Promise<RetrieveLastReadMessageResult>

Parameters​

request​

RetrieveLastReadMessageRequest

Returns​

Promise<RetrieveLastReadMessageResult>

retrieveMessageChannel()​

retrieveMessageChannel(request): Promise<RetrieveMessageChannelResult>

Parameters​

request​

RetrieveMessageChannelRequest

Returns​

Promise<RetrieveMessageChannelResult>

retrieveMessageParent()​

retrieveMessageParent(request): Promise<RetrieveMessageParentResult>

Parameters​

request​

RetrieveMessageParentRequest

Returns​

Promise<RetrieveMessageParentResult>

retrieveUser()​

retrieveUser(param): Promise<RetrieveUserResult>

Parameters​

param​

number

Returns​

Promise<RetrieveUserResult>

sendKeystrokes()​

sendKeystrokes(request): void

Parameters​

request​

SendKeystrokesRequest

Returns​

void

sendMessage()​

sendMessage(request): Promise<SendMessageResult>

Parameters​

request​

SendMessageRequest

Returns​

Promise<SendMessageResult>

startChatSession()​

startChatSession(request): StartedChatSessionResult

Parameters​

request​

StartChatSessionRequest

Returns​

StartedChatSessionResult

startSession()​

startSession(request): Promise<StartSessionResult>

Parameters​

request​

StartSessionRequest

Returns​

Promise<StartSessionResult>

triggerEvent()​

triggerEvent(request): Promise<TriggerEventResult>

Parameters​

request​

TriggerEventRequest

Returns​

Promise<TriggerEventResult>

unblockChannelUser()​

unblockChannelUser(request): Promise<UnblockChannelUserResult>

Parameters​

request​

UnblockChannelUserRequest

Returns​

Promise<UnblockChannelUserResult>

unmuteChannel()​

unmuteChannel(request): Promise<UnmuteChannelResult>

Parameters​

request​

UnmuteChannelRequest

Returns​

Promise<UnmuteChannelResult>

unreadMessage()​

unreadMessage(request): Promise<UnreadMessageResult>

Parameters​

request​

UnreadMessageRequest

Returns​

Promise<UnreadMessageResult>

updateChannel()​

updateChannel(request): Promise<UpdateChannelResult>

Parameters​

request​

UpdateChannelRequest

Returns​

Promise<UpdateChannelResult>

updateCurrentUser()​

updateCurrentUser(update): Promise<UpdateCurrentUserResult>

Parameters​

update​

(user) => CurrentUser

Returns​

Promise<UpdateCurrentUserResult>

updateCurrentUserDisplayPicture()​

updateCurrentUserDisplayPicture(request): Promise<UpdateCurrentUserDisplayPictureResult>

Parameters​

request​

UpdateCurrentUserDisplayPictureRequest

Returns​

Promise<UpdateCurrentUserDisplayPictureResult>

updateMessageProperties()​

updateMessageProperties(request): Promise<unknown>

Parameters​

request​

UpdateMessagePropertiesRequest

Returns​

Promise<unknown>