OpenMethodStreamCommand class

A message sent over a websocket connection to open a websocket stream of data to an endpoint method.

An OpenMethodStreamResponse should be sent in response to this message.

Inheritance
Implemented types

Constructors

OpenMethodStreamCommand(Map data)
Creates a new OpenMethodStreamCommand message.

Properties

authentication → String?
The authentication value as it is sent across the transport layer.
final
authMode → String?
The web auth mode of the call, mirroring the HTTP webAuthModeHeaderName header: webAuthModeCookie permits authenticating the stream from the handshake auth cookie, absent forbids it.
final
connectionId → UuidValue
The connection id that uniquely identifies the stream.
final
encodedArgs → String
The JSON encoded arguments to pass to the method.
final
endpoint → String
The endpoint to call.
final
hashCode → int
The hash code for this object.
no setterinherited
inputStreams → List<String>
The input streams that should be opened.
final
method → String
The method to call.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

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

Static Methods

buildMessage({required String endpoint, required String method, required Map<String, dynamic> args, required UuidValue connectionId, required List<String> inputStreams, String? authentication, String? authMode}) → String
Creates a new OpenMethodStreamCommand.