Skip to main content

modules

ChatKitty JS SDK / Exports

ChatKitty JS SDK

Table of contents

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

AddChannelModeratorResult

Ƭ AddChannelModeratorResult: ChatKittyResult<AddedChannelModeratorResult> | AddedChannelModeratorResult | ChatKittyFailedResult

Defined in

lib/channel.ts:202


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: ChatKittyResult<BlockUserSucceededResult> | BlockUserSucceededResult | ChatKittyFailedResult

Defined in

lib/user.ts:92


Channel

Ƭ Channel: DirectChannel | PublicChannel | PrivateChannel

Defined in

lib/channel.ts:11


ChannelMessageMention

Ƭ ChannelMessageMention: BaseMessageMention & { channel: Channel }

Defined in

lib/message.ts:92


ChatKittyUnsubscribe

Ƭ ChatKittyUnsubscribe: () => void

Type declaration

▸ (): void

Returns

void

Defined in

lib/observer.ts:9


ChatKittyUserReference

Ƭ ChatKittyUserReference: ChatKittyModelReference | { username: string }

Defined in

lib/user.ts:34


ClearChannelHistoryResult

Ƭ ClearChannelHistoryResult: ChatKittyResult<ClearChannelHistorySucceededResult> | ClearChannelHistorySucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:295


CreateChannelResult

Ƭ CreateChannelResult: ChatKittyResult<CreatedChannelResult> | 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: ChatKittyResult<CreatedThreadResult> | CreatedThreadResult | ChatKittyFailedResult

Defined in

lib/thread.ts:50


CurrentUser

Ƭ CurrentUser: BaseUser & { _actions: CurrentUserActions ; _relays: CurrentUserRelays ; _streams: CurrentUserStreams ; _topics: CurrentUserTopics }

Defined in

lib/current-user.ts:12


DeleteChannelResult

Ƭ DeleteChannelResult: ChatKittyResult<DeletedChannelResult> | DeletedChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:365


DeleteMessageForMeResult

Ƭ DeleteMessageForMeResult: ChatKittyResult<DeleteMessageForMeSucceededResult> | DeleteMessageForMeSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:214


DeleteMessageResult

Ƭ DeleteMessageResult: ChatKittyResult<DeleteMessageSucceededResult> | DeleteMessageSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:229


DeleteUserBlockListItemResult

Ƭ DeleteUserBlockListItemResult: ChatKittyResult<DeleteUserBlockListItemSucceededResult> | DeleteUserBlockListItemSucceededResult | ChatKittyFailedResult

Defined in

lib/user-block-list-item.ts:34


DirectChannel

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

Defined in

lib/channel.ts:26


EditMessageResult

Ƭ EditMessageResult: ChatKittyResult<EditedMessageSucceededResult> | EditedMessageSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:199


FileMessage

Ƭ FileMessage: FileSystemMessage | FileUserMessage

Defined in

lib/message.ts:26


FileSystemMessage

Ƭ FileSystemMessage: BaseFileMessage

Defined in

lib/message.ts:58


FileUserMessage

Ƭ FileUserMessage: BaseFileMessage & BaseUserMessage

Defined in

lib/message.ts:62


GetChannelResult

Ƭ GetChannelResult: ChatKittyResult<GetChannelSucceededResult> | GetChannelSucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:142


GetChannelUnreadResult

Ƭ GetChannelUnreadResult: ChatKittyResult<GetChannelUnreadSucceededResult> | GetChannelUnreadSucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:153


GetChannelsResult

Ƭ GetChannelsResult: ChatKittyResult<GetChannelsSucceededResult> | GetChannelsSucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:131


GetCountResult

Ƭ GetCountResult: ChatKittyResult<GetCountSucceedResult> | GetCountSucceedResult | ChatKittyFailedResult

Defined in

lib/result.ts:30


GetCurrentUserResult

Ƭ GetCurrentUserResult: ChatKittyResult<GetCurrentUserSuccessfulResult> | GetCurrentUserSuccessfulResult | ChatKittyFailedResult

Defined in

lib/current-user.ts:57


GetMessageChannelResult

Ƭ GetMessageChannelResult: ChatKittyResult<GetMessageChannelSucceededResult> | GetMessageChannelSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:327


GetMessageParentResult

Ƭ GetMessageParentResult: ChatKittyResult<GetMessageParentSucceededResult> | GetMessageParentSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:342


GetMessagesRequest

Ƭ GetMessagesRequest: GetChannelMessagesRequest | GetMessageRepliesRequest

Defined in

lib/message.ts:140


GetMessagesResult

Ƭ GetMessagesResult: ChatKittyResult<GetMessagesSucceededResult> | GetMessagesSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:162


GetReactionsResult

Ƭ GetReactionsResult: ChatKittyResult<GetReactionsSucceededResult> | GetReactionsSucceededResult | ChatKittyFailedResult

Defined in

lib/reaction.ts:48


GetReadReceiptsResult

Ƭ GetReadReceiptsResult: ChatKittyResult<GetReadReceiptsSucceededResult> | GetReadReceiptsSucceededResult | ChatKittyFailedResult

Defined in

lib/read-receipt.ts:24


GetThreadChannelResult

Ƭ GetThreadChannelResult: ChatKittyResult<GetThreadChannelSucceededResult> | GetThreadChannelSucceededResult | ChatKittyFailedResult

Defined in

lib/thread.ts:89


GetThreadMessageResult

Ƭ GetThreadMessageResult: ChatKittyResult<GetThreadMessageSucceededResult> | GetThreadMessageSucceededResult | ChatKittyFailedResult

Defined in

lib/thread.ts:104


GetThreadsRequest

Ƭ GetThreadsRequest: GetChannelThreadsRequest

Defined in

lib/thread.ts:61


GetThreadsResult

Ƭ GetThreadsResult: ChatKittyResult<GetThreadsSucceededResult> | GetThreadsSucceededResult | ChatKittyFailedResult

Defined in

lib/thread.ts:74


GetUserBlockListResult

Ƭ GetUserBlockListResult: ChatKittyResult<GetUserBlockListSucceededResult> | GetUserBlockListSucceededResult | ChatKittyFailedResult

Defined in

lib/user-block-list-item.ts:19


GetUserIsChannelMemberResult

Ƭ GetUserIsChannelMemberResult: ChatKittyResult<GetUserIsChannelMemberSucceededResult> | GetUserIsChannelMemberSucceededResult | ChatKittyFailedResult

Defined in

lib/user.ts:77


GetUserResult

Ƭ GetUserResult: ChatKittyResult<GetUserSucceededResult> | GetUserSucceededResult | ChatKittyFailedResult

Defined in

lib/user.ts:61


GetUsersResult

Ƭ GetUsersResult: ChatKittyResult<GetUsersSucceededResult> | GetUsersSucceededResult | ChatKittyFailedResult

Defined in

lib/user.ts:50


HideChannelResult

Ƭ HideChannelResult: ChatKittyResult<HideChannelSucceededResult> | HideChannelSucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:310


InviteUserResult

Ƭ InviteUserResult: ChatKittyResult<InvitedUserResult> | InvitedUserResult | ChatKittyFailedResult

Defined in

lib/channel.ts:326


JoinChannelResult

Ƭ JoinChannelResult: ChatKittyResult<JoinedChannelResult> | JoinedChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:168


LeaveChannelResult

Ƭ LeaveChannelResult: ChatKittyResult<LeftChannelResult> | LeftChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:256


Message

Ƭ Message: SystemMessage | UserMessage

Defined in

lib/message.ts:18


MessageMention

Ƭ MessageMention: ChannelMessageMention | UserMessageMention

Defined in

lib/message.ts:83


MuteChannelResult

Ƭ MuteChannelResult: ChatKittyResult<MutedChannelResult> | MutedChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:226


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: ChatKittyResult<ReactedToMessageResult> | ReactedToMessageResult | ChatKittyFailedResult

Defined in

lib/reaction.ts:33


ReadChannelResult

Ƭ ReadChannelResult: ChatKittyResult<ReadChannelSucceededResult> | ReadChannelSucceededResult | ChatKittyFailedResult

Defined in

lib/channel.ts:280


ReadMessageResult

Ƭ ReadMessageResult: ChatKittyResult<ReadMessageSucceededResult> | ReadMessageSucceededResult | ChatKittyFailedResult

Defined in

lib/message.ts:183


ReadThreadResult

Ƭ ReadThreadResult: ChatKittyResult<ReadThreadSucceededResult> | ReadThreadSucceededResult | ChatKittyFailedResult

Defined in

lib/thread.ts:119


RemoveReactionResult

Ƭ RemoveReactionResult: ChatKittyResult<RemovedReactionResult> | RemovedReactionResult | ChatKittyFailedResult

Defined in

lib/reaction.ts:64


SendChannelMessageRequest

Ƭ SendChannelMessageRequest: Object

Type declaration

NameType
channelChannel

Defined in

lib/message.ts:244


SendFileMessageRequest

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

Defined in

lib/message.ts:266


SendKeystrokesRequest

Ƭ SendKeystrokesRequest: SendChannelKeystrokesRequest | SendThreadKeystrokesRequest

Defined in

lib/keystrokes.ts:15


SendMessageReplyRequest

Ƭ SendMessageReplyRequest: Object

Type declaration

NameType
messageMessage

Defined in

lib/message.ts:248


SendMessageRequest

Ƭ SendMessageRequest: SendTextMessageRequest | SendFileMessageRequest

Defined in

lib/message.ts:240


SendMessageResult

Ƭ SendMessageResult: ChatKittyResult<SentMessageResult> | SentMessageResult | ChatKittyFailedResult

Defined in

lib/message.ts:277


SendTextMessageRequest

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

Defined in

lib/message.ts:256


SendThreadMessageRequest

Ƭ SendThreadMessageRequest: Object

Type declaration

NameType
threadThread

Defined in

lib/message.ts:252


SentMessageResult

Ƭ SentMessageResult: ChatKittyResult<SentTextMessageResult> | SentTextMessageResult | SentFileMessageResult

Defined in

lib/message.ts:282


StartChatSessionResult

Ƭ StartChatSessionResult: ChatKittyResult<StartedChatSessionResult> | StartedChatSessionResult

Defined in

lib/chat-session.ts:20


StartSessionResult

Ƭ StartSessionResult: ChatKittyResult<StartedSessionResult> | StartedSessionResult | ChatKittyFailedResult

Defined in

lib/user-session.ts:13


SystemMessage

Ƭ SystemMessage: TextSystemMessage | FileSystemMessage

Defined in

lib/message.ts:20


SystemSentMessageNotification

Ƭ SystemSentMessageNotification: BaseNotification & { data: SystemSentMessageNotificationData }

Defined in

lib/notification.ts:23


TextMessage

Ƭ TextMessage: TextSystemMessage | TextUserMessage

Defined in

lib/message.ts:24


TextSystemMessage

Ƭ TextSystemMessage: BaseTextMessage

Defined in

lib/message.ts:56


TextUserMessage

Ƭ TextUserMessage: BaseTextMessage & BaseUserMessage

Defined in

lib/message.ts:60


UnmuteChannelResult

Ƭ UnmuteChannelResult: ChatKittyResult<UnmutedChannelResult> | UnmutedChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:241


UpdateChannelResult

Ƭ UpdateChannelResult: ChatKittyResult<UpdatedChannelResult> | UpdatedChannelResult | ChatKittyFailedResult

Defined in

lib/channel.ts:350


UpdateCurrentUserDisplayPictureResult

Ƭ UpdateCurrentUserDisplayPictureResult: ChatKittyResult<UpdatedCurrentUserDisplayPictureResult> | UpdatedCurrentUserDisplayPictureResult | ChatKittyFailedResult

Defined in

lib/current-user.ts:84


UpdateCurrentUserResult

Ƭ UpdateCurrentUserResult: ChatKittyResult<UpdatedCurrentUserResult> | UpdatedCurrentUserResult | ChatKittyFailedResult

Defined in

lib/current-user.ts:68


User

Ƭ User: BaseUser & { _relays: UserRelays }

Defined in

lib/user.ts:25


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


UserMessageMention

Ƭ UserMessageMention: BaseMessageMention & { user: User }

Defined in

lib/message.ts:96


UserRepliedToMessageNotification

Ƭ UserRepliedToMessageNotification: BaseNotification & { data: UserRepliedToMessageNotificationData }

Defined in

lib/notification.ts:31


UserSentMessageNotification

Ƭ UserSentMessageNotification: BaseNotification & { data: UserSentMessageNotificationData }

Defined in

lib/notification.ts:27

Functions

cancelled

cancelled<R>(result): result is R

Type parameters

NameType
Rextends ChatKittyCancelledResult<R>

Parameters

NameType
resultChatKittyResult<never>

Returns

result is R

Defined in

lib/result.ts:53


failed

failed<R>(result): result is R

Type parameters

NameType
Rextends ChatKittyFailedResult<R>

Parameters

NameType
resultChatKittyResult<never>

Returns

result is R

Defined in

lib/result.ts:47


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


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


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


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


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


sentTextMessage

sentTextMessage(result): result is SentTextMessageResult

Parameters

NameType
resultSentMessageResult

Returns

result is SentTextMessageResult

Defined in

lib/message.ts:299


succeeded

succeeded<R>(result): result is R

Type parameters

NameType
Rextends ChatKittySucceededResult<R>

Parameters

NameType
resultChatKittyResult<R>

Returns

result is R

Defined in

lib/result.ts:41