LaravelEcho<ClientType, ChannelType> class
Constructors
-
LaravelEcho.new(StorageDatabase storageDatabase, Connector<
ClientType, ChannelType> connector, {List<LaravelEchoMigration> migrations = const []})
Properties
-
connector
↔ Connector<
ClientType, ChannelType> -
The broadcasting connector.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
migrations
↔ List<
LaravelEchoMigration> -
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- socketId → String?
-
Get the Socket ID for the connection.
no setterinherited
- storageDatabase → StorageDatabase
-
final
Methods
-
channel(
String channel) → Channel -
Get a channel instance by name.
inherited
-
connect(
) → void -
Create a connection.
inherited
-
disconnect(
) → void -
Disconnect from the Echo server.
override
-
join(
String channel) → PresenceChannel -
Get a presence channel instance by name.
inherited
-
leave(
String channel) → void -
Leave the given channel, as well as its private and presence variants.
inherited
-
leaveChannel(
String channel) → void -
Leave the given channel.
inherited
-
listen(
String channel, String event, Function callback) → void -
Listen for an event on a channel instance.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
presence(
String channel) → PresenceChannel -
Get a presence channel instance by name.
inherited
-
private(
String channel) → PrivateChannel -
Get a private channel instance by name.
inherited
-
privateEncrypted(
String channel) → PrivateEncryptedChannel -
Get a private encrypted channel instance by name.
inherited
-
removeMigration(
LaravelEchoMigration migration) → void -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- hasInstance → bool
-
no setter
- hasPusherInstance → bool
-
no setter
- hasSocketInstance → bool
-
no setter
- instance → LaravelEcho
-
no setter
-
pusherInstance
→ LaravelEcho<
PusherClient, PusherChannel< Channel> > -
no setter
-
socketInstance
→ LaravelEcho<
Socket, SocketIoChannel> -
no setter
Static Methods
-
pusher(
StorageDatabase storageDatabase, String appKey, List< LaravelEchoMigration> migrations, {required String authEndPoint, Map<String, String> authHeaders = const {'Content-Type' : 'application/json'}, String? cluster, String? host, Map<String, dynamic> channelDecryption(Uint8List, Map<String, dynamic> )?, int wsPort = 80, int wssPort = 443, bool encrypted = true, int activityTimeout = 120000, int pongTimeout = 30000, int maxReconnectionAttempts = 6, Duration reconnectGap = const Duration(seconds: 2), bool enableLogging = true, bool autoConnect = true, String? nameSpace}) → LaravelEcho<PusherClient, PusherChannel< Channel> > -
Init Echo with Pusher client
override
-
socket(
StorageDatabase storageDatabase, String host, List< LaravelEchoMigration> migrations, {Map<String, String> ? authHeaders, String? nameSpace, bool autoConnect = true, Map moreOptions = const {}, Map<String, dynamic> channelDecryption(String, Map)?}) → LaravelEcho<Socket, SocketIoChannel> -
Init Echo with Socket client
override