Message

data class Message(joinRef: String?, ref: String, topic: String, event: String, rawPayload: Payload)

Properties

Link copied to clipboard
val event: String

The message event name, for example "phx_join" or any other custom name

Link copied to clipboard
val joinRef: String? = null

The ref sent during a join event. Empty if not present.

Link copied to clipboard
val payload: Payload

The payload of the message

Link copied to clipboard
val ref: String

The unique string ref. Empty if not present

Link copied to clipboard
val status: String?

Convenience var to access the message's payload's status. Equivalent to checking message.payload"status" yourself

Link copied to clipboard
val topic: String

The message topic