Interface ChatKitty

Hierarchy

ChatKitty

Implemented by

default

Index

Properties

Methods

Properties

Calls

Calls: Calls

Optional currentUser

currentUser?: CurrentUser

Methods

addChannelModerator

addChannelModerator(request: AddChannelModeratorRequest): Promise<AddChannelModeratorResult>

- Defined in lib/chatkitty.ts:2289
Parameters
- request: AddChannelModeratorRequest
Returns Promise<AddChannelModeratorResult>

blockUser

blockUser(request: BlockUserRequest): Promise<BlockUserResult>

- Defined in lib/chatkitty.ts:2441
Parameters
- request: BlockUserRequest
Returns Promise<BlockUserResult>

clearChannelHistory

clearChannelHistory(request: ClearChannelHistoryRequest): Promise<ClearChannelHistoryResult>

- Defined in lib/chatkitty.ts:2309
Parameters
- request: ClearChannelHistoryRequest
Returns Promise<ClearChannelHistoryResult>

createChannel

createChannel(request: CreateChannelRequest): Promise<CreateChannelResult>

- Defined in lib/chatkitty.ts:2275
Parameters
- request: CreateChannelRequest
Returns Promise<CreateChannelResult>

createThread

createThread(request: CreateThreadRequest): Promise<CreateThreadResult>

- Defined in lib/chatkitty.ts:2351
Parameters
- request: CreateThreadRequest
Returns Promise<CreateThreadResult>

deleteChannel

deleteChannel(request: DeleteChannelRequest): Promise<DeleteChannelResult>

- Defined in lib/chatkitty.ts:2271
Parameters
- request: DeleteChannelRequest
Returns Promise<DeleteChannelResult>

deleteMessage

deleteMessage(request: DeleteMessageRequest): Promise<DeleteMessageResult>

- Defined in lib/chatkitty.ts:2377
Parameters
- request: DeleteMessageRequest
Returns Promise<DeleteMessageResult>

deleteMessageForMe

deleteMessageForMe(request: DeleteMessageForMeRequest): Promise<DeleteMessageForMeResult>

- Defined in lib/chatkitty.ts:2373
Parameters
- request: DeleteMessageForMeRequest
Returns Promise<DeleteMessageForMeResult>

deleteUserBlockListItem

deleteUserBlockListItem(request: DeleteUserBlockListItemRequest): Promise<DeleteUserBlockListItemResult>

- Defined in lib/chatkitty.ts:2445
Parameters
- request: DeleteUserBlockListItemRequest
Returns Promise<DeleteUserBlockListItemResult>

editMessage

editMessage(request: EditMessageRequest): Promise<EditMessageResult>

- Defined in lib/chatkitty.ts:2337
Parameters
- request: EditMessageRequest
Returns Promise<EditMessageResult>

endSession

endSession(): Promise<void>

- Defined in lib/chatkitty.ts:2241
Returns Promise<void>

getChannel

getChannel(id: number): Promise<GetChannelResult>

- Defined in lib/chatkitty.ts:2281
Parameters
- id: number
Returns Promise<GetChannelResult>

getChannelMembers

getChannelMembers(request: GetChannelMembersRequest): Promise<GetUsersResult>

- Defined in lib/chatkitty.ts:2409
Parameters
- request: GetChannelMembersRequest
Returns Promise<GetUsersResult>

getChannelUnread

getChannelUnread(request: GetChannelUnreadRequest): Promise<GetChannelUnreadResult>

- Defined in lib/chatkitty.ts:2297
Parameters
- request: GetChannelUnreadRequest
Returns Promise<GetChannelUnreadResult>

getChannels

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

- Defined in lib/chatkitty.ts:2279
Parameters
- Optional request: GetChannelsRequest
Returns Promise<GetChannelsResult>

getCurrentUser

getCurrentUser(): Promise<GetCurrentUserResult>

- Defined in lib/chatkitty.ts:2243
Returns Promise<GetCurrentUserResult>

getLastReadMessage

getLastReadMessage(request: GetLastReadMessageRequest): Promise<GetLastReadMessageResult>

- Defined in lib/chatkitty.ts:2333
Parameters
- request: GetLastReadMessageRequest
Returns Promise<GetLastReadMessageResult>

getMessageChannel

getMessageChannel(request: GetMessageChannelRequest): Promise<GetMessageChannelResult>

- Defined in lib/chatkitty.ts:2343
Parameters
- request: GetMessageChannelRequest
Returns Promise<GetMessageChannelResult>

getMessageParent

getMessageParent(request: GetMessageParentRequest): Promise<GetMessageParentResult>

- Defined in lib/chatkitty.ts:2347
Parameters
- request: GetMessageParentRequest
Returns Promise<GetMessageParentResult>

getMessageRepliesCount

getMessageRepliesCount(request: GetMessageRepliesCountRequest): Promise<GetCountResult>

- Defined in lib/chatkitty.ts:2339
Parameters
- request: GetMessageRepliesCountRequest
Returns Promise<GetCountResult>

getMessages

getMessages(request: GetMessagesRequest): Promise<GetMessagesResult>

- Defined in lib/chatkitty.ts:2321
Parameters
- request: GetMessagesRequest
Returns Promise<GetMessagesResult>

getReactions

getReactions(request: GetReactionsRequest): Promise<GetReactionsResult>

- Defined in lib/chatkitty.ts:2365
Parameters
- request: GetReactionsRequest
Returns Promise<GetReactionsResult>

getReadReceipts

getReadReceipts(request: GetReadReceiptsRequest): Promise<GetReadReceiptsResult>

- Defined in lib/chatkitty.ts:2413
Parameters
- request: GetReadReceiptsRequest
Returns Promise<GetReadReceiptsResult>

getThreadChannel

getThreadChannel(request: GetThreadChannelRequest): Promise<GetThreadChannelResult>

- Defined in lib/chatkitty.ts:2355
Parameters
- request: GetThreadChannelRequest
Returns Promise<GetThreadChannelResult>

getThreadMessage

getThreadMessage(request: GetThreadMessageRequest): Promise<GetThreadMessageResult>

- Defined in lib/chatkitty.ts:2357
Parameters
- request: GetThreadMessageRequest
Returns Promise<GetThreadMessageResult>

getThreads

getThreads(request: GetChannelThreadsRequest): Promise<GetThreadsResult>

- Defined in lib/chatkitty.ts:2353
Parameters
- request: GetChannelThreadsRequest
Returns Promise<GetThreadsResult>

getUnreadChannelsCount

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

- Defined in lib/chatkitty.ts:2293
Parameters
- Optional request: GetUnreadChannelsRequest
Returns Promise<GetCountResult>

getUnreadMessagesCount

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

- Defined in lib/chatkitty.ts:2323
Parameters
- Optional request: GetUnreadMessagesCountRequest
Returns Promise<GetCountResult>

getUser

getUser(param: number): Promise<GetUserResult>

- Defined in lib/chatkitty.ts:2435
Parameters
- param: number
Returns Promise<GetUserResult>

getUserBlockList

getUserBlockList(): Promise<GetUserBlockListResult>

- Defined in lib/chatkitty.ts:2443
Returns Promise<GetUserBlockListResult>

getUserIsChannelMember

getUserIsChannelMember(request: GetUserIsChannelMemberRequest): Promise<GetUserIsChannelMemberResult>

- Defined in lib/chatkitty.ts:2437
Parameters
- request: GetUserIsChannelMemberRequest
Returns Promise<GetUserIsChannelMemberResult>

getUsers

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

- Defined in lib/chatkitty.ts:2417
Parameters
- Optional request: GetUsersRequest
Returns Promise<GetUsersResult>

getUsersCount

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

- Defined in lib/chatkitty.ts:2419
Parameters
- Optional request: GetUsersRequest
Returns Promise<GetCountResult>

hideChannel

hideChannel(request: HideChannelRequest): Promise<HideChannelResult>

- Defined in lib/chatkitty.ts:2313
Parameters
- request: HideChannelRequest
Returns Promise<HideChannelResult>

inviteUser

inviteUser(request: InviteUserRequest): Promise<InviteUserResult>

- Defined in lib/chatkitty.ts:2425
Parameters
- request: InviteUserRequest
Returns Promise<InviteUserResult>

joinChannel

joinChannel(request: JoinChannelRequest): Promise<JoinChannelResult>

- Defined in lib/chatkitty.ts:2283
Parameters
- request: JoinChannelRequest
Returns Promise<JoinChannelResult>

leaveChannel

leaveChannel(request: LeaveChannelRequest): Promise<LeaveChannelResult>

- Defined in lib/chatkitty.ts:2285
Parameters
- request: LeaveChannelRequest
Returns Promise<LeaveChannelResult>

muteChannel

muteChannel(request: MuteChannelRequest): Promise<MuteChannelResult>

- Defined in lib/chatkitty.ts:2303
Parameters
- request: MuteChannelRequest
Returns Promise<MuteChannelResult>

onChannelHidden

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

- Defined in lib/chatkitty.ts:2393
Parameters
- onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)
Returns ChatKittyUnsubscribe

onChannelJoined

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

- Defined in lib/chatkitty.ts:2389
Parameters
- onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)
Returns ChatKittyUnsubscribe

onChannelLeft

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

- Defined in lib/chatkitty.ts:2401
Parameters
- onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)
Returns ChatKittyUnsubscribe

onChannelUnhidden

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

- Defined in lib/chatkitty.ts:2397
Parameters
- onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)
Returns ChatKittyUnsubscribe

onChannelUpdated

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

- Defined in lib/chatkitty.ts:2405
Parameters
- onNextOrObserver: ChatKittyObserver<Channel> | ((channel: Channel) => void)
Returns ChatKittyUnsubscribe

onCurrentUserChanged

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

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

onCurrentUserOffline

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

- Defined in lib/chatkitty.ts:2255
Parameters
- onNextOrObserver: ChatKittyObserver<CurrentUser> | (() => void)
Returns ChatKittyUnsubscribe

onCurrentUserOnline

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

- Defined in lib/chatkitty.ts:2251
Parameters
- onNextOrObserver: ChatKittyObserver<CurrentUser> | (() => void)
Returns ChatKittyUnsubscribe

onNotificationReceived

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

- Defined in lib/chatkitty.ts:2383
Parameters
- onNextOrObserver: ChatKittyObserver<Notification> | ((notification: Notification) => void)
Returns ChatKittyUnsubscribe

onParticipantStartedTyping

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

- Defined in lib/chatkitty.ts:2427
Parameters
- onNextOrObserver: ChatKittyObserver<User> | ((participant: User) => void)
Returns ChatKittyUnsubscribe

onParticipantStoppedTyping

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

- Defined in lib/chatkitty.ts:2431
Parameters
- onNextOrObserver: ChatKittyObserver<User> | ((participant: User) => void)
Returns ChatKittyUnsubscribe

onUserPresenceChanged

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

- Defined in lib/chatkitty.ts:2421
Parameters
- onNextOrObserver: ChatKittyObserver<User> | ((user: User) => void)
Returns ChatKittyUnsubscribe

reactToMessage

reactToMessage(request: ReactToMessageRequest): Promise<ReactToMessageResult>

- Defined in lib/chatkitty.ts:2361
Parameters
- request: ReactToMessageRequest
Returns Promise<ReactToMessageResult>

readChannel

readChannel(request: ReadChannelRequest): Promise<ReadChannelResult>

- Defined in lib/chatkitty.ts:2301
Parameters
- request: ReadChannelRequest
Returns Promise<ReadChannelResult>

readMessage

readMessage(request: ReadMessageRequest): Promise<ReadMessageResult>

- Defined in lib/chatkitty.ts:2331
Parameters
- request: ReadMessageRequest
Returns Promise<ReadMessageResult>

readThread

readThread(request: ReadThreadRequest): Promise<ReadThreadResult>

- Defined in lib/chatkitty.ts:2359
Parameters
- request: ReadThreadRequest
Returns Promise<ReadThreadResult>

removeReaction

removeReaction(request: RemoveReactionRequest): Promise<RemoveReactionResult>

- Defined in lib/chatkitty.ts:2369
Parameters
- request: RemoveReactionRequest
Returns Promise<RemoveReactionResult>

sendKeystrokes

sendKeystrokes(request: SendKeystrokesRequest): void

- Defined in lib/chatkitty.ts:2381
Parameters
- request: SendKeystrokesRequest
Returns void

sendMessage

sendMessage(request: SendMessageRequest): Promise<SendMessageResult>

- Defined in lib/chatkitty.ts:2319
Parameters
- request: SendMessageRequest
Returns Promise<SendMessageResult>

startChatSession

startChatSession(request: StartChatSessionRequest): StartChatSessionResult

- Defined in lib/chatkitty.ts:2315
Parameters
- request: StartChatSessionRequest
Returns StartChatSessionResult

startSession

startSession(request: StartSessionRequest): Promise<StartSessionResult>

- Defined in lib/chatkitty.ts:2237
Parameters
- request: StartSessionRequest
Returns Promise<StartSessionResult>

triggerEvent

triggerEvent(request: TriggerEventRequest): Promise<TriggerEventResult>

- Defined in lib/chatkitty.ts:2327
Parameters
- request: TriggerEventRequest
Returns Promise<TriggerEventResult>

unmuteChannel

unmuteChannel(request: UnmuteChannelRequest): Promise<UnmuteChannelResult>

- Defined in lib/chatkitty.ts:2305
Parameters
- request: UnmuteChannelRequest
Returns Promise<UnmuteChannelResult>

updateChannel

updateChannel(request: UpdateChannelRequest): Promise<UpdateChannelResult>

- Defined in lib/chatkitty.ts:2267
Parameters
- request: UpdateChannelRequest
Returns Promise<UpdateChannelResult>

updateCurrentUser

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

- Defined in lib/chatkitty.ts:2259
Parameters
- update: (user: CurrentUser) => CurrentUser
  - - (user: CurrentUser): CurrentUser
    - Parameters
      - user: CurrentUser
      Returns CurrentUser
Returns Promise<UpdateCurrentUserResult>

updateCurrentUserDisplayPicture

updateCurrentUserDisplayPicture(request: UpdateCurrentUserDisplayPictureRequest): Promise<UpdateCurrentUserDisplayPictureResult>

- Defined in lib/chatkitty.ts:2263
Parameters
- request: UpdateCurrentUserDisplayPictureRequest
Returns Promise<UpdateCurrentUserDisplayPictureResult>

Generated using TypeDoc