stream-chat-android-client/io.getstream.chat.android.client.events

Package-level declarations

Types

data class AnswerCastedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String?, val cid: String, val channelType: String, val channelId: String, val poll: Poll, val newAnswer: Answer) : CidEvent, HasPoll

Triggered when a vote is casted.

ChannelDeletedEvent

data class ChannelDeletedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val channel: Channel, val user: User?) : CidEvent, HasChannel

Triggered when a channel is deleted

ChannelHiddenEvent

data class ChannelHiddenEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val user: User, val clearHistory: Boolean) : CidEvent, UserEvent

Triggered when a channel is mark as hidden

ChannelTruncatedEvent

data class ChannelTruncatedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val user: User?, val message: Message?, val channel: Channel) : CidEvent, HasChannel

Triggered when a channels' history is truncated. Could contain system message.

ChannelUpdatedByUserEvent

data class ChannelUpdatedByUserEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val user: User, val message: Message?, val channel: Channel) : CidEvent, UserEvent, HasChannel

Triggered when a channel is updated by user. Could contain system message.

ChannelUpdatedEvent

data class ChannelUpdatedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val message: Message?, val channel: Channel) : CidEvent, HasChannel

Triggered when a channel is updated. Could contain system message.

ChannelUserBannedEvent

data class ChannelUserBannedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val user: User, val expiration: Date?, val shadow: Boolean) : CidEvent, UserEvent

Triggered when the user is banned from a channel

ChannelUserUnbannedEvent

data class ChannelUserUnbannedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String) : CidEvent, UserEvent

Triggered when the channel user ban is lifted

ChannelVisibleEvent

data class ChannelVisibleEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val user: User) : CidEvent, UserEvent

Triggered when a channel is made visible

ChatEvent

sealed class ChatEvent

CidEvent

sealed class CidEvent : ChatEvent

ConnectedEvent

data class ConnectedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val me: User, val connectionId: String) : ChatEvent, HasOwnUser

Triggered when a user gets connected to the WS

ConnectingEvent

data class ConnectingEvent(val type: String, val createdAt: Date, val rawCreatedAt: String?) : ChatEvent

Triggered when a user is connecting to the WS

ConnectionErrorEvent

data class ConnectionErrorEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val connectionId: String, val error: ChatError) : ChatEvent

Triggered when a WS connection fails.

DisconnectedEvent

data class DisconnectedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String?, val disconnectCause: DisconnectCause = DisconnectCause.NetworkNotAvailable) : ChatEvent

Triggered when a user gets disconnected to the WS

ErrorEvent

data class ErrorEvent(val type: String, val createdAt: Date, val rawCreatedAt: String?, val error: Error) : ChatEvent

Triggered when WS connection emits error

GlobalUserBannedEvent

data class GlobalUserBannedEvent(val type: String, val user: User, val createdAt: Date, val rawCreatedAt: String) : ChatEvent, UserEvent

Triggered when the user is banned globally

GlobalUserUnbannedEvent

data class GlobalUserUnbannedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User) : ChatEvent, UserEvent

Triggered when the global user ban is lifted

HasChannel

sealed interface HasChannel

HasMember

sealed interface HasMember

HasMessage

sealed interface HasMessage

HasOwnUser

sealed interface HasOwnUser

HasPoll

sealed interface HasPoll

HasReaction

sealed interface HasReaction

HasUnreadCounts

sealed interface HasUnreadCounts

Interface that marks a ChatEvent as having the information about unread counts. There are certain cases when the server omits these fields (e.g. when ReadEvents option is disabled, when the number of watchers is over 100, etc). In that case totalUnreadCount and unreadChannels fields have 0 values.

HasUnreadThreadCounts

sealed interface HasUnreadThreadCounts

Interface that marks a ChatEvent as having the information about unread thread counts.

HasWatcherCount

sealed interface HasWatcherCount

Interface that marks a ChatEvent as having the information about watcher count.

HealthEvent

data class HealthEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val connectionId: String) : ChatEvent

Triggered every 30 second to confirm that the client connection is still alive

MarkAllReadEvent

data class MarkAllReadEvent(val type: String = "", val createdAt: Date, val rawCreatedAt: String, val user: User, val totalUnreadCount: Int = 0, val unreadChannels: Int = 0) : ChatEvent, UserEvent, HasUnreadCounts

Triggered when the total count of unread messages (across all channels the user is a member) changes

MemberAddedEvent

data class MemberAddedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val member: Member) : CidEvent, UserEvent, HasMember

Triggered when a member is added to a channel

MemberRemovedEvent

data class MemberRemovedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val member: Member) : CidEvent, UserEvent, HasMember

Triggered when a member is removed from a channel

MemberUpdatedEvent

data class MemberUpdatedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val member: Member) : CidEvent, UserEvent, HasMember

Triggered when a channel member is updated (promoted to moderator/accepted/.rejected the invite)

MessageDeletedEvent

data class MessageDeletedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User?, val cid: String, val channelType: String, val channelId: String, val message: Message, val hardDelete: Boolean) : CidEvent, HasMessage

Triggered when a message is deleted

MessageReadEvent

data class MessageReadEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val thread: ThreadInfo? = null) : CidEvent, UserEvent

Triggered when a channel is marked as read

MessageUpdatedEvent

data class MessageUpdatedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val message: Message) : CidEvent, UserEvent, HasMessage

Triggered when a message is updated

NewMessageEvent

data class NewMessageEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val message: Message, val watcherCount: Int = 0, val totalUnreadCount: Int = 0, val unreadChannels: Int = 0) : CidEvent, UserEvent, HasMessage, HasWatcherCount, HasUnreadCounts

Triggered when a new message is added on a channel.

NotificationAddedToChannelEvent

data class NotificationAddedToChannelEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val channel: Channel, val member: Member, val totalUnreadCount: Int = 0, val unreadChannels: Int = 0) : CidEvent, HasChannel, HasMember, HasUnreadCounts

Triggered when the user is added to the list of channel members

NotificationChannelDeletedEvent

data class NotificationChannelDeletedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val channel: Channel, val totalUnreadCount: Int = 0, val unreadChannels: Int = 0) : CidEvent, HasChannel, HasUnreadCounts

Triggered when a channel is deleted

NotificationChannelMutesUpdatedEvent

data class NotificationChannelMutesUpdatedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val me: User) : ChatEvent, HasOwnUser

Triggered when a channel is muted

NotificationChannelTruncatedEvent

data class NotificationChannelTruncatedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val channel: Channel, val totalUnreadCount: Int = 0, val unreadChannels: Int = 0) : CidEvent, HasChannel, HasUnreadCounts

Triggered when a channels' history is truncated

NotificationInviteAcceptedEvent

data class NotificationInviteAcceptedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val user: User, val member: Member, val channel: Channel) : CidEvent, UserEvent, HasMember, HasChannel

Triggered when the user accepts an invite

NotificationInvitedEvent

data class NotificationInvitedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val user: User, val member: Member) : CidEvent, UserEvent, HasMember

Triggered when the user is invited to join a channel

NotificationInviteRejectedEvent

data class NotificationInviteRejectedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val user: User, val member: Member, val channel: Channel) : CidEvent, UserEvent, HasMember, HasChannel

Triggered when the user rejects an invite

NotificationMarkReadEvent

data class NotificationMarkReadEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val totalUnreadCount: Int = 0, val unreadChannels: Int = 0, val threadId: String? = null, val thread: ThreadInfo? = null, val unreadThreads: Int? = null, val unreadThreadMessages: Int? = null) : CidEvent, UserEvent, HasUnreadCounts

Triggered when the count of unread messages for a particular channel changes

NotificationMarkUnreadEvent

data class NotificationMarkUnreadEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val totalUnreadCount: Int = 0, val unreadChannels: Int = 0, val unreadMessages: Int, val firstUnreadMessageId: String, val lastReadMessageAt: Date, val lastReadMessageId: String?, val threadId: String? = null, val unreadThreads: Int = 0) : CidEvent, UserEvent, HasUnreadCounts

Triggered when the the user mark as unread a conversation from a particular message

NotificationMessageNewEvent

data class NotificationMessageNewEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val channelType: String, val channelId: String, val channel: Channel, val message: Message, val totalUnreadCount: Int = 0, val unreadChannels: Int = 0) : CidEvent, HasChannel, HasMessage, HasUnreadCounts

Triggered when a message is added to a channel

NotificationMutesUpdatedEvent

data class NotificationMutesUpdatedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val me: User) : ChatEvent, HasOwnUser

Triggered when the user mutes are updated

NotificationRemovedFromChannelEvent

data class NotificationRemovedFromChannelEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User?, val cid: String, val channelType: String, val channelId: String, val channel: Channel, val member: Member) : CidEvent, HasMember, HasChannel

Triggered when a user is removed from the list of channel members

NotificationThreadMessageNewEvent

data class NotificationThreadMessageNewEvent(val type: String, val cid: String, val channelId: String, val channelType: String, val message: Message, val channel: Channel, val createdAt: Date, val rawCreatedAt: String?, val unreadThreads: Int, val unreadThreadMessages: Int) : CidEvent, HasMessage, HasChannel, HasUnreadThreadCounts

Triggered when a message is added to a channel as a thread reply.

PollClosedEvent

data class PollClosedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String?, val cid: String, val channelType: String, val channelId: String, val poll: Poll) : CidEvent, HasPoll

Triggered when a poll is closed.

PollDeletedEvent

data class PollDeletedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String?, val cid: String, val channelType: String, val channelId: String, val poll: Poll) : CidEvent, HasPoll

Triggered when a poll is deleted.

PollUpdatedEvent

data class PollUpdatedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String?, val cid: String, val channelType: String, val channelId: String, val poll: Poll) : CidEvent, HasPoll

Triggered when a poll is updated.

ReactionDeletedEvent

data class ReactionDeletedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val message: Message, val reaction: Reaction) : CidEvent, UserEvent, HasMessage, HasReaction

Triggered when a message reaction is deleted

ReactionNewEvent

data class ReactionNewEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val message: Message, val reaction: Reaction) : CidEvent, UserEvent, HasMessage, HasReaction

Triggered when a message reaction is added

ReactionUpdateEvent

data class ReactionUpdateEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val message: Message, val reaction: Reaction) : CidEvent, UserEvent, HasMessage, HasReaction

Triggered when a message reaction is updated

TypingStartEvent

data class TypingStartEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val parentId: String?) : CidEvent, UserEvent

Triggered when a user starts typing

TypingStopEvent

data class TypingStopEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User, val cid: String, val channelType: String, val channelId: String, val parentId: String?) : CidEvent, UserEvent

Triggered when a user stops typing

UnknownEvent

data class UnknownEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User?, val rawData: Map<*, *>) : ChatEvent

Triggered when event type is not supported

UserDeletedEvent

data class UserDeletedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User) : ChatEvent, UserEvent

UserEvent

sealed interface UserEvent

UserPresenceChangedEvent

data class UserPresenceChangedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User) : ChatEvent, UserEvent

Triggered when a user status changes (eg. online, offline, away, etc.)

UserStartWatchingEvent

data class UserStartWatchingEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val watcherCount: Int = 0, val channelType: String, val channelId: String, val user: User) : CidEvent, UserEvent, HasWatcherCount

Triggered when a user starts watching a channel

UserStopWatchingEvent

data class UserStopWatchingEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val cid: String, val watcherCount: Int = 0, val channelType: String, val channelId: String, val user: User) : CidEvent, UserEvent, HasWatcherCount

Triggered when a user stops watching a channel

UserUpdatedEvent

data class UserUpdatedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String, val user: User) : ChatEvent, UserEvent

Triggered when a user is updated

VoteCastedEvent

data class VoteCastedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String?, val cid: String, val channelType: String, val channelId: String, val poll: Poll, val newVote: Vote) : CidEvent, HasPoll

Triggered when a vote is casted.

VoteChangedEvent

data class VoteChangedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String?, val cid: String, val channelType: String, val channelId: String, val poll: Poll, val newVote: Vote) : CidEvent, HasPoll

Triggered when a vote is changed.

VoteRemovedEvent

data class VoteRemovedEvent(val type: String, val createdAt: Date, val rawCreatedAt: String?, val cid: String, val channelType: String, val channelId: String, val poll: Poll, val removedVote: Vote) : CidEvent, HasPoll

Triggered when a vote is removed.