# v9 -> v10 Migration {% hint style="success" %} v10 focuses on completing the 'tiles-across-stores' functionality from v9, by bringing it to browse caching, which huge amounts of customizability and flexibility. Check out the CHANGELOG: ! This page only covers breaking changes, not feature additions and fixes. Please consider donating: [flutter\_map\_tile\_caching](/home.md#supporting-me)! Any amount is hugely appreciated! {% endhint %} ## Browse Caching We recommend following the steps on [Integrating With A Map](/usage/integrating-with-a-map.md) from start to finish to migrate your existing `FMTCTileProvider` to v10, as the API has significant changes, and the steps include new guidance to ensure best practice and performance. Some changes are highlighted below:
Absorbed FMTCTileProviderSettings directly into FMTCTileProvider The properties within have become properties directly in `FMTCTileProvider`. This also means the automatic global system (where the settings could be set once then used everywhere) has also been removed. The simplifies the code internals and removes an unnecessary layer of abstraction.
Replaced maxStoreLength with property directly on stores It has been replaced with a property on each store itself. It can be set at creation, or changed after, and read at any time: ```dart await FMTCStore('storeName').manage.create(maxLength: 1000); await FMTCStore('storeName').manage.setMaxLength(null); // Disable max length final maxLength = await FMTCStore('storeName').manage.maxLength; ``` This is more suitable for providers now that more than one store may be used, potentially each with a different maximum length.
Replaced obscuredQueryParams with urlTransformer It has been replaced on the `FMTCTileProvider` with a more flexible custom callback which may perform any processing logic required, and a utility method if the old behaviour is still desired. To migrate directly, see the example setup: [Integrating With A Map](/usage/integrating-with-a-map.md#two-static-named-stores-with-a-url-transformer).
Renamed CacheBehavior with BrowseLoadingStrategy This has been renamed to fit better with a newly introduced enumerable that work together to configure the tile provider's logic. (And also, no more US/UK confusion :D)
## Bulk Downloading Most of bulk downloading hasn't had any breaking changes, with the major exception of these:
startForeground now returns two streams It now returns one stream of `DownloadProgress`s, and one of the new `TileEvent`s. This means that checks no longer have to be made to ensure a `TileEvent` is not a repeated event (except where using the new feature to retry failed tiles, discussed below), and also means they can be more easily listened to independently. To migrate, listen to necessary streams seperately.
Renovated TileEvent completely Properties in v9 were nullable dependent on whether they were available, and this could be checked with `.result` (`TileEventResult`). `TileEvent` has been split into a tree of classes, which are sealed. This means that the available properties are fully safe and no null-checks need to be made. Switch-case statements and normal `is` checks can be used, which statically changes the type of the `TileEvent` to a subtype appropriately. Each subtype represents a specific outcome of the tile download, and mixes in certain types. * `SuccessfulTileEvent` is emitted when a tile is successfully downloaded\ \&#xNAN;*Root subtype, mixes in `TileEventFetchResponse` (makes the raw fetch response from the server available) and `TileEventImage` (makes tile image available)* * `SkippedTileEvent` (\*[^1])\ \&#xNAN;*Root subtype, mixes in `TileEventImage`* * `ExistingTileEvent` is emitted when a tile is skipped because it already exists * `SeaTileEvent` is emitted when a tile is skipped because it was a sea tile\ \&#xNAN;*Also mixes in `TileEventFetchResponse`* * `FailedTileEvent` (\*[^1])\ \&#xNAN;*Root subtype* * `NegativeResponseTileEvent` is emitted when a tile fails because the server did not respond with 200 OK\ \&#xNAN;*Mixes in `TileEventFetchResponse`* * `FailedRequestTileEvent` is emitted when a tile fails because the request to the server was not made successfully (eligible for retry)
Renamed properties within DownloadProgress Most are renamed obviously to improve clarity. Some may have had the exact included figures changed.
[^1]: another abstract type --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://fmtc.jaffaketchup.dev/get-started/v9-v10-migration.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.