JavaPhoenixClient/org.phoenixframework/Message

Message

data class Message(val joinRef: String? = null, val ref: String = "", val topic: String = "", val event: String = "", rawPayload: Payload = HashMap(), val payloadJson: String = "")

Constructors

constructor(joinRef: String? = null, ref: String = "", topic: String = "", event: String = "", rawPayload: Payload = HashMap(), payloadJson: String = "")

Properties

val event: String

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

val joinRef: String? = null

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

val payload: Payload

The payload of the message

val payloadJson: String

The payload, as a json string

val ref: String

The unique string ref. Empty if not present

val status: String?

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

val topic: String

The message topic