PresenceAction enum

Describes the possible actions members in the presence set can emit.

Inheritance

• Object
• Enum
• PresenceAction

Constructors

PresenceAction()

const

Values

absent → const PresenceAction

A member is not present in the channel.

present → const PresenceAction

When subscribing to presence events on a channel that already has members present, this event is emitted for every member already present on the channel before the subscribe listener was registered.

enter → const PresenceAction

A new member has entered the channel.

leave → const PresenceAction

A member who was present has now left the channel.

This may be a result of an explicit request to leave or implicitly when detaching from the channel. Alternatively, if a member's connection is abruptly disconnected and they do not resume their connection within a minute, Ably treats this as a leave event as the client is no longer present.

update → const PresenceAction

An already present member has updated their member data.

Being notified of member data updates can be very useful, for example, it can be used to update the status of a user when they are typing a message.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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

Constants

values → const List<PresenceAction>

A constant List of the values in this enum, in order of their declaration.