Admin class

ObjectBox Admin allows you to explore the database in a regular web browser.

if (Admin.isAvailable()) {
  // Keep a reference until no longer needed or manually closed.
  admin = Admin(store);
}

Admin runs directly on your device or on your development machine. Behind the scenes this works by bundling a simple HTTP server into ObjectBox when building your app. If triggered, it will then provide a basic web interface to the data and schema.

Note: ObjectBox Admin is currently supported for Android apps only. Additional configuration is required.

Constructors

Admin(Store store, {String bindUri = 'http://127.0.0.1:8090'})

Creates an ObjectBox Admin associated with the given store and options.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

port → int

Port the admin listens on. This is especially useful if the port was assigned automatically (a "0" port was used in the bindUri).

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Closes and cleans up all resources used by this Admin.

isClosed() → bool

Returns if the admin is already closed and can no longer be used.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

isAvailable() → bool

Whether the loaded ObjectBox native library supports Admin.