DimeloFlutterPlatform class abstract
The interface that implementations of dimelo_flutter must implement.
Platform-specific implementations should extend this class rather than
implement it as dimelo_flutter does not consider newly added methods
to be breaking changes. Extending this class (using extends) ensures
that the subclass will get the default implementation, while platform
implementations that implements this interface will be broken by newly
added DimeloFlutterPlatform methods.
- Inheritance
-
- Object
- PlatformInterface
- DimeloFlutterPlatform
- Implementers
Constructors
- DimeloFlutterPlatform()
- Constructs a DimeloFlutterPlatform.
Properties
-
eventStream
→ Stream<
Map< String, dynamic> > -
Get a stream of Dimelo events.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
getAppBarConfig(
) → Future< Map< String, dynamic> > - Get the current app bar configuration.
-
getCurrentUser(
) → Future< Map< String, dynamic> > - Get the current user information.
-
getPlatformVersion(
) → Future< String?> - Get the platform version information.
-
getUnreadCount(
) → Future< int> - Fetch unread messages count from the SDK.
-
handlePush(
Map< String, String> payload) → Future<bool> - Let the SDK handle an incoming push payload.
-
initialize(
{String? applicationSecret, String? apiKey, String? apiSecret, String? domain, String? userId, bool? developmentApns}) → Future< bool> - Initialize Dimelo/Engage Digital Messaging SDK on the native side.
-
isAvailable(
) → Future< bool> - Check if the SDK was initialized and is available.
-
logout(
) → Future< bool> - Logout/clear the current user session if supported.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setAppBarColor(
String color) → Future< bool> - Set the app bar color dynamically.
-
setAppBarTitle(
String title) → Future< bool> - Set the app bar title dynamically.
-
setAppBarTitleColor(
String color) → Future< bool> - Set the app bar title color dynamically.
-
setAppBarVisibility(
{required bool visible}) → Future< bool> - Set the app bar visibility dynamically.
-
setAuthInfo(
Map< String, String> info) → Future<bool> - Set arbitrary authentication info key/values (e.g., ticket_id).
-
setBackArrowColor(
String color) → Future< bool> - Set the back arrow color dynamically.
-
setBackButtonVisibility(
{required bool visible}) → Future< bool> - Set the back button visibility dynamically.
-
setDeviceToken(
String token) → Future< bool> - Pass the device push token to the SDK.
-
setFullScreenPresentation(
{required bool fullScreen}) → Future< bool> - Set the presentation style for iOS (full screen vs bottom sheet).
-
setUser(
{String? userId, String? name, String? email, String? phone}) → Future< bool> - Set/update the current user information.
-
showMessenger(
) → Future< bool> - Open the messaging UI if available on the native SDK.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance ↔ DimeloFlutterPlatform
-
The default instance of DimeloFlutterPlatform to use.
getter/setter pair