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:199


BaseFileMessage

Ƭ BaseFileMessage: BaseMessage & { file: ChatKittyFile }

Defined in

lib/message.ts:47


BaseTextMessage

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

Defined in

lib/message.ts:41


BaseUserMessage

Ƭ BaseUserMessage: BaseMessage & { user: User }

Defined in

lib/message.ts:51


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:91


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:154


CheckUserIsChannelMemberResult

Ƭ CheckUserIsChannelMemberResult: CheckUserIsChannelMemberSucceededResult | ChatKittyFailedResult

Defined in

lib/user.ts:70


ClearChannelHistoryResult

Ƭ ClearChannelHistoryResult: ClearChannelHistorySucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:281


CountResult

Ƭ CountResult: CountSucceededResult | ChatKittyFailedResult

Defined in

lib/result.ts:15


CountUnreadChannelsRequest

Ƭ CountUnreadChannelsRequest: ListUnreadChannelsRequest

Defined in

lib/channel.ts:124


CreateChannelResult

Ƭ CreateChannelResult: CreatedChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:91


CreateChatKittyFileProperties

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

Defined in

lib/file.ts:9


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:343


DeleteMessageResult

Ƭ DeleteMessageResult: DeleteMessageSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:214


DeleteUserBlockedRecordResult

Ƭ DeleteUserBlockedRecordResult: DeleteUserBlockedRecordSucceededResult | ChatKittyFailedResult

Defined in

lib/user-blocked-record.ts:30


DirectChannel

Ƭ DirectChannel: BaseChannel & { members: User[] }

Defined in

lib/channel.ts:26


EditMessageResult

Ƭ EditMessageResult: EditedMessageSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:200


FileMessage

Ƭ FileMessage: FileSystemMessage | FileUserMessage

Defined in

lib/message.ts:22


FileSystemMessage

Ƭ FileSystemMessage: BaseFileMessage

Defined in

lib/message.ts:57


FileUserMessage

Ƭ FileUserMessage: BaseFileMessage & BaseUserMessage

Defined in

lib/message.ts:61


HideChannelResult

Ƭ HideChannelResult: HideChannelSucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:295


InviteUserResult

Ƭ InviteUserResult: InvitedUserResult | ChatKittyFailedResult

Defined in

lib/channel.ts:310


JoinChannelResult

Ƭ JoinChannelResult: JoinedChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:168


LeaveChannelResult

Ƭ LeaveChannelResult: LeftChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:246


ListChannelsResult

Ƭ ListChannelsResult: ListChannelsSucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:130


ListMessagesRequest

Ƭ ListMessagesRequest: ListChannelMessagesRequest | ListMessageRepliesRequest

Defined in

lib/message.ts:139


ListMessagesResult

Ƭ ListMessagesResult: ListMessagesSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:161


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:82


MuteChannelResult

Ƭ MuteChannelResult: MutedChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:222


Notification

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

Defined in

lib/notification.ts:5


PrivateChannel

Ƭ PrivateChannel: BaseChannel

Defined in

lib/channel.ts:32


PublicChannel

Ƭ PublicChannel: BaseChannel

Defined in

lib/channel.ts:30


ReactToMessageResult

Ƭ ReactToMessageResult: ReactedToMessageResult | ChatKittyFailedResult

Defined in

lib/reaction.ts:30


ReadChannelResult

Ƭ ReadChannelResult: ReadChannelSucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:267


ReadMessageResult

Ƭ ReadMessageResult: ReadMessageSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:185


ReadThreadResult

Ƭ ReadThreadResult: ReadThreadSucceededResult | ChatKittyFailedResult

Defined in

lib/thread.ts:112


RemoveReactionResult

Ƭ RemoveReactionResult: RemovedReactionResult | ChatKittyFailedResult

Defined in

lib/reaction.ts:59


RetrieveChannelResult

Ƭ RetrieveChannelResult: RetrieveChannelSucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:140


RetrieveCurrentUserResult

Ƭ RetrieveCurrentUserResult: RetrieveCurrentUserSuccessfulResult | ChatKittyFailedResult

Defined in

lib/current-user.ts:57


RetrieveLastReadMessageResult

Ƭ RetrieveLastReadMessageResult: RetrieveLastReadMessageSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:171


RetrieveMessageChannelResult

Ƭ RetrieveMessageChannelResult: RetrieveMessageChannelSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:305


RetrieveMessageParentResult

Ƭ RetrieveMessageParentResult: RetrieveMessageParentSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:319


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:228


SendFileMessageRequest

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

Defined in

lib/message.ts:250


SendKeystrokesRequest

Ƭ SendKeystrokesRequest: SendChannelKeystrokesRequest | SendThreadKeystrokesRequest

Defined in

lib/keystrokes.ts:16


SendMessageReplyRequest

Ƭ SendMessageReplyRequest: Object

Type declaration

NameType
messageMessage

Defined in

lib/message.ts:232


SendMessageRequest

Ƭ SendMessageRequest: SendTextMessageRequest | SendFileMessageRequest

Defined in

lib/message.ts:224


SendMessageResult

Ƭ SendMessageResult: SentMessageResult | ChatKittyFailedResult

Defined in

lib/message.ts:261


SendTextMessageRequest

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

Defined in

lib/message.ts:240


SendThreadMessageRequest

Ƭ SendThreadMessageRequest: Object

Type declaration

NameType
threadThread

Defined in

lib/message.ts:236


SentMessageResult

Ƭ SentMessageResult: SentTextMessageResult | SentFileMessageResult

Defined in

lib/message.ts:263


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

Defined in

lib/message.ts:55


TextUserMessage

Ƭ TextUserMessage: BaseTextMessage & BaseUserMessage

Defined in

lib/message.ts:59


TriggerEventResult

Ƭ TriggerEventResult: TriggeredEventResult | ChatKittyFailedResult

Defined in

lib/event.ts:23


UnmuteChannelResult

Ƭ UnmuteChannelResult: UnmutedChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:234


UpdateChannelResult

Ƭ UpdateChannelResult: UpdatedChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:331


UpdateCurrentUserDisplayPictureResult

Ƭ UpdateCurrentUserDisplayPictureResult: UpdatedCurrentUserDisplayPictureResult | ChatKittyFailedResult

Defined in

lib/current-user.ts:82


UpdateCurrentUserResult

Ƭ UpdateCurrentUserResult: UpdatedCurrentUserResult | ChatKittyFailedResult

Defined in

lib/current-user.ts:67


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:95


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:79


isFileMessage

isFileMessage(message): message is FileMessage

Parameters

NameType
messageMessage

Returns

message is FileMessage

Defined in

lib/message.ts:127


isPrivateChannel

isPrivateChannel(channel): channel is BaseChannel

Parameters

NameType
channelChannel

Returns

channel is BaseChannel

Defined in

lib/channel.ts:87


isPublicChannel

isPublicChannel(channel): channel is BaseChannel

Parameters

NameType
channelChannel

Returns

channel is BaseChannel

Defined in

lib/channel.ts:83


isSystemMessage

isSystemMessage(message): message is SystemMessage

Parameters

NameType
messageMessage

Returns

message is SystemMessage

Defined in

lib/message.ts:135


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:123


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:131


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:285


sentTextMessage

sentTextMessage(result): result is SentTextMessageResult

Parameters

NameType
resultSentMessageResult

Returns

result is SentTextMessageResult

Defined in

lib/message.ts:277