-
- All Implemented Interfaces:
-
io.getstream.chat.android.client.controllers.ChannelController
public final class ChannelClient implements ChannelController
-
-
Method Summary
-
-
Method Detail
-
getChannelType
String getChannelType()
-
getChannelId
String getChannelId()
-
events
ChatObservable events()
-
subscribe
@Deprecated(message = User subscribe with ChatEventListener)@SinceKotlin(version = 99999.9) Disposable subscribe(Function1<ChatEvent, Unit> listener)
-
subscribe
final Disposable subscribe(ChatEventListener<ChatEvent> listener)
-
subscribeFor
@Deprecated(message = User subscribeFor with ChatEventListener)@SinceKotlin(version = 99999.9) Disposable subscribeFor(String eventTypes, Function1<ChatEvent, Unit> listener)
-
subscribeFor
final Disposable subscribeFor(String eventTypes, ChatEventListener<ChatEvent> listener)
-
subscribeFor
@Deprecated(message = User subscribeFor with ChatEventListener)@SinceKotlin(version = 99999.9) Disposable subscribeFor(LifecycleOwner lifecycleOwner, String eventTypes, Function1<ChatEvent, Unit> listener)
Subscribes to the specific eventTypes of the channel, in the lifecycle of lifecycleOwner.
Only receives events when the lifecycle is in a STARTED state, otherwise events are dropped.
-
subscribeFor
final Disposable subscribeFor(LifecycleOwner lifecycleOwner, String eventTypes, ChatEventListener<ChatEvent> listener)
-
subscribeFor
@Deprecated(message = User subscribeFor with ChatEventListener)@SinceKotlin(version = 99999.9) Disposable subscribeFor(Class<out ChatEvent> eventTypes, Function1<ChatEvent, Unit> listener)
Subscribes to one or more event eventTypes. Does not respect any lifecycle.
- Parameters:
eventTypes- a list of events we wish to observelistener- callback invoked when events are received
-
subscribeFor
final Disposable subscribeFor(Class<out ChatEvent> eventTypes, ChatEventListener<ChatEvent> listener)
-
subscribeFor
@Deprecated(message = User subscribeFor with ChatEventListener)@SinceKotlin(version = 99999.9) Disposable subscribeFor(LifecycleOwner lifecycleOwner, Class<out ChatEvent> eventTypes, Function1<ChatEvent, Unit> listener)
Subscribes to the specific eventTypes of the channel, in the lifecycle of lifecycleOwner.
Only receives events when the lifecycle is in a STARTED state, otherwise events are dropped.
-
subscribeFor
final Disposable subscribeFor(LifecycleOwner lifecycleOwner, Class<out ChatEvent> eventTypes, ChatEventListener<ChatEvent> listener)
-
subscribeForSingle
@Deprecated(message = User subscribeForSingle with ChatEventListener)@SinceKotlin(version = 99999.9) Disposable subscribeForSingle(String eventType, Function1<ChatEvent, Unit> listener)
Subscribes for the next channel event with the given eventType.
-
subscribeForSingle
final Disposable subscribeForSingle(String eventType, ChatEventListener<ChatEvent> listener)
-
subscribeForSingle
@Deprecated(message = User subscribeForSingle with ChatEventListener)@SinceKotlin(version = 99999.9) <T extends ChatEvent> Disposable subscribeForSingle(Class<T> eventType, Function1<T, Unit> listener)
Subscribes for the next channel event with the given eventType.
-
subscribeForSingle
final <T extends ChatEvent> Disposable subscribeForSingle(Class<T> eventType, ChatEventListener<T> listener)
-
query
@CheckResult() Call<Channel> query(QueryChannelRequest request)
-
watch
@CheckResult() Call<Channel> watch(WatchChannelRequest request)
-
watch
@CheckResult() Call<Channel> watch()
-
stopWatching
@CheckResult() Call<Unit> stopWatching()
-
getMessage
@CheckResult() Call<Message> getMessage(String messageId)
-
updateMessage
@CheckResult() Call<Message> updateMessage(Message message)
-
deleteMessage
@CheckResult() Call<Message> deleteMessage(String messageId)
-
sendMessage
@CheckResult() Call<Message> sendMessage(Message message)
-
unBanUser
@CheckResult() Call<Unit> unBanUser(String targetId)
-
shadowBanUser
@CheckResult() Call<Unit> shadowBanUser(String targetId, String reason, Integer timeout)
-
removeShadowBan
@CheckResult() Call<Unit> removeShadowBan(String targetId)
-
markMessageRead
@CheckResult() Call<Unit> markMessageRead(String messageId)
-
markRead
@CheckResult() Call<Unit> markRead()
-
delete
@CheckResult() Call<Channel> delete()
-
show
@CheckResult() Call<Unit> show()
-
hide
@CheckResult() Call<Unit> hide(Boolean clearHistory)
-
sendFile
@CheckResult() Call<String> sendFile(File file)
-
sendFile
@CheckResult() Call<String> sendFile(File file, ProgressCallback callback)
-
sendImage
@CheckResult() Call<String> sendImage(File file)
-
sendImage
@CheckResult() Call<String> sendImage(File file, ProgressCallback callback)
-
sendReaction
@CheckResult() Call<Reaction> sendReaction(Reaction reaction, Boolean enforceUnique)
-
sendAction
@CheckResult() Call<Message> sendAction(SendActionRequest request)
-
deleteReaction
@CheckResult() Call<Message> deleteReaction(String messageId, String reactionType)
-
getReactions
@CheckResult() Call<List<Reaction>> getReactions(String messageId, Integer offset, Integer limit)
-
getReactions
@CheckResult() Call<List<Message>> getReactions(String messageId, String firstReactionId, Integer limit)
-
enableSlowMode
@CheckResult() Call<Channel> enableSlowMode(Integer cooldownTimeInSeconds)
-
disableSlowMode
@CheckResult() Call<Channel> disableSlowMode()
-
addMembers
@CheckResult() Call<Channel> addMembers(String userIds)
-
removeMembers
@CheckResult() Call<Channel> removeMembers(String userIds)
-
acceptInvite
@CheckResult() Call<Channel> acceptInvite(String message)
-
rejectInvite
@CheckResult() Call<Channel> rejectInvite()
-
muteCurrentUser
@CheckResult() Call<Mute> muteCurrentUser()
-
mute
@CheckResult() Call<Unit> mute()
-
unmute
@CheckResult() Call<Unit> unmute()
-
muteUser
@CheckResult() Call<Mute> muteUser(String userId)
-
unmuteUser
@CheckResult() Call<Unit> unmuteUser(String userId)
-
unmuteCurrentUser
@CheckResult() Call<Unit> unmuteCurrentUser()
-
keystroke
@CheckResult() Call<ChatEvent> keystroke()
-
stopTyping
@CheckResult() Call<ChatEvent> stopTyping()
-
stopTyping
final Call<ChatEvent> stopTyping(String parentId)
-
queryMembers
@CheckResult() Call<List<Member>> queryMembers(Integer offset, Integer limit, FilterObject filter, QuerySort<Member> sort, List<Member> members)
-
getFileAttachments
@CheckResult() final Call<List<Attachment>> getFileAttachments(Integer offset, Integer limit)
-
getImageAttachments
@CheckResult() final Call<List<Attachment>> getImageAttachments(Integer offset, Integer limit)
-
getMessagesWithAttachments
@CheckResult() final Call<List<Message>> getMessagesWithAttachments(Integer offset, Integer limit, String type)
-
pinMessage
@CheckResult() final Call<Message> pinMessage(Message message, Date expirationDate)
-
pinMessage
@CheckResult() final Call<Message> pinMessage(Message message, Integer timeout)
-
unpinMessage
@CheckResult() final Call<Message> unpinMessage(Message message)
-
-
-
-