Push

class Push(channel: Channel, event: String, payload: Payload, timeout: Long)

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

Constructors

Push

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

receive

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

Receive a specific event when sending an Outbound messageExample: channel .send("event", myPayload) .

resend

fun resend(timeout: Long = Defaults.TIMEOUT)

Resets and sends the Push

send

fun send()

Sends the Push.

channel

The channel the Push is being sent through

event

The event the Push is targeting

payload

The message to be sent

receivedMessage

The server's response to the Push

receiveHooks

Hooks into a Push.

ref

var ref: String? = null

The reference ID of the Push

refEvent

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

sent

var sent: Boolean = false

True if the Push has been sent

timeout

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

timeoutTask

The task to be triggered if the Push times out