Package-level declarations

Types

Link copied to clipboard
data class ActionTaker(val id: String, val deviceId: String, val customName: String, val isAdmin: Boolean, val blocked: Boolean) : Parcelable

Represents the user who took an action.

Link copied to clipboard
data class ActivePoll(val id: String, val multiChoice: MultiChoice, val startedAt: String, val status: String, val type: String, val votesCount: Int, val timestampEndedAt: String? = null, val unixTimestampEndedAt: Long)
Link copied to clipboard
data class BlockedUser(val actionTaker: ActionTaker, val customName: String, val deviceId: String, val id: String)
Link copied to clipboard
data class BlockUnblockUser(val id: String, val actionTaker: ActionTaker, val blocked: Boolean, val customName: String, val deviceId: String) : Parcelable

Represents blocking or unblocking of a user.

Link copied to clipboard
data class BroadcastMessage(val viewerMetrics: ViewerMetrics) : Parcelable

Represents a broadcast message.

Link copied to clipboard
data class ChatRoomInfo(val activePoll: ActivePoll?, val blockedUsers: List<BlockedUser>, val id: String, val muted: Boolean, val pinnedMessages: List<PinnedMessage>, val timestampUpdatedAt: String, val timestampCreatedAt: String, val unixTimestampUpdatedAt: Long, val unixTimestampCreatedAt: Long, val self: Self = Self(), val customCounters: List<CustomCounter>?)
Link copied to clipboard
sealed interface ChatRoomRole
Link copied to clipboard
class ChatRoomUser(val userName: String?, val deviceId: String?, val role: ChatRoomRole)
Link copied to clipboard
data class CustomCounter(val key: String, var value: Int, val versionNumber: String, val timestampUpdatedAt: String?, val disabled: Boolean) : Parcelable

Represents a custom counter.

Link copied to clipboard
data class CustomMessage(val value: String, val increment: Increment?) : Parcelable

Represents a custom message.

Link copied to clipboard
data class DeleteMessage(val id: String) : Parcelable

Represents deletion of a message.

Link copied to clipboard
data class EntranceMessage(val id: String, val deviceId: String, val customName: String, val isAdmin: Boolean) : Parcelable

Represents an entrance message.

Link copied to clipboard
data class Increment(val key: String, val value: Int) : Parcelable

Represents an increment value.

Link copied to clipboard
data class Message(val id: String, val sender: Sender, val text: String) : Parcelable

Represents a message.

Link copied to clipboard
sealed interface MessageException

Exception class for the Message SDK.

Link copied to clipboard
data class MessageInfo(val id: String, val user: User, val type: String, val textMessage: TextMessage? = null, val customMessage: CustomMessage? = null, val entranceMessage: EntranceMessage? = null, val customCounter: CustomCounter? = null, val broadcastMessage: BroadcastMessage? = null, val pinUnpinMessage: PinUnpinMessage? = null, val blockUnblockUser: BlockUnblockUser? = null, val deleteMessage: DeleteMessage? = null, val viewerInfo: ViewerInfo? = null, val timestampCreatedAt: String, val timestampSentAt: String, val timestampReceivedAt: String, val timestampPublishedAt: String, val unixTimestampCreatedAt: Long, val unixTimestampSentAt: Long, val unixTimestampReceivedAt: Long, val unixTimestampPublishedAt: Long, val isLocalCustomMessage: Boolean? = false) : Parcelable

Represents information about a message.

Link copied to clipboard
sealed interface MessageType
Link copied to clipboard
data class MultiChoice(val options: List<Option>, val question: String)
Link copied to clipboard
data class Option(val corrected: Boolean, val id: String, val text: String, val votesCount: Int)
Link copied to clipboard
data class PinnedMessage(val actionTaker: ActionTaker, val message: Message)
Link copied to clipboard
data class PinUnpinMessage(val actionTaker: ActionTaker, val message: Message) : Parcelable

Represents pinning or unpinning of a message.

Link copied to clipboard
data class Self(val isAdmin: Boolean = false, val isGuest: Boolean = false, val customerId: String = "", val deviceId: String = "", val customName: String = "")
Link copied to clipboard
data class Sender(val customName: String, val deviceId: String, val id: String) : Parcelable

Represents the sender of a message.

Link copied to clipboard
data class TextMessage(val text: String, val filtered: Boolean) : Parcelable

Represents a text message.

Link copied to clipboard
data class User(val id: String, val deviceId: String, val customName: String, val isAdmin: Boolean, val blocked: Boolean) : Parcelable

Represents a user.

Link copied to clipboard
data class ViewerCount(val count: Int, val timestampUpdatedAt: String? = null) : Parcelable

Represents viewer count.

Link copied to clipboard
data class ViewerInfo(val enabled: Boolean, val count: Int, val versionNumber: String, val timestampUpdatedAt: String, val unixTimestampUpdatedAt: Long) : Parcelable

Represents information about viewers.

Link copied to clipboard
data class ViewerMetrics(val concurrent: ViewerCount, val total: ViewerCount) : Parcelable

Represents viewer metrics.