ServerApi class

The DevTools server API.

This defines endpoints that serve all requests that come in over api/.

Constructors

ServerApi()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

badRequest([String? error]) → Response

A shelf.Response for API calls that encountered a request problem e.g., setActiveSurvey not called.

forbidden([String? reason]) → Response

A shelf.Response for API calls that are forbidden for the current state of the server.

logScreenView() → Response

Logs a page view in the DevTools server.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notImplemented() → Response

A shelf.Response for API calls that have not been implemented in this server.

serverError([String? error, List<String>? logs]) → Response

A shelf.Response for API calls that encountered a server error e.g., setActiveSurvey not called.

success([String? value]) → Response

A shelf.Response for API calls that succeeded.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

devToolsPreferences → DevToolsUsage

no setter

Static Methods

canHandle(Request request) → bool

Determines whether or not request is an API call.

handle(Request request, {required ExtensionsManager extensionsManager, required DeeplinkManager deeplinkManager, ServerApi? api, DtdInfo? dtd}) → FutureOr<Response>

Handles all requests.

Constants

errorKey → const String

logsKey → const String