-
- All Implemented Interfaces:
public interface QueryChannelsStateContains a state related to a single query channels request.
-
-
Method Summary
Modifier and Type Method Description abstract StateFlow<Boolean>getRecoveryNeeded()If the channels need to be synced. abstract FilterObjectgetFilter()The filter is associated with this query channels state. abstract QuerySorter<Channel>getSort()The sort object which requested for this query channels state. abstract StateFlow<QueryChannelsRequest>getCurrentRequest()The request for the current page. abstract StateFlow<QueryChannelsRequest>getNextPageRequest()The request for the next page, if there is a page. abstract StateFlow<Boolean>getLoading()If the current state is being loaded. abstract StateFlow<Boolean>getLoadingMore()If the current state is loading more channels (a next page is being loaded). abstract StateFlow<Boolean>getEndOfChannels()If the current state reached the final page. abstract StateFlow<List<Channel>>getChannels()The collection of channels loaded by the query channels request. abstract StateFlow<ChannelsStateData>getChannelsStateData()The channels loaded state. abstract ChatEventHandlergetChatEventHandler()Instance of ChatEventHandler that handles logic of event handling for this QueryChannelsState. abstract UnitsetChatEventHandler(@Deprecated(message = "Use chatEventHandlerFactory instead", level = DeprecationLevel.ERROR) ChatEventHandler chatEventHandler)Instance of ChatEventHandler that handles logic of event handling for this QueryChannelsState. abstract ChatEventHandlerFactorygetChatEventHandlerFactory()Factory that produces ChatEventHandler, which decides whether the set of channels should be updated. abstract UnitsetChatEventHandlerFactory(ChatEventHandlerFactory chatEventHandlerFactory)Factory that produces ChatEventHandler, which decides whether the set of channels should be updated. -
-
Method Detail
-
getRecoveryNeeded
abstract StateFlow<Boolean> getRecoveryNeeded()
If the channels need to be synced.
-
getFilter
abstract FilterObject getFilter()
The filter is associated with this query channels state.
-
getSort
abstract QuerySorter<Channel> getSort()
The sort object which requested for this query channels state.
-
getCurrentRequest
abstract StateFlow<QueryChannelsRequest> getCurrentRequest()
The request for the current page.
-
getNextPageRequest
abstract StateFlow<QueryChannelsRequest> getNextPageRequest()
The request for the next page, if there is a page.
-
getLoading
abstract StateFlow<Boolean> getLoading()
If the current state is being loaded.
-
getLoadingMore
abstract StateFlow<Boolean> getLoadingMore()
If the current state is loading more channels (a next page is being loaded).
-
getEndOfChannels
abstract StateFlow<Boolean> getEndOfChannels()
If the current state reached the final page.
-
getChannels
abstract StateFlow<List<Channel>> getChannels()
The collection of channels loaded by the query channels request. The StateFlow is initialized with null which means that channels are not loaded yet.
-
getChannelsStateData
abstract StateFlow<ChannelsStateData> getChannelsStateData()
The channels loaded state. See ChannelsStateData.
-
getChatEventHandler
abstract ChatEventHandler getChatEventHandler()
Instance of ChatEventHandler that handles logic of event handling for this QueryChannelsState.
-
setChatEventHandler
abstract Unit setChatEventHandler(@Deprecated(message = "Use chatEventHandlerFactory instead", level = DeprecationLevel.ERROR) ChatEventHandler chatEventHandler)
Instance of ChatEventHandler that handles logic of event handling for this QueryChannelsState.
-
getChatEventHandlerFactory
abstract ChatEventHandlerFactory getChatEventHandlerFactory()
Factory that produces ChatEventHandler, which decides whether the set of channels should be updated.
-
setChatEventHandlerFactory
abstract Unit setChatEventHandlerFactory(ChatEventHandlerFactory chatEventHandlerFactory)
Factory that produces ChatEventHandler, which decides whether the set of channels should be updated.
-
-
-
-