SentryHiveInterface class abstract

The main API interface of SentryHive. Available through the SentryHive constant.

Annotations
  • @experimental

Constructors

SentryHiveInterface()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

box<E>(String name) → Box<E>
Returns a previously opened box.
inherited
boxExists(String name, {String? path}) Future<bool>
Checks if a box exists
inherited
close() Future<void>
Closes all open boxes.
inherited
deleteBoxFromDisk(String name, {String? path}) Future<void>
Removes the file which contains the box and closes the box.
inherited
deleteFromDisk() Future<void>
Deletes all currently open boxes from disk.
inherited
generateSecureKey() List<int>
Generates a secure encryption key using the fortuna random algorithm.
inherited
ignoreTypeId<T>(int typeId) → void
Ignore type
inherited
init(String? path, {HiveStorageBackendPreference backendPreference = HiveStorageBackendPreference.native}) → void
Initialize Hive by giving it a home directory.
inherited
isAdapterRegistered(int typeId) bool
Returns true if a TypeAdapter is registered
inherited
isBoxOpen(String name) bool
Checks if a specific box is currently open.
inherited
lazyBox<E>(String name) → LazyBox<E>
Returns a previously opened lazy box.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
openBox<E>(String name, {HiveCipher? encryptionCipher, KeyComparator keyComparator = defaultKeyComparator, CompactionStrategy compactionStrategy = defaultCompactionStrategy, bool crashRecovery = true, String? path, Uint8List? bytes, String? collection, List<int>? encryptionKey}) Future<Box<E>>
Opens a box.
inherited
openLazyBox<E>(String name, {HiveCipher? encryptionCipher, KeyComparator keyComparator = defaultKeyComparator, CompactionStrategy compactionStrategy = defaultCompactionStrategy, bool crashRecovery = true, String? path, String? collection, List<int>? encryptionKey}) Future<LazyBox<E>>
Opens a lazy box.
inherited
registerAdapter<T>(TypeAdapter<T> adapter, {bool internal = false, bool override = false}) → void
Register a TypeAdapter to announce it to Hive.
inherited
resetAdapters() → void
Clears all registered adapters.
inherited
setHub(Hub hub) → void
Set the Sentry Hub
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited