Class default

Hierarchy

default

Implements

ChatKitty

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new default(configuration: ChatKittyConfiguration): default

- Defined in lib/chatkitty.ts:327
Parameters
- configuration: ChatKittyConfiguration
Returns default

Properties

Calls

Calls: Calls = ...

Optional currentUser

currentUser?: CurrentUser

Methods

addChannelModerator

addChannelModerator(request: AddChannelModeratorRequest): Promise<AddChannelModeratorResult>

Implementation of ChatKitty.addChannelModerator
- Defined in lib/chatkitty.ts:740
Parameters
- request: AddChannelModeratorRequest
Returns Promise<AddChannelModeratorResult>

blockUser

blockUser(request: BlockUserRequest): Promise<BlockUserResult>

Implementation of ChatKitty.blockUser
- Defined in lib/chatkitty.ts:2089
Parameters
- request: BlockUserRequest
Returns Promise<BlockUserResult>

clearChannelHistory

clearChannelHistory(request: ClearChannelHistoryRequest): Promise<ClearChannelHistoryResult>

Implementation of ChatKitty.clearChannelHistory
- Defined in lib/chatkitty.ts:881
Parameters
- request: ClearChannelHistoryRequest
Returns Promise<ClearChannelHistoryResult>

createChannel

createChannel(request: CreateChannelRequest): Promise<CreateChannelResult>

Implementation of ChatKitty.createChannel
- Defined in lib/chatkitty.ts:603
Parameters
- request: CreateChannelRequest
Returns Promise<CreateChannelResult>

createThread

createThread(request: CreateThreadRequest): Promise<CreateThreadResult>

Implementation of ChatKitty.createThread
- Defined in lib/chatkitty.ts:1552
Parameters
- request: CreateThreadRequest
Returns Promise<CreateThreadResult>

deleteChannel

deleteChannel(request: DeleteChannelRequest): Promise<DeleteChannelResult>

Implementation of ChatKitty.deleteChannel
- Defined in lib/chatkitty.ts:586
Parameters
- request: DeleteChannelRequest
Returns Promise<DeleteChannelResult>

deleteMessage

deleteMessage(request: DeleteMessageRequest): Promise<DeleteMessageResult>

Implementation of ChatKitty.deleteMessage
- Defined in lib/chatkitty.ts:1691
Parameters
- request: DeleteMessageRequest
Returns Promise<DeleteMessageResult>

deleteMessageForMe

deleteMessageForMe(request: DeleteMessageForMeRequest): Promise<DeleteMessageForMeResult>

Implementation of ChatKitty.deleteMessageForMe
- Defined in lib/chatkitty.ts:1677
Parameters
- request: DeleteMessageForMeRequest
Returns Promise<DeleteMessageForMeResult>

deleteUserBlockListItem

deleteUserBlockListItem(request: DeleteUserBlockListItemRequest): Promise<DeleteUserBlockListItemResult>

Implementation of ChatKitty.deleteUserBlockListItem
- Defined in lib/chatkitty.ts:2122
Parameters
- request: DeleteUserBlockListItemRequest
Returns Promise<DeleteUserBlockListItemResult>

editMessage

editMessage(request: EditMessageRequest): Promise<EditMessageResult>

Implementation of ChatKitty.editMessage
- Defined in lib/chatkitty.ts:1484
Parameters
- request: EditMessageRequest
Returns Promise<EditMessageResult>

endSession

endSession(): Promise<void>

Implementation of ChatKitty.endSession
- Defined in lib/chatkitty.ts:404
Returns Promise<void>

getChannel

getChannel(id: number): Promise<GetChannelResult>

Implementation of ChatKitty.getChannel
- Defined in lib/chatkitty.ts:670
Parameters
- id: number
Returns Promise<GetChannelResult>

getChannelMembers

getChannelMembers(request: GetChannelMembersRequest): Promise<GetUsersResult>

Implementation of ChatKitty.getChannelMembers
- Defined in lib/chatkitty.ts:1861
Parameters
- request: GetChannelMembersRequest
Returns Promise<GetUsersResult>

getChannelUnread

getChannelUnread(request: GetChannelUnreadRequest): Promise<GetChannelUnreadResult>

Implementation of ChatKitty.getChannelUnread
- Defined in lib/chatkitty.ts:794
Parameters
- request: GetChannelUnreadRequest
Returns Promise<GetChannelUnreadResult>

getChannels

getChannels(request?: GetChannelsRequest): Promise<GetChannelsResult>

Implementation of ChatKitty.getChannels
- Defined in lib/chatkitty.ts:627
Parameters
- Optional request: GetChannelsRequest
Returns Promise<GetChannelsResult>

getCurrentUser

getCurrentUser(): Promise<GetCurrentUserResult>

Implementation of ChatKitty.getCurrentUser
- Defined in lib/chatkitty.ts:420
Returns Promise<GetCurrentUserResult>

getLastReadMessage

getLastReadMessage(request: GetLastReadMessageRequest): Promise<GetLastReadMessageResult>

Implementation of ChatKitty.getLastReadMessage
- Defined in lib/chatkitty.ts:1465
Parameters
- request: GetLastReadMessageRequest
Returns Promise<GetLastReadMessageResult>

getMessageChannel

getMessageChannel(request: GetMessageChannelRequest): Promise<GetMessageChannelResult>

Implementation of ChatKitty.getMessageChannel
- Defined in lib/chatkitty.ts:1514
Parameters
- request: GetMessageChannelRequest
Returns Promise<GetMessageChannelResult>

getMessageParent

getMessageParent(request: GetMessageParentRequest): Promise<GetMessageParentResult>

Implementation of ChatKitty.getMessageParent
- Defined in lib/chatkitty.ts:1530
Parameters
- request: GetMessageParentRequest
Returns Promise<GetMessageParentResult>

getMessageRepliesCount

getMessageRepliesCount(request: GetMessageRepliesCountRequest): Promise<GetCountResult>

Implementation of ChatKitty.getMessageRepliesCount
- Defined in lib/chatkitty.ts:1498
Parameters
- request: GetMessageRepliesCountRequest
Returns Promise<GetCountResult>

getMessages

getMessages(request: GetMessagesRequest): Promise<GetMessagesResult>

Implementation of ChatKitty.getMessages
- Defined in lib/chatkitty.ts:1361
Parameters
- request: GetMessagesRequest
Returns Promise<GetMessagesResult>

getReactions

getReactions(request: GetReactionsRequest): Promise<GetReactionsResult>

Implementation of ChatKitty.getReactions
- Defined in lib/chatkitty.ts:1646
Parameters
- request: GetReactionsRequest
Returns Promise<GetReactionsResult>

getReadReceipts

getReadReceipts(request: GetReadReceiptsRequest): Promise<GetReadReceiptsResult>

Implementation of ChatKitty.getReadReceipts
- Defined in lib/chatkitty.ts:1884
Parameters
- request: GetReadReceiptsRequest
Returns Promise<GetReadReceiptsResult>

getThreadChannel

getThreadChannel(request: GetThreadChannelRequest): Promise<GetThreadChannelResult>

Implementation of ChatKitty.getThreadChannel
- Defined in lib/chatkitty.ts:1588
Parameters
- request: GetThreadChannelRequest
Returns Promise<GetThreadChannelResult>

getThreadMessage

getThreadMessage(request: GetThreadMessageRequest): Promise<GetThreadMessageResult>

Implementation of ChatKitty.getThreadMessage
- Defined in lib/chatkitty.ts:1602
Parameters
- request: GetThreadMessageRequest
Returns Promise<GetThreadMessageResult>

getThreads

getThreads(request: GetChannelThreadsRequest): Promise<GetThreadsResult>

Implementation of ChatKitty.getThreads
- Defined in lib/chatkitty.ts:1563
Parameters
- request: GetChannelThreadsRequest
Returns Promise<GetThreadsResult>

getUnreadChannelsCount

getUnreadChannelsCount(request?: GetUnreadChannelsRequest): Promise<GetCountResult>

Implementation of ChatKitty.getUnreadChannelsCount
- Defined in lib/chatkitty.ts:763
Parameters
- Optional request: GetUnreadChannelsRequest
Returns Promise<GetCountResult>

getUnreadMessagesCount

getUnreadMessagesCount(request?: GetUnreadMessagesCountRequest): Promise<GetCountResult>

Implementation of ChatKitty.getUnreadMessagesCount
- Defined in lib/chatkitty.ts:1397
Parameters
- Optional request: GetUnreadMessagesCountRequest
Returns Promise<GetCountResult>

getUser

getUser(param: number): Promise<GetUserResult>

Implementation of ChatKitty.getUser
- Defined in lib/chatkitty.ts:2053
Parameters
- param: number
Returns Promise<GetUserResult>

getUserBlockList

getUserBlockList(): Promise<GetUserBlockListResult>

Implementation of ChatKitty.getUserBlockList
- Defined in lib/chatkitty.ts:2102
Returns Promise<GetUserBlockListResult>

getUserIsChannelMember

getUserIsChannelMember(request: GetUserIsChannelMemberRequest): Promise<GetUserIsChannelMemberResult>

Implementation of ChatKitty.getUserIsChannelMember
- Defined in lib/chatkitty.ts:2064
Parameters
- request: GetUserIsChannelMemberRequest
Returns Promise<GetUserIsChannelMemberResult>

getUsers

getUsers(request?: GetUsersRequest): Promise<GetUsersResult>

Implementation of ChatKitty.getUsers
- Defined in lib/chatkitty.ts:1906
Parameters
- Optional request: GetUsersRequest
Returns Promise<GetUsersResult>

getUsersCount

getUsersCount(request?: GetUsersRequest): Promise<GetCountResult>

Implementation of ChatKitty.getUsersCount
- Defined in lib/chatkitty.ts:1933
Parameters
- Optional request: GetUsersRequest
Returns Promise<GetCountResult>

hideChannel

hideChannel(request: HideChannelRequest): Promise<HideChannelResult>

Implementation of ChatKitty.hideChannel
- Defined in lib/chatkitty.ts:901
Parameters
- request: HideChannelRequest
Returns Promise<HideChannelResult>

inviteUser

inviteUser(request: InviteUserRequest): Promise<InviteUserResult>

Implementation of ChatKitty.inviteUser
- Defined in lib/chatkitty.ts:1984
Parameters
- request: InviteUserRequest
Returns Promise<InviteUserResult>

joinChannel

joinChannel(request: JoinChannelRequest): Promise<JoinChannelResult>

Implementation of ChatKitty.joinChannel
- Defined in lib/chatkitty.ts:684
Parameters
- request: JoinChannelRequest
Returns Promise<JoinChannelResult>

leaveChannel

leaveChannel(request: LeaveChannelRequest): Promise<LeaveChannelResult>

Implementation of ChatKitty.leaveChannel
- Defined in lib/chatkitty.ts:711
Parameters
- request: LeaveChannelRequest
Returns Promise<LeaveChannelResult>

muteChannel

muteChannel(request: MuteChannelRequest): Promise<MuteChannelResult>

Implementation of ChatKitty.muteChannel
- Defined in lib/chatkitty.ts:833
Parameters
- request: MuteChannelRequest
Returns Promise<MuteChannelResult>

onChannelHidden

onChannelHidden(onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onChannelHidden
- Defined in lib/chatkitty.ts:1765
Parameters
- onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)
Returns ChatKittyUnsubscribe

onChannelJoined

onChannelJoined(onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onChannelJoined
- Defined in lib/chatkitty.ts:1741
Parameters
- onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)
Returns ChatKittyUnsubscribe

onChannelLeft

onChannelLeft(onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onChannelLeft
- Defined in lib/chatkitty.ts:1813
Parameters
- onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)
Returns ChatKittyUnsubscribe

onChannelUnhidden

onChannelUnhidden(onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onChannelUnhidden
- Defined in lib/chatkitty.ts:1789
Parameters
- onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)
Returns ChatKittyUnsubscribe

onChannelUpdated

onChannelUpdated(onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onChannelUpdated
- Defined in lib/chatkitty.ts:1837
Parameters
- onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)
Returns ChatKittyUnsubscribe

onCurrentUserChanged

onCurrentUserChanged(onNextOrObserver: ChatKittyObserver<null | CurrentUser> | ((user: null | CurrentUser) => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onCurrentUserChanged
- Defined in lib/chatkitty.ts:440
Parameters
- onNextOrObserver: ChatKittyObserver<null | CurrentUser> | ((user: null | CurrentUser) => void)
Returns ChatKittyUnsubscribe

onCurrentUserOffline

onCurrentUserOffline(onNextOrObserver: ChatKittyObserver<CurrentUser> | (() => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onCurrentUserOffline
- Defined in lib/chatkitty.ts:472
Parameters
- onNextOrObserver: ChatKittyObserver<CurrentUser> | (() => void)
Returns ChatKittyUnsubscribe

onCurrentUserOnline

onCurrentUserOnline(onNextOrObserver: ChatKittyObserver<CurrentUser> | (() => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onCurrentUserOnline
- Defined in lib/chatkitty.ts:456
Parameters
- onNextOrObserver: ChatKittyObserver<CurrentUser> | (() => void)
Returns ChatKittyUnsubscribe

onNotificationReceived

onNotificationReceived(onNextOrObserver: ChatKittyObserver<Notification> | ((notification: Notification) => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onNotificationReceived
- Defined in lib/chatkitty.ts:1715
Parameters
- onNextOrObserver: ChatKittyObserver<Notification> | ((notification: Notification) => void)
Returns ChatKittyUnsubscribe

onParticipantStartedTyping

onParticipantStartedTyping(onNextOrObserver: ChatKittyObserver<User> | ((participant: User) => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onParticipantStartedTyping
- Defined in lib/chatkitty.ts:2005
Parameters
- onNextOrObserver: ChatKittyObserver<User> | ((participant: User) => void)
Returns ChatKittyUnsubscribe

onParticipantStoppedTyping

onParticipantStoppedTyping(onNextOrObserver: ChatKittyObserver<User> | ((participant: User) => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onParticipantStoppedTyping
- Defined in lib/chatkitty.ts:2029
Parameters
- onNextOrObserver: ChatKittyObserver<User> | ((participant: User) => void)
Returns ChatKittyUnsubscribe

onUserPresenceChanged

onUserPresenceChanged(onNextOrObserver: ChatKittyObserver<User> | ((user: User) => void)): ChatKittyUnsubscribe

Implementation of ChatKitty.onUserPresenceChanged
- Defined in lib/chatkitty.ts:1960
Parameters
- onNextOrObserver: ChatKittyObserver<User> | ((user: User) => void)
Returns ChatKittyUnsubscribe

reactToMessage

reactToMessage(request: ReactToMessageRequest): Promise<ReactToMessageResult>

Implementation of ChatKitty.reactToMessage
- Defined in lib/chatkitty.ts:1633
Parameters
- request: ReactToMessageRequest
Returns Promise<ReactToMessageResult>

readChannel

readChannel(request: ReadChannelRequest): Promise<ReadChannelResult>

Implementation of ChatKitty.readChannel
- Defined in lib/chatkitty.ts:816
Parameters
- request: ReadChannelRequest
Returns Promise<ReadChannelResult>

readMessage

readMessage(request: ReadMessageRequest): Promise<ReadMessageResult>

Implementation of ChatKitty.readMessage
- Defined in lib/chatkitty.ts:1454
Parameters
- request: ReadMessageRequest
Returns Promise<ReadMessageResult>

readThread

readThread(request: ReadThreadRequest): Promise<ReadThreadResult>

Implementation of ChatKitty.readThread
- Defined in lib/chatkitty.ts:1616
Parameters
- request: ReadThreadRequest
Returns Promise<ReadThreadResult>

removeReaction

removeReaction(request: RemoveReactionRequest): Promise<RemoveReactionResult>

Implementation of ChatKitty.removeReaction
- Defined in lib/chatkitty.ts:1662
Parameters
- request: RemoveReactionRequest
Returns Promise<RemoveReactionResult>

sendKeystrokes

sendKeystrokes(request: SendKeystrokesRequest): void

Implementation of ChatKitty.sendKeystrokes
- Defined in lib/chatkitty.ts:1705
Parameters
- request: SendKeystrokesRequest
Returns void

sendMessage

sendMessage(request: SendMessageRequest): Promise<SendMessageResult>

Implementation of ChatKitty.sendMessage
- Defined in lib/chatkitty.ts:1243
Parameters
- request: SendMessageRequest
Returns Promise<SendMessageResult>

startChatSession

startChatSession(request: StartChatSessionRequest): StartChatSessionResult

Implementation of ChatKitty.startChatSession
- Defined in lib/chatkitty.ts:913
Parameters
- request: StartChatSessionRequest
Returns StartChatSessionResult

startSession

startSession(request: StartSessionRequest): Promise<StartSessionResult>

Implementation of ChatKitty.startSession
- Defined in lib/chatkitty.ts:360
Parameters
- request: StartSessionRequest
Returns Promise<StartSessionResult>

triggerEvent

triggerEvent(request: TriggerEventRequest): Promise<TriggerEventResult>

Implementation of ChatKitty.triggerEvent
- Defined in lib/chatkitty.ts:1428
Parameters
- request: TriggerEventRequest
Returns Promise<TriggerEventResult>

unmuteChannel

unmuteChannel(request: UnmuteChannelRequest): Promise<UnmuteChannelResult>

Implementation of ChatKitty.unmuteChannel
- Defined in lib/chatkitty.ts:856
Parameters
- request: UnmuteChannelRequest
Returns Promise<UnmuteChannelResult>

updateChannel

updateChannel(request: UpdateChannelRequest): Promise<UpdateChannelResult>

Implementation of ChatKitty.updateChannel
- Defined in lib/chatkitty.ts:569
Parameters
- request: UpdateChannelRequest
Returns Promise<UpdateChannelResult>

updateCurrentUser

updateCurrentUser(update: (user: CurrentUser) => CurrentUser): Promise<UpdateCurrentUserResult>

Implementation of ChatKitty.updateCurrentUser
- Defined in lib/chatkitty.ts:488
Parameters
- update: (user: CurrentUser) => CurrentUser
  - - (user: CurrentUser): CurrentUser
    - Parameters
      - user: CurrentUser
      Returns CurrentUser
Returns Promise<UpdateCurrentUserResult>

updateCurrentUserDisplayPicture

updateCurrentUserDisplayPicture(request: UpdateCurrentUserDisplayPictureRequest): Promise<UpdateCurrentUserDisplayPictureResult>

Implementation of ChatKitty.updateCurrentUserDisplayPicture
- Defined in lib/chatkitty.ts:513
Parameters
- request: UpdateCurrentUserDisplayPictureRequest
Returns Promise<UpdateCurrentUserDisplayPictureResult>

Static getInstance

getInstance(apiKey: string): ChatKitty

- Defined in lib/chatkitty.ts:214
Parameters
- apiKey: string
Returns ChatKitty

Generated using TypeDoc