PhoenixChannel class

Constructors

PhoenixChannel(String _topic, Map _params, PhoenixSocket? socket)
To create a channel use PhoenixSocket.channel

Properties

canPush bool
no setter
hashCode int
The hash code for this object.
no setterinherited
isClosed bool
no setter
isErrored bool
no setter
isJoined bool
no setter
isJoining bool
no setter
isLeaving bool
no setter
joinPush PhoenixPush?
no setter
joinRef String?
no setter
params Map?
no setter
rejoinTimer Timer?
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
socket PhoenixSocket?
getter/setter pair
timeout int?
no setter
topic String?
no setter

Methods

join() PhoenixPush?
Attempts to join the Phoenix Channel
leave() PhoenixPush?
Leaves the channel
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
off(dynamic event, [dynamic ref]) → void
Removes an event callback
on(String? event, PhoenixMessageCallback callback) int
Adds a callback which will be triggered on receiving an event with matching name
onClose(PhoenixMessageCallback callback) → dynamic
Adds a callback to be triggered on channel close
onError(dynamic callback) → dynamic
Adds a callback to be trigger on channel error
onMessage(dynamic event, dynamic payload, dynamic ref) → dynamic
push({String? event, Map? payload}) PhoenixPush?
Pushes a message to the server
replyEventName(dynamic ref) String?
toString() String
A string representation of this object.
inherited
triggerError() → dynamic

Operators

operator ==(Object other) bool
The equality operator.
inherited