CustomPathHandler constructor

CustomPathHandler({
  1. required String path,
})

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.

Implementation

CustomPathHandler({required String path})
    : this.fromPlatformCreationParams(
          params: PlatformCustomPathHandlerCreationParams(
              PlatformPathHandlerCreationParams(path: path)));