stream-chat-android-state/io.getstream.chat.android.state.plugin.internal/StatePlugin

StatePlugin

class StatePlugin : Plugin, QueryChannelsListener, QueryChannelListener, ThreadQueryListener, ChannelMarkReadListener, EditMessageListener, HideChannelListener, MarkAllReadListener, DeleteReactionListener, DeleteChannelListener, SendReactionListener, DeleteMessageListener, SendGiphyListener, ShuffleGiphyListener, SendMessageListener, TypingEventListener, SendAttachmentListener, FetchCurrentUserListener

Implementation of Plugin that brings support for the offline feature. This class work as a delegator of calls for one of its dependencies, so avoid to add logic here.

Parameters

logic

LogicRegistry

repositoryFacade

RepositoryFacade

clientState

ClientState

stateRegistry

StateRegistry

syncManager

SyncManager

eventHandler

EventHandler

globalState

GlobalState

Functions

getErrorHandler

open override fun getErrorHandler(): ErrorHandler

onUserDisconnected

open override fun onUserDisconnected()

onUserSet

open override fun onUserSet(user: User)

resolveDependency

open override fun <T : Any> resolveDependency(klass: KClass<T>): T?

Inherited functions

onAttachmentSendRequest

open suspend override fun onAttachmentSendRequest(channelType: String, channelId: String, message: Message)

onChannelMarkReadPrecondition

open suspend override fun onChannelMarkReadPrecondition(channelType: String, channelId: String): Result<Unit>

onCreateChannelPrecondition

open override fun onCreateChannelPrecondition(currentUser: User?, channelId: String, memberIds: List<String>): Result<Unit>

onCreateChannelRequest

open suspend override fun onCreateChannelRequest(channelType: String, channelId: String, memberIds: List<String>, extraData: Map<String, Any>, currentUser: User)

onCreateChannelResult

open suspend override fun onCreateChannelResult(channelType: String, channelId: String, memberIds: List<String>, result: Result<Channel>)

onDeleteChannelPrecondition

open suspend override fun onDeleteChannelPrecondition(currentUser: User?, channelType: String, channelId: String): Result<Unit>

onDeleteChannelRequest

open suspend override fun onDeleteChannelRequest(currentUser: User?, channelType: String, channelId: String)

onDeleteChannelResult

open suspend override fun onDeleteChannelResult(channelType: String, channelId: String, result: Result<Channel>)

onDeleteReactionPrecondition

open override fun onDeleteReactionPrecondition(currentUser: User?): Result<Unit>

onDeleteReactionRequest

open suspend override fun onDeleteReactionRequest(cid: String?, messageId: String, reactionType: String, currentUser: User)

onDeleteReactionResult

open suspend override fun onDeleteReactionResult(cid: String?, messageId: String, reactionType: String, currentUser: User, result: Result<Message>)

onFetchCurrentUserResult

open suspend override fun onFetchCurrentUserResult(result: Result<User>)

onGetMessageResult

open suspend override fun onGetMessageResult(messageId: String, result: Result<Message>)

onGetNewerRepliesRequest

open suspend override fun onGetNewerRepliesRequest(parentId: String, limit: Int, lastId: String?)

onGetNewerRepliesResult

open suspend override fun onGetNewerRepliesResult(result: Result<List<Message>>, parentId: String, limit: Int, lastId: String?)

onGetRepliesMoreRequest

open suspend override fun onGetRepliesMoreRequest(parentId: String, firstId: String, limit: Int)

onGetRepliesMoreResult

open suspend override fun onGetRepliesMoreResult(result: Result<List<Message>>, parentId: String, firstId: String, limit: Int)

onGetRepliesPrecondition

open suspend override fun onGetRepliesPrecondition(parentId: String): Result<Unit>

onGetRepliesRequest

open suspend override fun onGetRepliesRequest(parentId: String, limit: Int)

onGetRepliesResult

open suspend override fun onGetRepliesResult(result: Result<List<Message>>, parentId: String, limit: Int)

onGiphySendResult

open override fun onGiphySendResult(cid: String, result: Result<Message>)

onHideChannelPrecondition

open suspend override fun onHideChannelPrecondition(channelType: String, channelId: String, clearHistory: Boolean): Result<Unit>

onHideChannelRequest

open suspend override fun onHideChannelRequest(channelType: String, channelId: String, clearHistory: Boolean)

onHideChannelResult

open suspend override fun onHideChannelResult(result: Result<Unit>, channelType: String, channelId: String, clearHistory: Boolean)

onMarkAllReadRequest

open suspend override fun onMarkAllReadRequest()

onMessageDeletePrecondition

open suspend override fun onMessageDeletePrecondition(messageId: String): Result<Unit>

onMessageDeleteRequest

open suspend override fun onMessageDeleteRequest(messageId: String)

onMessageDeleteResult

open suspend override fun onMessageDeleteResult(originalMessageId: String, result: Result<Message>)

onMessageEditRequest

open suspend override fun onMessageEditRequest(message: Message)

onMessageEditResult

open suspend override fun onMessageEditResult(originalMessage: Message, result: Result<Message>)

onMessageSendResult

open suspend override fun onMessageSendResult(result: Result<Message>, channelType: String, channelId: String, message: Message)

onQueryChannelPrecondition

open suspend override fun onQueryChannelPrecondition(channelType: String, channelId: String, request: QueryChannelRequest): Result<Unit>

onQueryChannelRequest

open suspend override fun onQueryChannelRequest(channelType: String, channelId: String, request: QueryChannelRequest)

onQueryChannelResult

open suspend override fun onQueryChannelResult(result: Result<Channel>, channelType: String, channelId: String, request: QueryChannelRequest)

onQueryChannelsPrecondition

open suspend override fun onQueryChannelsPrecondition(request: QueryChannelsRequest): Result<Unit>

onQueryChannelsRequest

open suspend override fun onQueryChannelsRequest(request: QueryChannelsRequest)

onQueryChannelsResult

open suspend override fun onQueryChannelsResult(result: Result<List<Channel>>, request: QueryChannelsRequest)

onQueryMembersResult

open suspend override fun onQueryMembersResult(result: Result<List<Member>>, channelType: String, channelId: String, offset: Int, limit: Int, filter: FilterObject, sort: QuerySorter<Member>, members: List<Member>)

onSendReactionPrecondition

open suspend override fun onSendReactionPrecondition(currentUser: User?, reaction: Reaction): Result<Unit>

onSendReactionRequest

open suspend override fun onSendReactionRequest(cid: String?, reaction: Reaction, enforceUnique: Boolean, currentUser: User)

onSendReactionResult

open suspend override fun onSendReactionResult(cid: String?, reaction: Reaction, enforceUnique: Boolean, currentUser: User, result: Result<Reaction>)

onShuffleGiphyResult

open suspend override fun onShuffleGiphyResult(cid: String, result: Result<Message>)

onTypingEventPrecondition

open override fun onTypingEventPrecondition(eventType: String, channelType: String, channelId: String, extraData: Map<Any, Any>, eventTime: Date): Result<Unit>

onTypingEventRequest

open override fun onTypingEventRequest(eventType: String, channelType: String, channelId: String, extraData: Map<Any, Any>, eventTime: Date)

onTypingEventResult

open override fun onTypingEventResult(result: Result<ChatEvent>, eventType: String, channelType: String, channelId: String, extraData: Map<Any, Any>, eventTime: Date)