CustomPathHandler class abstract
Custom handler class used to implement a custom logic to open a file.
The matched prefix path used shouldn't be a prefix of a real web path.
Thus, if the requested file cannot be found a WebResourceResponse object with a null data will be returned instead of null.
This saves the time of falling back to network and trying to resolve a path that doesn't exist.
A WebResourceResponse with null data will be received as an HTTP response with status code 404 and no body.
The MIME type for the file will be determined from the file's extension using
guessContentTypeFromName.
Developers should ensure that asset files are named using standard file extensions.
If the file does not have a recognised extension, text/plain will be used by default.
- Inheritance
-
- Object
- PathHandler
- CustomPathHandler
Constructors
- CustomPathHandler({required String path})
- Custom handler class used to implement a custom logic to open a file.
- CustomPathHandler.fromPlatform({required PlatformCustomPathHandler platform})
- Constructs a CustomPathHandler from a specific platform implementation.
- CustomPathHandler.fromPlatformCreationParams({required PlatformCustomPathHandlerCreationParams params})
- Constructs a CustomPathHandler.
Properties
- eventHandler ↔ PlatformPathHandlerEvents?
-
Event handler object that handles the PlatformPathHandler events.
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- path → String
-
The suffix path to be handled.
no setterinherited
- platform → PlatformCustomPathHandler
-
Implementation of PlatformCustomPathHandler for the current platform.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → String
-
The path handler type.
no setterinherited
Methods
-
handle(
String path) → Future< WebResourceResponse?> -
Handles the requested URL by returning the appropriate response.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toMap(
) → Map< String, dynamic> -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited