IncomingMessage class abstract

The IncomingMessage interface defines the methods and properties that a request must implement. It is used to parse the request and provide access to its properties.

Implementers
Available extensions

Constructors

IncomingMessage()

Properties

clientInfo → HttpConnectionInfo?
The client info of the request.
no setter
contentLength → int
The contentLength getter is used to get the content length of the request
no setter
contentType → ContentType
The content type of the request.
no setter
cookies → List<Cookie>
The cookies of the request.
no setter
encoding → Encoding?
The encoding property contains the encoding of the request
no setter
events → StreamController<(RequestEvent, EventData)>
The events property contains the events of the request
no setter
fresh → bool
The fresh property is used to check if the request is fresh
no setter
hashCode → int
The hash code for this object.
no setterinherited
headers → SerinusHeaders
The headers of the request.
no setter
hijacked ↔ bool
It signals that the request has been hijacked and should not be processed further by the default Adapter.
getter/setter pair
host → String
The host of the request.
no setter
hostname → String
The hostname of the request.
no setter
id → String
The id of the request.
no setter
ifModifiedSince → DateTime?
The ifModifiedSince getter is used to get the if-modified-since header of the request
no setter
ifModifiedSinceCache ↔ DateTime?
The ifModifiedSinceCache is used to cache the if-modified-since header value it shouldn't be overridden.
getter/setter pair
isSse → bool

Available on IncomingMessage, provided by the IsSse extension

Returns true if the request is an SSE request.
no setter
isWebSocket → bool
This getter is used to check if the request is a web socket request
no setter
method → String
The method of the request.
no setter
path → String
The path of the request.
no setter
port → int
The port of the request.
no setter
queryParameters → Map<String, String>
The query parameters of the request.
no setter
requestedUri → Uri
The requested uri of the request. It is the absolute and complete uri of the request.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
segments → List<String>
The segments of the request path splitted by slashes.
no setter
session → Session
The port of the request.
no setter
uri → Uri
The uri of the request.
no setter
webSocketKey → String
The webSocketKey property contains the key of the web socket It is used to upgrade the request to a web socket request.
no setter

Methods

body() → String
This method is used to get the body of the request as a String
bytes() → Future<Uint8List>
This method is used to get the body of the request as a Uint8List
emit(RequestEvent event, EventData data) → void
This method is used to emit a request event.
formData({Future<void> onPart(MimeMultipart part)?}) → Future<FormData>
This method is used to get the body of the request as a FormData
json() → dynamic
This method is used to get the body of the request as a dynamic json object
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
on(RequestEvent event, Future<void> listener(RequestEvent, EventData)) → void
This method is used to listen to a request event.
stream() → Stream<List<int>>
This method is used to get the body of the request as a Stream<List<int>>
toString() → String
A string representation of this object.
inherited

Operators

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

Static Properties

maxBodySize ↔ int
Maximum body size in bytes (default: 10MB). Override to customize.
getter/setter pair