OverlayKeebPlatform class abstract

An abstract class that serves as the platform interface for the Overlay Keyboard plugin.

Platform implementations should extend this class rather than implement it as this ensures the interface remains consistent across all implementations. This follows the Flutter plugin development best practices.

Inheritance
  • Object
  • PlatformInterface
  • OverlayKeebPlatform
Implementers

Constructors

OverlayKeebPlatform.new()
Constructs a OverlayKeebPlatform instance.

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

getPlatformVersion() Future<String?>
Gets the current platform version.
hideOverlay() Future<void>
Hides the currently displayed overlay.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOverlayUi({required String entrypointFunctionName, required String entrypointLibraryPath}) Future<void>
Registers a custom Flutter UI to be displayed in the overlay.
showOverlay({int? overlayHeightDp}) Future<void>
Shows the overlay UI.
toString() String
A string representation of this object.
inherited

Operators

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

Static Properties

instance OverlayKeebPlatform
Returns the current default implementation.
getter/setter pair