Skip to main content

modules

ChatKitty JS Core SDK / Exports

ChatKitty JS Core SDK

Table of contents​

References​

Enumerations​

Classes​

Interfaces​

Type Aliases​

Functions​

References​

default​

Renames and re-exports ChatKitty

Type Aliases​

AddChannelModeratorResult​

Ƭ AddChannelModeratorResult: AddedChannelModeratorResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:251

BaseFileMessage​

Ƭ BaseFileMessage: BaseMessage & { file: ChatKittyFile }

Defined in​

lib/message.ts:48

BaseTextMessage​

Ƭ BaseTextMessage: BaseMessage & { body: string ; links: MessageLink[] ; mentions?: MessageMention[] }

Defined in​

lib/message.ts:42

BaseUserMessage​

Ƭ BaseUserMessage: BaseMessage & { user: User }

Defined in​

lib/message.ts:52

BlockUserResult​

Ƭ BlockUserResult: BlockUserSucceededResult | ChatKittyFailedResult

Defined in​

lib/user.ts:84

Channel​

Ƭ Channel: DirectChannel | PublicChannel | PrivateChannel

Defined in​

lib/channel.ts:7

ChannelMessageMention​

Ƭ ChannelMessageMention: BaseMessageMention & { channel: Channel }

Defined in​

lib/message.ts:102

ChatKittyUnsubscribe​

Ƭ ChatKittyUnsubscribe: () => void

Type declaration​

▸ (): void

Returns​

void

Defined in​

lib/observer.ts:9

ChatKittyUserReference​

Ƭ ChatKittyUserReference: ChatKittyModelReference | { username: string }

Defined in​

lib/user.ts:31

CheckChannelUnreadResult​

Ƭ CheckChannelUnreadResult: CheckChannelUnreadSucceededResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:206

CheckUserIsChannelMemberResult​

Ƭ CheckUserIsChannelMemberResult: CheckUserIsChannelMemberSucceededResult | ChatKittyFailedResult

Defined in​

lib/user.ts:70

ClearChannelHistoryResult​

Ƭ ClearChannelHistoryResult: ClearChannelHistorySucceededResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:333

CountResult​

Ƭ CountResult: CountSucceededResult | ChatKittyFailedResult

Defined in​

lib/result.ts:15

CountUnreadChannelsRequest​

Ƭ CountUnreadChannelsRequest: ListUnreadChannelsRequest

Defined in​

lib/channel.ts:160

CreateChannelRequest​

Ƭ CreateChannelRequest: CreateDirectChannelRequest | CreatePublicChannelRequest | CreatePrivateChannelRequest

Defined in​

lib/channel.ts:109

CreateChannelResult​

Ƭ CreateChannelResult: CreatedChannelResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:107

CreateChatKittyFileProperties​

Ƭ CreateChatKittyFileProperties: CreateChatKittyExternalFileProperties | File | { name: string ; size: number ; type: string ; uri: string }

Defined in​

lib/file.ts:9

CreateDirectChannelRequest​

Ƭ CreateDirectChannelRequest: BaseCreateChannelRequest & { type: "DIRECT" }

Defined in​

lib/channel.ts:124

CreatePrivateChannelRequest​

Ƭ CreatePrivateChannelRequest: CreateGroupChannelRequest & { type: "PRIVATE" }

Defined in​

lib/channel.ts:132

CreatePublicChannelRequest​

Ƭ CreatePublicChannelRequest: CreateGroupChannelRequest & { type: "PUBLIC" }

Defined in​

lib/channel.ts:128

CreateThreadResult​

Ƭ CreateThreadResult: CreatedThreadResult | ChatKittyFailedResult

Defined in​

lib/thread.ts:50

CurrentUser​

Ƭ CurrentUser: BaseUser & { }

Defined in​

lib/current-user.ts:8

DeleteChannelResult​

Ƭ DeleteChannelResult: DeletedChannelResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:395

DeleteMessageResult​

Ƭ DeleteMessageResult: DeleteMessageSucceededResult | ChatKittyFailedResult

Defined in​

lib/message.ts:266

DeleteUserBlockedRecordResult​

Ƭ DeleteUserBlockedRecordResult: DeleteUserBlockedRecordSucceededResult | ChatKittyFailedResult

Defined in​

lib/user-blocked-record.ts:30

DirectChannel​

Ƭ DirectChannel: BaseChannel & { members: User[] ; type: "DIRECT" }

Defined in​

lib/channel.ts:30

EditMessageResult​

Ƭ EditMessageResult: EditedMessageSucceededResult | ChatKittyFailedResult

Defined in​

lib/message.ts:237

FileMessage​

Ƭ FileMessage: FileSystemMessage | FileUserMessage

Defined in​

lib/message.ts:22

FileSystemMessage​

Ƭ FileSystemMessage: BaseFileMessage & { type: "SYSTEM_FILE" }

Defined in​

lib/message.ts:60

FileUserMessage​

Ƭ FileUserMessage: BaseFileMessage & BaseUserMessage & { type: "FILE" }

Defined in​

lib/message.ts:69

HideChannelResult​

Ƭ HideChannelResult: HideChannelSucceededResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:347

InviteUserResult​

Ƭ InviteUserResult: InvitedUserResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:362

JoinChannelResult​

Ƭ JoinChannelResult: JoinedChannelResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:220

LeaveChannelResult​

Ƭ LeaveChannelResult: LeftChannelResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:298

ListChannelsResult​

Ƭ ListChannelsResult: ListChannelsSucceededResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:172

ListMessagesRequest​

Ƭ ListMessagesRequest: ListUsersMessagesRequest | ListChannelMessagesRequest | ListMessageRepliesRequest

Defined in​

lib/message.ts:152

ListMessagesResult​

Ƭ ListMessagesResult: ListMessagesSucceededResult | ChatKittyFailedResult

Defined in​

lib/message.ts:184

ListReactionsResult​

Ƭ ListReactionsResult: ListReactionsSucceededResult | ChatKittyFailedResult

Defined in​

lib/reaction.ts:44

ListReadReceiptsResult​

Ƭ ListReadReceiptsResult: ListReadReceiptsSucceededResult | ChatKittyFailedResult

Defined in​

lib/read-receipt.ts:21

ListThreadsRequest​

Ƭ ListThreadsRequest: ListChannelThreadsRequest

Defined in​

lib/thread.ts:58

ListThreadsResult​

Ƭ ListThreadsResult: ListThreadsSucceededResult | ChatKittyFailedResult

Defined in​

lib/thread.ts:70

ListUserBlockedRecordsResult​

Ƭ ListUserBlockedRecordsResult: ListUserBlockedRecordsSucceededResult | ChatKittyFailedResult

Defined in​

lib/user-blocked-record.ts:16

ListUsersResult​

Ƭ ListUsersResult: ListUsersSucceededResult | ChatKittyFailedResult

Defined in​

lib/user.ts:47

Message​

Ƭ Message: SystemMessage | UserMessage

Defined in​

lib/message.ts:14

MessageMention​

Ƭ MessageMention: ChannelMessageMention | UserMessageMention

Defined in​

lib/message.ts:93

MuteChannelResult​

Ƭ MuteChannelResult: MutedChannelResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:274

Notification​

Ƭ Notification: SystemSentMessageNotification | UserSentMessageNotification | UserRepliedToMessageNotification | UserMentionedNotification | UserMentionedChannelNotification

Defined in​

lib/notification.ts:5

PrivateChannel​

Ƭ PrivateChannel: GroupChannel & { type: "PRIVATE" }

Defined in​

lib/channel.ts:39

PublicChannel​

Ƭ PublicChannel: GroupChannel & { type: "PUBLIC" }

Defined in​

lib/channel.ts:35

ReactToMessageResult​

Ƭ ReactToMessageResult: ReactedToMessageResult | ChatKittyFailedResult

Defined in​

lib/reaction.ts:30

ReadChannelResult​

Ƭ ReadChannelResult: ReadChannelSucceededResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:319

ReadMessageResult​

Ƭ ReadMessageResult: ReadMessageSucceededResult | ChatKittyFailedResult

Defined in​

lib/message.ts:212

ReadThreadResult​

Ƭ ReadThreadResult: ReadThreadSucceededResult | ChatKittyFailedResult

Defined in​

lib/thread.ts:112

RemoveReactionResult​

Ƭ RemoveReactionResult: RemovedReactionResult | ChatKittyFailedResult

Defined in​

lib/reaction.ts:59

RetrieveChannelContextResult​

Ƭ RetrieveChannelContextResult: RetrieveChannelContextSucceededResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:192

RetrieveChannelResult​

Ƭ RetrieveChannelResult: RetrieveChannelSucceededResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:182

RetrieveCurrentUserResult​

Ƭ RetrieveCurrentUserResult: RetrieveCurrentUserSuccessfulResult | ChatKittyFailedResult

Defined in​

lib/current-user.ts:58

RetrieveLastReadMessageResult​

Ƭ RetrieveLastReadMessageResult: RetrieveLastReadMessageSucceededResult | ChatKittyFailedResult

Defined in​

lib/message.ts:194

RetrieveMessageChannelResult​

Ƭ RetrieveMessageChannelResult: RetrieveMessageChannelSucceededResult | ChatKittyFailedResult

Defined in​

lib/message.ts:357

RetrieveMessageParentResult​

Ƭ RetrieveMessageParentResult: RetrieveMessageParentSucceededResult | ChatKittyFailedResult

Defined in​

lib/message.ts:371

RetrieveThreadChannelResult​

Ƭ RetrieveThreadChannelResult: RetrieveThreadChannelSucceededResult | ChatKittyFailedResult

Defined in​

lib/thread.ts:84

RetrieveThreadMessageResult​

Ƭ RetrieveThreadMessageResult: RetrieveThreadMessageSucceededResult | ChatKittyFailedResult

Defined in​

lib/thread.ts:98

RetrieveUserResult​

Ƭ RetrieveUserResult: ListUserSucceededResult | ChatKittyFailedResult

Defined in​

lib/user.ts:55

SendChannelMessageRequest​

Ƭ SendChannelMessageRequest: Object

Type declaration​

NameType
channelChannel

Defined in​

lib/message.ts:280

SendFileMessageRequest​

Ƭ SendFileMessageRequest: SendChannelMessageRequest | SendMessageReplyRequest | SendThreadMessageRequest & { file: CreateChatKittyFileProperties ; groupTag?: string ; progressListener?: ChatKittyUploadProgressListener ; properties?: unknown }

Defined in​

lib/message.ts:302

SendKeystrokesRequest​

Ƭ SendKeystrokesRequest: SendChannelKeystrokesRequest | SendThreadKeystrokesRequest

Defined in​

lib/keystrokes.ts:16

SendMessageReplyRequest​

Ƭ SendMessageReplyRequest: Object

Type declaration​

NameType
messageMessage

Defined in​

lib/message.ts:284

SendMessageRequest​

Ƭ SendMessageRequest: SendTextMessageRequest | SendFileMessageRequest

Defined in​

lib/message.ts:276

SendMessageResult​

Ƭ SendMessageResult: SentMessageResult | ChatKittyFailedResult

Defined in​

lib/message.ts:313

SendTextMessageRequest​

Ƭ SendTextMessageRequest: SendChannelMessageRequest | SendMessageReplyRequest | SendThreadMessageRequest & { body: string ; groupTag?: string ; properties?: unknown }

Defined in​

lib/message.ts:292

SendThreadMessageRequest​

Ƭ SendThreadMessageRequest: Object

Type declaration​

NameType
threadThread

Defined in​

lib/message.ts:288

SentMessageResult​

Ƭ SentMessageResult: SentTextMessageResult | SentFileMessageResult

Defined in​

lib/message.ts:315

StartChatSessionResult​

Ƭ StartChatSessionResult: StartedChatSessionResult

Defined in​

lib/chat-session.ts:20

StartSessionResult​

Ƭ StartSessionResult: StartedSessionResult | ChatKittyFailedResult

Defined in​

lib/user-session.ts:9

SystemMessage​

Ƭ SystemMessage: TextSystemMessage | FileSystemMessage

Defined in​

lib/message.ts:16

SystemSentMessageNotification​

Ƭ SystemSentMessageNotification: BaseNotification & { data: SystemSentMessageNotificationData }

Defined in​

lib/notification.ts:23

TextMessage​

Ƭ TextMessage: TextSystemMessage | TextUserMessage

Defined in​

lib/message.ts:20

TextSystemMessage​

Ƭ TextSystemMessage: BaseTextMessage & { type: "SYSTEM_TEXT" }

Defined in​

lib/message.ts:56

TextUserMessage​

Ƭ TextUserMessage: BaseTextMessage & BaseUserMessage & { type: "TEXT" }

Defined in​

lib/message.ts:64

TriggerEventResult​

Ƭ TriggerEventResult: TriggeredEventResult | ChatKittyFailedResult

Defined in​

lib/event.ts:23

UnmuteChannelResult​

Ƭ UnmuteChannelResult: UnmutedChannelResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:286

UnreadMessageResult​

Ƭ UnreadMessageResult: UnreadMessageSucceededResult | ChatKittyFailedResult

Defined in​

lib/message.ts:222

UpdateChannelResult​

Ƭ UpdateChannelResult: UpdatedChannelResult | ChatKittyFailedResult

Defined in​

lib/channel.ts:383

UpdateCurrentUserDisplayPictureResult​

Ƭ UpdateCurrentUserDisplayPictureResult: UpdatedCurrentUserDisplayPictureResult | ChatKittyFailedResult

Defined in​

lib/current-user.ts:83

UpdateCurrentUserResult​

Ƭ UpdateCurrentUserResult: UpdatedCurrentUserResult | ChatKittyFailedResult

Defined in​

lib/current-user.ts:68

UpdateMessagePropertiesResult​

Ƭ UpdateMessagePropertiesResult: UpdatedMessagePropertiesSucceededResult | ChatKittyFailedResult

Defined in​

lib/message.ts:252

User​

Ƭ User: BaseUser & { }

Defined in​

lib/user.ts:21

UserMentionedChannelNotification​

Ƭ UserMentionedChannelNotification: BaseNotification & { data: UserMentionedChannelNotificationData }

Defined in​

lib/notification.ts:39

UserMentionedNotification​

Ƭ UserMentionedNotification: BaseNotification & { data: UserMentionedNotificationData }

Defined in​

lib/notification.ts:35

UserMessage​

Ƭ UserMessage: TextUserMessage | FileUserMessage

Defined in​

lib/message.ts:18

UserMessageMention​

Ƭ UserMessageMention: BaseMessageMention & { user: User }

Defined in​

lib/message.ts:106

UserRepliedToMessageNotification​

Ƭ UserRepliedToMessageNotification: BaseNotification & { data: UserRepliedToMessageNotificationData }

Defined in​

lib/notification.ts:31

UserSentMessageNotification​

Ƭ UserSentMessageNotification: BaseNotification & { data: UserSentMessageNotificationData }

Defined in​

lib/notification.ts:27

Functions​

isDirectChannel​

▸ isDirectChannel(channel): channel is DirectChannel

Parameters​

NameType
channelChannel

Returns​

channel is DirectChannel

Defined in​

lib/channel.ts:95

isFileMessage​

▸ isFileMessage(message): message is FileMessage

Parameters​

NameType
messageMessage

Returns​

message is FileMessage

Defined in​

lib/message.ts:140

isPrivateChannel​

▸ isPrivateChannel(channel): channel is PrivateChannel

Parameters​

NameType
channelChannel

Returns​

channel is PrivateChannel

Defined in​

lib/channel.ts:103

isPublicChannel​

▸ isPublicChannel(channel): channel is PublicChannel

Parameters​

NameType
channelChannel

Returns​

channel is PublicChannel

Defined in​

lib/channel.ts:99

isSystemMessage​

▸ isSystemMessage(message): message is SystemMessage

Parameters​

NameType
messageMessage

Returns​

message is SystemMessage

Defined in​

lib/message.ts:148

isSystemSentMessageNotification​

▸ isSystemSentMessageNotification(notification): notification is SystemSentMessageNotification

Parameters​

NameType
notificationNotification

Returns​

notification is SystemSentMessageNotification

Defined in​

lib/notification.ts:69

isTextMessage​

▸ isTextMessage(message): message is TextMessage

Parameters​

NameType
messageMessage

Returns​

message is TextMessage

Defined in​

lib/message.ts:136

isUserMentionedChannelNotification​

▸ isUserMentionedChannelNotification(notification): notification is UserMentionedChannelNotification

Parameters​

NameType
notificationNotification

Returns​

notification is UserMentionedChannelNotification

Defined in​

lib/notification.ts:93

isUserMentionedNotification​

▸ isUserMentionedNotification(notification): notification is UserMentionedNotification

Parameters​

NameType
notificationNotification

Returns​

notification is UserMentionedNotification

Defined in​

lib/notification.ts:87

isUserMessage​

▸ isUserMessage(message): message is UserMessage

Parameters​

NameType
messageMessage

Returns​

message is UserMessage

Defined in​

lib/message.ts:144

isUserRepliedToMessageNotification​

▸ isUserRepliedToMessageNotification(notification): notification is UserRepliedToMessageNotification

Parameters​

NameType
notificationNotification

Returns​

notification is UserRepliedToMessageNotification

Defined in​

lib/notification.ts:81

isUserSentMessageNotification​

▸ isUserSentMessageNotification(notification): notification is UserSentMessageNotification

Parameters​

NameType
notificationNotification

Returns​

notification is UserSentMessageNotification

Defined in​

lib/notification.ts:75

sentFileMessage​

▸ sentFileMessage(result): result is SentFileMessageResult

Parameters​

NameType
resultSentMessageResult

Returns​

result is SentFileMessageResult

Defined in​

lib/message.ts:337

sentTextMessage​

▸ sentTextMessage(result): result is SentTextMessageResult

Parameters​

NameType
resultSentMessageResult

Returns​

result is SentTextMessageResult

Defined in​

lib/message.ts:329