fmtc_module_api library

Restricted API which exports internal functionality, necessary for the FMTC modules to work correctly

When importing this library, also import 'flutter_map_tile_caching.dart' for the full functionality set.


"With great power comes great responsibility" - Someone

This library forms part of a layer of abstraction between you, FMTC internals, and underlying databases. Importing this library removes that abstraction, making it easy to disrupt FMTC's normal operations with incorrect usage. For example, it is possible to force close an open Isar database, leading to an erroneous & invalid state.

If you are using this to create a custom module, go ahead! Please do get in touch, I'm always interested to hear what the community is making, and I may be able to offer some insight into the darker corners and workings of FMTC. Note that not necessarily all internal APIs are exposed through this library.

Do not use in normal applications. I may be unable to offer support.

Classes

DatabaseTools
DbMetadata
DbStoreDescriptor
DbTile
FMTCRegistry
Manages the stores available

Extensions

DbMetadataQueryFilter on QueryBuilder<DbMetadata, DbMetadata, QFilterCondition>
DbMetadataQueryObject on QueryBuilder<DbMetadata, DbMetadata, QFilterCondition>
DbMetadataQueryProperty on QueryBuilder<DbMetadata, DbMetadata, QQueryProperty>
DbMetadataQuerySortBy on QueryBuilder<DbMetadata, DbMetadata, QSortBy>
DbMetadataQuerySortThenBy on QueryBuilder<DbMetadata, DbMetadata, QSortThenBy>
DbMetadataQueryWhere on QueryBuilder<DbMetadata, DbMetadata, QWhereClause>
DbMetadataQueryWhereDistinct on QueryBuilder<DbMetadata, DbMetadata, QDistinct>
DbMetadataQueryWhereSort on QueryBuilder<DbMetadata, DbMetadata, QWhere>
DbStoreDescriptorQueryFilter on QueryBuilder<DbStoreDescriptor, DbStoreDescriptor, QFilterCondition>
DbStoreDescriptorQueryObject on QueryBuilder<DbStoreDescriptor, DbStoreDescriptor, QFilterCondition>
DbStoreDescriptorQueryProperty on QueryBuilder<DbStoreDescriptor, DbStoreDescriptor, QQueryProperty>
DbStoreDescriptorQuerySortBy on QueryBuilder<DbStoreDescriptor, DbStoreDescriptor, QSortBy>
DbStoreDescriptorQuerySortThenBy on QueryBuilder<DbStoreDescriptor, DbStoreDescriptor, QSortThenBy>
DbStoreDescriptorQueryWhere on QueryBuilder<DbStoreDescriptor, DbStoreDescriptor, QWhereClause>
DbStoreDescriptorQueryWhereDistinct on QueryBuilder<DbStoreDescriptor, DbStoreDescriptor, QDistinct>
DbStoreDescriptorQueryWhereSort on QueryBuilder<DbStoreDescriptor, DbStoreDescriptor, QWhere>
DbTileQueryFilter on QueryBuilder<DbTile, DbTile, QFilterCondition>
DbTileQueryObject on QueryBuilder<DbTile, DbTile, QFilterCondition>
DbTileQueryProperty on QueryBuilder<DbTile, DbTile, QQueryProperty>
DbTileQuerySortBy on QueryBuilder<DbTile, DbTile, QSortBy>
DbTileQuerySortThenBy on QueryBuilder<DbTile, DbTile, QSortThenBy>
DbTileQueryWhere on QueryBuilder<DbTile, DbTile, QWhereClause>
DbTileQueryWhereDistinct on QueryBuilder<DbTile, DbTile, QDistinct>
DbTileQueryWhereSort on QueryBuilder<DbTile, DbTile, QWhere>
DirectoryExtensions on Directory
GetDbMetadataCollection on Isar
GetDbStoreDescriptorCollection on Isar
GetDbTileCollection on Isar
IsarExts on Isar

Constants

DbMetadataSchema → const CollectionSchema<DbMetadata>
DbStoreDescriptorSchema → const CollectionSchema<DbStoreDescriptor>
DbTileSchema → const CollectionSchema<DbTile>