UseCaseHelper


public final class UseCaseHelper

Field Summary

Fields
Modifier and Type	Field	Description
`private final ReplayEventsForActiveChannels`	`replayEventsForActiveChannels`
`private final GetChannelController`	`getChannelController`
`private final WatchChannel`	`watchChannel`
`private final QueryChannels`	`queryChannels`
`private final GetThread`	`getThread`
`private final GetTotalUnreadCount`	`getTotalUnreadCount`
`private final GetUnreadChannelCount`	`getUnreadChannelCount`
`private final LoadOlderMessages`	`loadOlderMessages`
`private final LoadNewerMessages`	`loadNewerMessages`
`private final LoadMessageById`	`loadMessageById`
`private final QueryChannelsLoadMore`	`queryChannelsLoadMore`
`private final ThreadLoadMore`	`threadLoadMore`
`private final CreateChannel`	`createChannel`
`private final SendMessage`	`sendMessage`
`private final CancelMessage`	`cancelMessage`
`private final ShuffleGiphy`	`shuffleGiphy`
`private final SendGiphy`	`sendGiphy`
`private final SendMessageWithAttachments`	`sendMessageWithAttachments`
`private final EditMessage`	`editMessage`
`private final DeleteMessage`	`deleteMessage`
`private final SendReaction`	`sendReaction`
`private final DeleteReaction`	`deleteReaction`
`private final Keystroke`	`keystroke`
`private final StopTyping`	`stopTyping`
`private final MarkRead`	`markRead`
`private final MarkAllRead`	`markAllRead`
`private final HideChannel`	`hideChannel`
`private final ShowChannel`	`showChannel`
`private final LeaveChannel`	`leaveChannel`
`private final DeleteChannel`	`deleteChannel`
`private final SetMessageForReply`	`setMessageForReply`
`private final DownloadAttachment`	`downloadAttachment`
`private final SearchUsersByName`	`searchUsersByName`

Method Summary

Modifier and Type	Method	Description
`final ReplayEventsForActiveChannels`	`getReplayEventsForActiveChannels()`	Adds the provided channel to the active channels and replays events for all active channels
`final GetChannelController`	`getGetChannelController()`	Get channel controller for cid Returns a channel controller object
`final WatchChannel`	`getWatchChannel()`	Watch a channel/ Start listening for events on a channel Returns a channel controller object
`final QueryChannels`	`getQueryChannels()`	Query channels and start listening for changes using events Returns a QueryChannelsController object
`final GetThread`	`getGetThread()`	Returns a ThreadController for the specified thread
`final GetTotalUnreadCount`	`getGetTotalUnreadCount()`	Returns a livedata object for the total number of unread messages
`final GetUnreadChannelCount`	`getGetUnreadChannelCount()`	Returns a livedata object for the number of channels with unread messages
`final LoadOlderMessages`	`getLoadOlderMessages()`	Loads older messages for the given channel
`final LoadNewerMessages`	`getLoadNewerMessages()`	Loads newer messages for the given channel
`final LoadMessageById`	`getLoadMessageById()`	Loads a message for a given message id, optionally with a offset of newer and older messages.
`final QueryChannelsLoadMore`	`getQueryChannelsLoadMore()`	Load more channels for the given query.
`final ThreadLoadMore`	`getThreadLoadMore()`	Loads more messages for a thread
`final CreateChannel`	`getCreateChannel()`	Create a channel and retry using the retry policy if the request fails
`final SendMessage`	`getSendMessage()`	Send a message.
`final CancelMessage`	`getCancelMessage()`	Cancel an emphemeral message.
`final ShuffleGiphy`	`getShuffleGiphy()`	Performs giphy shuffle operation.
`final SendGiphy`	`getSendGiphy()`	Sends selected giphy message to the channel.
`final SendMessageWithAttachments`	`getSendMessageWithAttachments()`	Send a message with attachments.
`final EditMessage`	`getEditMessage()`	Edit a message.
`final DeleteMessage`	`getDeleteMessage()`	Delete a message.
`final SendReaction`	`getSendReaction()`	Send a reaction.
`final DeleteReaction`	`getDeleteReaction()`	Delete a reaction.
`final Keystroke`	`getKeystroke()`	Keystroke should be called whenever the user enters something in the message input public * It handles the deduplication and removal of typing events automatically
`final StopTyping`	`getStopTyping()`	stopTyping is typically called manually when the message is submitted
`final MarkRead`	`getMarkRead()`	markRead marks all messages on a channel read
`final MarkAllRead`	`getMarkAllRead()`	markAllRead marks all messages on a channel as read
`final HideChannel`	`getHideChannel()`	hideChannel hides the channel till a new message event is received
`final ShowChannel`	`getShowChannel()`	showChannels shows a channel which was previously hidden
`final LeaveChannel`	`getLeaveChannel()`	Leaves a channel and retry using the retry policy if the request fails
`final DeleteChannel`	`getDeleteChannel()`	Deletes a channel
`final SetMessageForReply`	`getSetMessageForReply()`
`final DownloadAttachment`	`getDownloadAttachment()`	Downloads selected attachment
`final SearchUsersByName`	`getSearchUsersByName()`	Performs user search request.

Methods inherited from class io.getstream.chat.android.livedata.usecase.UseCaseHelper
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getReplayEventsForActiveChannels
```
 final ReplayEventsForActiveChannels getReplayEventsForActiveChannels()
```
    Adds the provided channel to the active channels and replays events for all active channels
  - getGetChannelController
```
 final GetChannelController getGetChannelController()
```
    Get channel controller for cid Returns a channel controller object
  - getWatchChannel
```
 final WatchChannel getWatchChannel()
```
    Watch a channel/ Start listening for events on a channel Returns a channel controller object
  - getQueryChannels
```
 final QueryChannels getQueryChannels()
```
    Query channels and start listening for changes using events Returns a QueryChannelsController object
  - getGetThread
```
 final GetThread getGetThread()
```
    Returns a ThreadController for the specified thread
  - getGetTotalUnreadCount
```
 final GetTotalUnreadCount getGetTotalUnreadCount()
```
    Returns a livedata object for the total number of unread messages
  - getGetUnreadChannelCount
```
 final GetUnreadChannelCount getGetUnreadChannelCount()
```
    Returns a livedata object for the number of channels with unread messages
  - getLoadOlderMessages
```
 final LoadOlderMessages getLoadOlderMessages()
```
    Loads older messages for the given channel
  - getLoadNewerMessages
```
 final LoadNewerMessages getLoadNewerMessages()
```
    Loads newer messages for the given channel
  - getLoadMessageById
```
 final LoadMessageById getLoadMessageById()
```
    Loads a message for a given message id, optionally with a offset of newer and older messages.
  - getQueryChannelsLoadMore
```
 final QueryChannelsLoadMore getQueryChannelsLoadMore()
```
    Load more channels for the given query.
  - getThreadLoadMore
```
 final ThreadLoadMore getThreadLoadMore()
```
    Loads more messages for a thread
  - getCreateChannel
```
 final CreateChannel getCreateChannel()
```
    Create a channel and retry using the retry policy if the request fails
  - getSendMessage
```
 final SendMessage getSendMessage()
```
    Send a message. This message is immediately added to local storage. The API call to create the message is retried using the retry policy
  - getCancelMessage
```
 final CancelMessage getCancelMessage()
```
    Cancel an emphemeral message. This message is immediately removed from local storage. The API call to delete the message is retried using the retry policy
  - getShuffleGiphy
```
 final ShuffleGiphy getShuffleGiphy()
```
    Performs giphy shuffle operation. Removes the original "ephemeral" message from local storage. Returns new "ephemeral" message with new giphy url. API call to remove the message is retried according to the retry policy specified on the chatDomain
  - getSendGiphy
```
 final SendGiphy getSendGiphy()
```
    Sends selected giphy message to the channel. Replaces the original "ephemeral" message in local storage with the one received from backend. Returns new "ephemeral" message with new giphy url. API call to remove the message is retried according to the retry policy specified on the chatDomain
  - getSendMessageWithAttachments
```
 final SendMessageWithAttachments getSendMessageWithAttachments()
```
    Send a message with attachments.
  - getEditMessage
```
 final EditMessage getEditMessage()
```
    Edit a message. This message is immediately updated in local storage. The API call to edit the message is retried using the retry policy
  - getDeleteMessage
```
 final DeleteMessage getDeleteMessage()
```
    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
  - getSendReaction
```
 final SendReaction getSendReaction()
```
    Send a reaction. This reaction is immediately added to local storage. The API call to send a reaction is retried using the retry policy
  - getDeleteReaction
```
 final DeleteReaction getDeleteReaction()
```
    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
  - getKeystroke
```
 final Keystroke getKeystroke()
```
    Keystroke should be called whenever the user enters something in the message input public * It handles the deduplication and removal of typing events automatically
  - getStopTyping
```
 final StopTyping getStopTyping()
```
    stopTyping is typically called manually when the message is submitted
  - getMarkRead
```
 final MarkRead getMarkRead()
```
    markRead marks all messages on a channel read
  - getMarkAllRead
```
 final MarkAllRead getMarkAllRead()
```
    markAllRead marks all messages on a channel as read
  - getHideChannel
```
 final HideChannel getHideChannel()
```
    hideChannel hides the channel till a new message event is received
  - getShowChannel
```
 final ShowChannel getShowChannel()
```
    showChannels shows a channel which was previously hidden
  - getLeaveChannel
```
 final LeaveChannel getLeaveChannel()
```
    Leaves a channel and retry using the retry policy if the request fails
  - getDeleteChannel
```
 final DeleteChannel getDeleteChannel()
```
    Deletes a channel
  - getSetMessageForReply
```
 final SetMessageForReply getSetMessageForReply()
```
  - getDownloadAttachment
```
 final DownloadAttachment getDownloadAttachment()
```
    Downloads selected attachment
  - getSearchUsersByName
```
 final SearchUsersByName getSearchUsersByName()
```
    Performs user search request.

Class UseCaseHelper

Field Summary

Method Summary

Methods inherited from class io.getstream.chat.android.livedata.usecase.UseCaseHelper

Methods inherited from class java.lang.Object

Method Detail

getReplayEventsForActiveChannels

getGetChannelController

getWatchChannel

getQueryChannels

getGetThread

getGetTotalUnreadCount

getGetUnreadChannelCount

getLoadOlderMessages

getLoadNewerMessages

getLoadMessageById

getQueryChannelsLoadMore

getThreadLoadMore

getCreateChannel

getSendMessage

getCancelMessage

getShuffleGiphy

getSendGiphy

getSendMessageWithAttachments

getEditMessage

getDeleteMessage

getSendReaction

getDeleteReaction

getKeystroke

getStopTyping

getMarkRead

getMarkAllRead

getHideChannel

getShowChannel

getLeaveChannel

getDeleteChannel

getSetMessageForReply

getDownloadAttachment

getSearchUsersByName