JavaPhoenixClient/org.phoenixframework/Push

Push

class Push(val channel: Channel, val event: String, var payloadClosure: PayloadClosure, var timeout: Long = Defaults.TIMEOUT)

A Push represents an attempt to send a payload through a Channel for a specific event.

Constructors

Push

constructor(channel: Channel, event: String, payload: Payload = mapOf(), timeout: Long = Defaults.TIMEOUT)

constructor(channel: Channel, event: String, payloadClosure: PayloadClosure, timeout: Long = Defaults.TIMEOUT)

Properties

channel

val channel: Channel

The channel the Push is being sent through

event

val event: String

The event the Push is targeting

payload

var payload: Payload

payloadClosure

var payloadClosure: PayloadClosure

Closure that allows changing parameters sent during push

receivedMessage

var receivedMessage: Message?

The server's response to the Push

receiveHooks

var receiveHooks: MutableMap<String, List<(message: Message) -> Unit>>

Hooks into a Push. Where .receive("ok", callback(Payload)) are stored

ref

var ref: String?

The reference ID of the Push

refEvent

var refEvent: String?

The event that is associated with the reference ID of the Push

sent

var sent: Boolean

True if the Push has been sent

timeout

var timeout: Long

Duration before the message is considered timed out and failed to send

timeoutTask

var timeoutTask: DispatchWorkItem?

The task to be triggered if the Push times out

Functions

receive

fun receive(callback: (status: String, message: Message) -> Unit): Push

Receives any event that was a response to an outbound message.

fun receive(status: String, callback: (Message) -> Unit): Push

Receive a specific event when sending an Outbound message

resend

fun resend(timeout: Long = Defaults.TIMEOUT)

Resets and sends the Push

send

fun send()

Sends the Push. If it has already timed out then the call will be ignored. use resend(timeout:) in this case.