PhoenixChannelEvent class
Encapsulates constants used in the protocol over PhoenixChannel.
Constructors
- PhoenixChannelEvent(String value)
-
Instantiates a PhoenixChannelEvent from
one of the values used in the wire protocol.
factory
- PhoenixChannelEvent.custom(dynamic name)
-
A custom push event.
factory
- PhoenixChannelEvent.replyFor(String ref)
-
A reply event name for a given push ref value.
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isChannelReply → bool
-
Whether the event name is a 'channel reply' event
no setter
- isReply → bool
-
Whether the event name is an 'reply' event
no setter
-
props
→ List<
Object> -
The list of properties that will be used to determine whether
two instances are equal.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- stringify → bool?
-
If set to
true, the toString method will be overridden to output this instance's props.no setterinherited - value → String
-
The string value for a channel event.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- close ↔ PhoenixChannelEvent
-
The constant close event
getter/setter pair
- error ↔ PhoenixChannelEvent
-
The constant error event
getter/setter pair
- heartbeat ↔ PhoenixChannelEvent
-
The constant heartbeat event
getter/setter pair
- join ↔ PhoenixChannelEvent
-
The constant join event
getter/setter pair
- leave ↔ PhoenixChannelEvent
-
The constant leave event
getter/setter pair
- reply ↔ PhoenixChannelEvent
-
The constant reply event
getter/setter pair
-
statuses
↔ Set<
PhoenixChannelEvent> -
The constant set of possible internal channel event names.
getter/setter pair