Route class abstract
A Route defines a destination in Serverpod's web server. It will handle a call and generate an appropriate response by manipulating the HttpRequest object. You override Route, or more likely it's subclass WidgetRoute to create your own custom routes in your server.
- Implementers
Constructors
- Route({RouteMethod method = RouteMethod.get})
- Creates a new Route.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- method → RouteMethod
-
The method this route will respond to, i.e. HTTP get or post.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
handleCall(
Session session, HttpRequest request) → Future< bool> -
Handles a call to this route. This method is repsonsible for setting
a correct response headers, status code, and write the response body to
request.response. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setHeaders(
HttpHeaders headers) → void - Sets the headers of the response. Default is text/html with UTF-8 encoding.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited