Skip to main content

Relay::Calling::ConnectAction

This object is returned by connect! method and represents a connecting attempt that is currently active on a call.

Properties

PropertyTypeDescription
resultRelay::Calling::ConnectResultFinal result of connecting.
stateStringCurrent state of connecting attempt.
completedBooleanWhether the connection attempt has completed.
payloadHashPayload sent to Relay to start the connect.

Methods

stop

Stop the action immediately.

Parameters

None

Returns

Relay::Calling::StopResult - A StopResult object with a successful property.