SignalR class

Inheritance

• Object
• SignalrPlatformInterface
• SignalR

Implemented types

• SignalRPlatformApi

Constructors

SignalR(String baseUrl, String hubName, {String? queryString, Map<String, String>? headers, List<String>? hubMethods, Transport transport = Transport.auto, void statusChangeCallback(ConnectionStatus?)?, void hubCallback(String, String)?})

Properties

baseUrl → String

final, inherited

connectionId ↔ String?

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

headers → Map<String, String>?

final, inherited

hubCallback → (void Function(String, String)?)

This callback gets called whenever SignalR server sends some message to client.

final, inherited

hubMethods → List<String>?

List of Hub method names you want to subscribe. Every subsequent message from server gets called on hubCallback.

final, inherited

hubName → String

final, inherited

queryString → String?

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

statusChangeCallback → (void Function(ConnectionStatus?)?)

This callback gets called whenever SignalR connection status with server changes.

final, inherited

transport → Transport

Transport.Auto is default.

final, inherited

Methods

connect() → Future<String?>

Connect to the SignalR Server with given baseUrl & hubName.

override

invokeMethod(String methodName, {List<String>? arguments}) → Future<String>

Invoke any server method with optional arguments.

override

isConnected() → Future<bool>

Checks if SignalR connection is still active.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onNewMessage(String hubName, String message) → Future<void>

override

onStatusChange(StatusChangeResult statusChangeResult) → Future<void>

override

reconnect() → Future<String?>

Try to Reconnect SignalR connection if it gets disconnected.

override

stop() → Future<void>

Stops SignalR connection

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited