OpenpanelPlatform class abstract

The interface that platform implementations of the openpanel plugin must extend.

Applications use Openpanel from package:openpanel/openpanel.dart directly; this interface exists so the implementation can be replaced in tests (see OpenpanelPlatform.instance).

Inheritance
  • Object
  • PlatformInterface
  • OpenpanelPlatform
Implementers

Constructors

OpenpanelPlatform()
Constructs a OpenpanelPlatform.

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

clear() → Future<void>
Clears the stored profile id, global properties and the pending event queue.
decrement(String profileId, String property, num value) → Future<void>
Decrements a numeric property of the profile by value.
flush() → Future<void>
Sends everything queued on the native side immediately.
identify(String profileId, {String? firstName, String? lastName, String? email, String? avatar, Map<String, Object?>? properties}) → Future<void>
Creates or updates a user profile and binds subsequent events to it.
increment(String profileId, String property, num value) → Future<void>
Increments a numeric property of the profile by value.
initialize(OpenpanelOptions options) → Future<void>
Configures the native client with options.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setGlobalProperties(Map<String, Object?> properties) → Future<void>
Merges properties into the properties attached to every future track event. A null value removes the property.
toString() → String
A string representation of this object.
inherited
track(String name, Map<String, Object?>? properties) → Future<void>
Sends a named event with optional properties.

Operators

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

Static Properties

instance ↔ OpenpanelPlatform
The default instance of OpenpanelPlatform to use.
getter/setter pair