Store class
An opened Store instance.
This class represents an active store, including its handle and uri.
Constructors
- Store(StoreHandle handle, String uri)
- Constructs an instance of Store.
Properties
- handle → StoreHandle
-
The handle for the store.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- uri → String
-
The URI of the store.
final
Methods
-
close(
{bool remove = false}) → Future< bool> - Closes and frees the store instance.
-
copyTo(
{required String uri, StoreKeyMethod? keyMethod, String? passKey, required bool recreate}) → Future< StoreHandle> - Copies the store contents to a new location.
-
createProfile(
{String? name}) → Future< void> - Creates a new profile in the store.
-
getDefaultProfile(
) → Future< String> - Gets the default profile name when the store is opened.
-
getProfileName(
) → Future< String> - Gets the currently selected profile name.
-
listProfiles(
) → Future< List< String> > - Lists the profile identifiers present in the store.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openSession(
{bool isTransaction = false}) → Future< Session> - Opens a session on the store.
-
rekey(
{StoreKeyMethod? keyMethod, required String passKey}) → Future< void> - Updates the master encryption key of the store.
-
removeProfile(
String name) → Future< bool> - Removes a profile from the store.
-
scan(
{required String category, Map< String, dynamic> ? tagFilter, int? offset, int? limit, String? profile, String? orderBy, bool? descending}) → Scan - Starts a new record scan.
-
session(
{String? profile}) → OpenSession - Opens a new session on the store without starting a transaction.
-
setDefaultProfile(
String name) → Future< void> - Sets the default profile name when the store is opened.
-
toString(
) → String -
A string representation of this object.
inherited
-
transaction(
{String? profile}) → OpenSession - Opens a new transactional session on the store.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
generateRawKey(
{Uint8List? seed}) → String - Generates a new raw key for a Store.
-
open(
{required String uri, StoreKeyMethod? keyMethod, String? passKey, String? profile}) → Future< Store> - Opens an existing store.
-
provision(
{required String uri, StoreKeyMethod? keyMethod, String? passKey, String? profile, required bool recreate}) → Future< Store> - Provisions a new store.
-
remove(
String uri) → Future< bool> - Removes an existing store.