library / io.getstream.chat.android.livedata.usecase / UseCaseHelper

UseCaseHelper

data class UseCaseHelper

Constructors

<init>

UseCaseHelper(chatDomainImpl: ChatDomainImpl)

Properties

chatDomainImpl

var chatDomainImpl: ChatDomainImpl

createChannel

Create a channel and retry using the retry policy if the request fails

var createChannel: CreateChannel

deleteMessage

Delete a message. This message is immediately marked as deleted (message.deletedAt) in local storage. The API call to delete the message is retried using the retry policy

var deleteMessage: DeleteMessage

deleteReaction

Delete a reaction. This reaction is immediately marked as deleted in local storage. The API call to delete a reaction is retried using the retry policy

var deleteReaction: DeleteReaction

editMessage

Edit a message. This message is immediately updated in local storage. The API call to edit the message is retried using the retry policy

var editMessage: EditMessage

getThread

Returns a ThreadController for the specified thread

val getThread: GetThread

getTotalUnreadCount

Returns a livedata object for the total number of unread messages

var getTotalUnreadCount: GetTotalUnreadCount

getUnreadChannelCount

Returns a livedata object for the number of channels with unread messages

var getUnreadChannelCount: GetUnreadChannelCount

hideChannel

hideChannel hides the channel till a new message event is received

var hideChannel: HideChannel

keystroke

Keystroke should be called whenever the user enters something in the message input It handles the deduplication and removal of typing events automatically

var keystroke: Keystroke

loadOlderMessages

Loads older messages for the given channel

var loadOlderMessages: LoadOlderMessages

markRead

markRead marks all messages on a channel read

var markRead: MarkRead

queryChannels

Query channels and start listening for changes using events Returns a QueryChannelsController object

var queryChannels: QueryChannels

queryChannelsLoadMore

Load more channels for the given query.

val queryChannelsLoadMore: QueryChannelsLoadMore

replayEventsForActiveChannels

Adds the provided channel to the active channels and replays events for all active channels

var replayEventsForActiveChannels: ReplayEventsForActiveChannels

sendMessage

Send a message. This message is immediately added to local storage. The API call to create the message is retried using the retry policy

var sendMessage: SendMessage

sendReaction

Send a reaction. This reaction is immediately added to local storage. The API call to send a reaction is retried using the retry policy

var sendReaction: SendReaction

showChannel

showChannels shows a channel which was previously hidden

var showChannel: ShowChannel

stopTyping

stopTyping is typically called manually when the message is submitted

var stopTyping: StopTyping

threadLoadMore

Loads more messages for a thread

var threadLoadMore: ThreadLoadMore

watchChannel

Watch a channel/ Start listening for events on a channel Returns a channel controller object

var watchChannel: WatchChannel