Skip to main content

default

ChatKitty React Native / Exports / default

Class: default

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new default(configuration)

Parameters

NameType
configurationChatKittyConfiguration

Defined in

chatkitty.ts:956

Properties

Calls

Calls: Calls

Defined in

chatkitty.ts:302


currentUser

Optional currentUser: CurrentUser

Defined in

chatkitty.ts:300

Methods

addChannelModerator

addChannelModerator(request): Promise<AddChannelModeratorResult>

Parameters

NameType
requestAddChannelModeratorRequest

Returns

Promise<AddChannelModeratorResult>

Defined in

chatkitty.ts:1374


blockUser

blockUser(request): Promise<BlockUserResult>

Parameters

NameType
requestBlockUserRequest

Returns

Promise<BlockUserResult>

Defined in

chatkitty.ts:2732


clearChannelHistory

clearChannelHistory(request): Promise<ClearChannelHistoryResult>

Parameters

NameType
requestClearChannelHistoryRequest

Returns

Promise<ClearChannelHistoryResult>

Defined in

chatkitty.ts:1515


createChannel

createChannel(request): Promise<CreateChannelResult>

Parameters

NameType
requestCreateChannelRequest

Returns

Promise<CreateChannelResult>

Defined in

chatkitty.ts:1233


createThread

createThread(request): Promise<CreateThreadResult>

Parameters

NameType
requestCreateThreadRequest

Returns

Promise<CreateThreadResult>

Defined in

chatkitty.ts:2191


deleteChannel

deleteChannel(request): Promise<DeleteChannelResult>

Parameters

NameType
requestDeleteChannelRequest

Returns

Promise<DeleteChannelResult>

Defined in

chatkitty.ts:1216


deleteMessage

deleteMessage(request): Promise<DeleteMessageResult>

Parameters

NameType
requestDeleteMessageRequest

Returns

Promise<DeleteMessageResult>

Defined in

chatkitty.ts:2334


deleteMessageForMe

deleteMessageForMe(request): Promise<DeleteMessageForMeResult>

Parameters

NameType
requestDeleteMessageForMeRequest

Returns

Promise<DeleteMessageForMeResult>

Defined in

chatkitty.ts:2320


deleteUserBlockListItem

deleteUserBlockListItem(request): Promise<DeleteUserBlockListItemResult>

Parameters

NameType
requestDeleteUserBlockListItemRequest

Returns

Promise<DeleteUserBlockListItemResult>

Defined in

chatkitty.ts:2765


editMessage

editMessage(request): Promise<EditMessageResult>

Parameters

NameType
requestEditMessageRequest

Returns

Promise<EditMessageResult>

Defined in

chatkitty.ts:2123


endSession

endSession(): Promise<void>

Returns

Promise<void>

Defined in

chatkitty.ts:1033


getChannel

getChannel(id): Promise<GetChannelResult>

Parameters

NameType
idnumber

Returns

Promise<GetChannelResult>

Defined in

chatkitty.ts:1304


getChannelMembers

getChannelMembers(request): Promise<GetUsersResult>

Parameters

NameType
requestGetChannelMembersRequest

Returns

Promise<GetUsersResult>

Defined in

chatkitty.ts:2504


getChannelUnread

getChannelUnread(request): Promise<GetChannelUnreadResult>

Parameters

NameType
requestGetChannelUnreadRequest

Returns

Promise<GetChannelUnreadResult>

Defined in

chatkitty.ts:1428


getChannels

getChannels(request?): Promise<GetChannelsResult>

Parameters

NameType
request?GetChannelsRequest

Returns

Promise<GetChannelsResult>

Defined in

chatkitty.ts:1261


getCurrentUser

getCurrentUser(): Promise<GetCurrentUserResult>

Returns

Promise<GetCurrentUserResult>

Defined in

chatkitty.ts:1049


getLastReadMessage

getLastReadMessage(request): Promise<GetLastReadMessageResult>

Parameters

NameType
requestGetLastReadMessageRequest

Returns

Promise<GetLastReadMessageResult>

Defined in

chatkitty.ts:2104


getMessageChannel

getMessageChannel(request): Promise<GetMessageChannelResult>

Parameters

NameType
requestGetMessageChannelRequest

Returns

Promise<GetMessageChannelResult>

Defined in

chatkitty.ts:2153


getMessageParent

getMessageParent(request): Promise<GetMessageParentResult>

Parameters

NameType
requestGetMessageParentRequest

Returns

Promise<GetMessageParentResult>

Defined in

chatkitty.ts:2169


getMessageRepliesCount

getMessageRepliesCount(request): Promise<GetCountResult>

Parameters

NameType
requestGetMessageRepliesCountRequest

Returns

Promise<GetCountResult>

Defined in

chatkitty.ts:2137


getMessages

getMessages(request): Promise<GetMessagesResult>

Parameters

NameType
requestGetMessagesRequest

Returns

Promise<GetMessagesResult>

Defined in

chatkitty.ts:2000


getReactions

getReactions(request): Promise<GetReactionsResult>

Parameters

NameType
requestGetReactionsRequest

Returns

Promise<GetReactionsResult>

Defined in

chatkitty.ts:2289


getReadReceipts

getReadReceipts(request): Promise<GetReadReceiptsResult>

Parameters

NameType
requestGetReadReceiptsRequest

Returns

Promise<GetReadReceiptsResult>

Defined in

chatkitty.ts:2527


getThreadChannel

getThreadChannel(request): Promise<GetThreadChannelResult>

Parameters

NameType
requestGetThreadChannelRequest

Returns

Promise<GetThreadChannelResult>

Defined in

chatkitty.ts:2227


getThreadMessage

getThreadMessage(request): Promise<GetThreadMessageResult>

Parameters

NameType
requestGetThreadMessageRequest

Returns

Promise<GetThreadMessageResult>

Defined in

chatkitty.ts:2243


getThreads

getThreads(request): Promise<GetThreadsResult>

Parameters

NameType
requestGetChannelThreadsRequest

Returns

Promise<GetThreadsResult>

Defined in

chatkitty.ts:2204


getUnreadChannelsCount

getUnreadChannelsCount(request?): Promise<GetCountResult>

Parameters

NameType
request?GetUnreadChannelsRequest

Returns

Promise<GetCountResult>

Defined in

chatkitty.ts:1397


getUnreadMessagesCount

getUnreadMessagesCount(request?): Promise<GetCountResult>

Parameters

NameType
request?GetUnreadMessagesCountRequest

Returns

Promise<GetCountResult>

Defined in

chatkitty.ts:2036


getUser

getUser(param): Promise<GetUserResult>

Parameters

NameType
paramnumber

Returns

Promise<GetUserResult>

Defined in

chatkitty.ts:2696


getUserBlockList

getUserBlockList(): Promise<GetUserBlockListResult>

Returns

Promise<GetUserBlockListResult>

Defined in

chatkitty.ts:2745


getUserIsChannelMember

getUserIsChannelMember(request): Promise<GetUserIsChannelMemberResult>

Parameters

NameType
requestGetUserIsChannelMemberRequest

Returns

Promise<GetUserIsChannelMemberResult>

Defined in

chatkitty.ts:2707


getUsers

getUsers(request?): Promise<GetUsersResult>

Parameters

NameType
request?GetUsersRequest

Returns

Promise<GetUsersResult>

Defined in

chatkitty.ts:2549


getUsersCount

getUsersCount(request?): Promise<GetCountResult>

Parameters

NameType
request?GetUsersRequest

Returns

Promise<GetCountResult>

Defined in

chatkitty.ts:2576


hideChannel

hideChannel(request): Promise<HideChannelResult>

Parameters

NameType
requestHideChannelRequest

Returns

Promise<HideChannelResult>

Defined in

chatkitty.ts:1535


inviteUser

inviteUser(request): Promise<InviteUserResult>

Parameters

NameType
requestInviteUserRequest

Returns

Promise<InviteUserResult>

Defined in

chatkitty.ts:2627


joinChannel

joinChannel(request): Promise<JoinChannelResult>

Parameters

NameType
requestJoinChannelRequest

Returns

Promise<JoinChannelResult>

Defined in

chatkitty.ts:1318


leaveChannel

leaveChannel(request): Promise<LeaveChannelResult>

Parameters

NameType
requestLeaveChannelRequest

Returns

Promise<LeaveChannelResult>

Defined in

chatkitty.ts:1345


muteChannel

muteChannel(request): Promise<MuteChannelResult>

Parameters

NameType
requestMuteChannelRequest

Returns

Promise<MuteChannelResult>

Defined in

chatkitty.ts:1467


onChannelHidden

onChannelHidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:2408


onChannelJoined

onChannelJoined(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:2384


onChannelLeft

onChannelLeft(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:2456


onChannelUnhidden

onChannelUnhidden(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:2432


onChannelUpdated

onChannelUpdated(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:2480


onCurrentUserChanged

onCurrentUserChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:1069


onCurrentUserOffline

onCurrentUserOffline(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<CurrentUser> | () => void

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:1101


onCurrentUserOnline

onCurrentUserOnline(onNextOrObserver): ChatKittyUnsubscribe

Parameters

NameType
onNextOrObserverChatKittyObserver<CurrentUser> | () => void

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:1085


onNotificationReceived

onNotificationReceived(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:2358


onParticipantStartedTyping

onParticipantStartedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:2648


onParticipantStoppedTyping

onParticipantStoppedTyping(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:2672


onUserPresenceChanged

onUserPresenceChanged(onNextOrObserver): ChatKittyUnsubscribe

Parameters

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

Returns

ChatKittyUnsubscribe

Defined in

chatkitty.ts:2603


reactToMessage

reactToMessage(request): Promise<ReactToMessageResult>

Parameters

NameType
requestReactToMessageRequest

Returns

Promise<ReactToMessageResult>

Defined in

chatkitty.ts:2276


readChannel

readChannel(request): Promise<ReadChannelResult>

Parameters

NameType
requestReadChannelRequest

Returns

Promise<ReadChannelResult>

Defined in

chatkitty.ts:1450


readMessage

readMessage(request): Promise<ReadMessageResult>

Parameters

NameType
requestReadMessageRequest

Returns

Promise<ReadMessageResult>

Defined in

chatkitty.ts:2093


readThread

readThread(request): Promise<ReadThreadResult>

Parameters

NameType
requestReadThreadRequest

Returns

Promise<ReadThreadResult>

Defined in

chatkitty.ts:2259


removeReaction

removeReaction(request): Promise<RemoveReactionResult>

Parameters

NameType
requestRemoveReactionRequest

Returns

Promise<RemoveReactionResult>

Defined in

chatkitty.ts:2305


sendKeystrokes

sendKeystrokes(request): void

Parameters

NameType
requestSendKeystrokesRequest

Returns

void

Defined in

chatkitty.ts:2348


sendMessage

sendMessage(request): Promise<SendMessageResult>

Parameters

NameType
requestSendMessageRequest

Returns

Promise<SendMessageResult>

Defined in

chatkitty.ts:1882


startChatSession

startChatSession(request): StartChatSessionResult

Parameters

NameType
requestStartChatSessionRequest

Returns

StartChatSessionResult

Defined in

chatkitty.ts:1547


startSession

startSession(request): Promise<StartSessionResult>

Parameters

NameType
requestStartSessionRequest

Returns

Promise<StartSessionResult>

Defined in

chatkitty.ts:989


triggerEvent

triggerEvent(request): Promise<TriggerEventResult>

Parameters

NameType
requestTriggerEventRequest

Returns

Promise<TriggerEventResult>

Defined in

chatkitty.ts:2067


unmuteChannel

unmuteChannel(request): Promise<UnmuteChannelResult>

Parameters

NameType
requestUnmuteChannelRequest

Returns

Promise<UnmuteChannelResult>

Defined in

chatkitty.ts:1490


updateChannel

updateChannel(request): Promise<UpdateChannelResult>

Parameters

NameType
requestUpdateChannelRequest

Returns

Promise<UpdateChannelResult>

Defined in

chatkitty.ts:1199


updateCurrentUser

updateCurrentUser(update): Promise<UpdateCurrentUserResult>

Parameters

NameType
update(user: CurrentUser) => CurrentUser

Returns

Promise<UpdateCurrentUserResult>

Defined in

chatkitty.ts:1117


updateCurrentUserDisplayPicture

updateCurrentUserDisplayPicture(request): Promise<UpdateCurrentUserDisplayPictureResult>

Parameters

NameType
requestUpdateCurrentUserDisplayPictureRequest

Returns

Promise<UpdateCurrentUserDisplayPictureResult>

Defined in

chatkitty.ts:1142


getInstance

Static getInstance(apiKey): default

Parameters

NameType
apiKeystring

Returns

default

Defined in

chatkitty.ts:262