ServicesBinding mixin Null safety
Listens for platform messages and directs them to the defaultBinaryMessenger.
The ServicesBinding also registers a LicenseEntryCollector that exposes
the licenses found in the LICENSE
file stored at the root of the asset
bundle, and implements the ext.flutter.evict
service extension (see
evict).
- Superclass Constraints
- Mixin Applications
Properties
- keyboard → HardwareKeyboard
-
The global singleton instance of HardwareKeyboard, which can be used to
query keyboard states.
read-only
- keyEventManager → KeyEventManager
-
The global singleton instance of KeyEventManager, which is used
internally to dispatch key messages.
read-only
- defaultBinaryMessenger → BinaryMessenger
-
The default instance of BinaryMessenger.
read-only
- channelBuffers → ChannelBuffers
-
The low level buffering and dispatch mechanism for messages sent by
plugins on the engine side to their corresponding plugin code on
the framework side.
read-only
- restorationManager → RestorationManager
-
The RestorationManager synchronizes the restoration data between
engine and framework.
read-only
- window → SingletonFlutterWindow
-
The main window to which this binding is bound.
read-onlyinherited
- platformDispatcher → PlatformDispatcher
-
The ui.PlatformDispatcher to which this binding is bound.
read-onlyinherited
- locked → bool
- Whether lockEvents is currently locking events.
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
- schedulingStrategy ↔ SchedulingStrategy
-
The strategy to use when deciding whether to run a task or not.
read / writeinherited
- lifecycleState → AppLifecycleState?
-
Whether the application is visible, and if so, whether it is currently
interactive.
read-onlyinherited
- transientCallbackCount → int
-
The current number of transient frame callbacks scheduled.
read-onlyinherited
-
endOfFrame
→ Future<
void> -
Returns a Future that completes after the frame completes.
read-onlyinherited
- hasScheduledFrame → bool
-
Whether this scheduler has requested that handleBeginFrame be called soon.
read-onlyinherited
- schedulerPhase → SchedulerPhase
-
The phase that the scheduler is currently operating under.
read-onlyinherited
- framesEnabled → bool
-
Whether frames are currently being scheduled when scheduleFrame is called.
read-onlyinherited
- currentFrameTimeStamp → Duration
-
The time stamp for the frame currently being processed.
read-onlyinherited
- currentSystemFrameTimeStamp → Duration
-
The raw time stamp as provided by the engine to
dart:ui.PlatformDispatcher.onBeginFrame for the frame currently being
processed.
read-onlyinherited
Methods
-
addPersistentFrameCallback(
FrameCallback callback) → void -
Adds a persistent frame callback.
inherited
-
addPostFrameCallback(
FrameCallback callback) → void -
Schedule a callback for the end of this frame.
inherited
-
addTimingsCallback(
TimingsCallback callback) → void -
Add a TimingsCallback that receives FrameTiming sent from
the engine.
inherited
-
cancelFrameCallbackWithId(
int id) → void -
Cancels the transient frame callback with the given
id
.inherited -
createBinaryMessenger(
) → BinaryMessenger -
Creates a default BinaryMessenger instance that can be used for sending
platform messages.
protected">@protected
-
createRestorationManager(
) → RestorationManager -
Creates the RestorationManager instance available via
restorationManager.
protected">@protected
-
debugAssertNoTransientCallbacks(
String reason) → bool -
Asserts that there are no registered transient callbacks; if
there are, prints their locations and throws an exception.
inherited
-
ensureFrameCallbacksRegistered(
) → void -
Ensures callbacks for PlatformDispatcher.onBeginFrame and
PlatformDispatcher.onDrawFrame are registered.
protected">@protectedinherited
-
ensureVisualUpdate(
) → void -
Schedules a new frame using scheduleFrame if this object is not
currently producing a frame.
inherited
-
evict(
String asset) → void -
Called in response to the
ext.flutter.evict
service extension.mustCallSuper">@mustCallSuperprotected">@protected -
handleAppLifecycleStateChanged(
AppLifecycleState state) → void - Called when the application lifecycle state changes.
-
handleBeginFrame(
Duration? rawTimeStamp) → void -
Called by the engine to prepare the framework to produce a new frame.
inherited
-
handleDrawFrame(
) → void -
Called by the engine to produce a new frame.
inherited
-
handleEventLoopCallback(
) → bool -
Execute the highest-priority task, if it is of a high enough priority.
visibleForTesting">@visibleForTestinginherited
-
handleMemoryPressure(
) → void -
Called when the operating system notifies the application of a memory
pressure situation.
mustCallSuper">@mustCallSuperprotected">@protected
-
handleSystemMessage(
Object systemMessage) → Future< void> -
Handler called for messages received on the SystemChannels.system
message channel.
mustCallSuper">@mustCallSuperprotected">@protected
-
initInstances(
) → void -
The initialization method. Subclasses override this method to hook into
the platform and otherwise configure their services. Subclasses must call
"super.initInstances()".
override
-
initLicenses(
) → void -
Adds relevant licenses to the LicenseRegistry.
mustCallSuper">@mustCallSuperprotected">@protected
-
initServiceExtensions(
) → void -
Called when the binding is initialized, to register service
extensions.
override
-
lockEvents(
Future< void> callback()) → Future<void> -
Locks the dispatching of asynchronous events and callbacks until the
callback's future completes.
protected">@protectedinherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
performReassemble(
) → Future< void> - This method is called by reassembleApplication to actually cause the application to reassemble, e.g. after a hot reload.
-
postEvent(
String eventKind, Map< String, dynamic> eventData) → void -
All events dispatched by a BindingBase use this method instead of
calling developer.postEvent directly so that tests for BindingBase
can track which events were dispatched by overriding this method.
protected">@protectedinherited
-
readInitialLifecycleStateFromNativeWindow(
) → void -
Initializes the lifecycleState with the
dart:ui.PlatformDispatcher.initialLifecycleState.
protected">@protected
-
reassembleApplication(
) → Future< void> -
Cause the entire application to redraw, e.g. after a hot reload.
inherited
-
registerBoolServiceExtension(
{required String name, required AsyncValueGetter< bool> getter, required AsyncValueSetter<bool> setter}) → void -
Registers a service extension method with the given name (full
name "ext.flutter.name"), which takes a single argument
"enabled" which can have the value "true" or the value "false"
or can be omitted to read the current value. (Any value other
than "true" is considered equivalent to "false". Other arguments
are ignored.)
protected">@protectedinherited
-
registerNumericServiceExtension(
{required String name, required AsyncValueGetter< double> getter, required AsyncValueSetter<double> setter}) → void -
Registers a service extension method with the given name (full
name "ext.flutter.name"), which takes a single argument with the
same name as the method which, if present, must have a value
that can be parsed by double.parse, and can be omitted to read
the current value. (Other arguments are ignored.)
protected">@protectedinherited
-
registerServiceExtension(
{required String name, required ServiceExtensionCallback callback}) → void -
Registers a service extension method with the given name (full name
"ext.flutter.name").
protected">@protectedinherited
-
registerSignalServiceExtension(
{required String name, required AsyncCallback callback}) → void -
Registers a service extension method with the given name (full
name "ext.flutter.name"), which takes no arguments and returns
no value.
protected">@protectedinherited
-
registerStringServiceExtension(
{required String name, required AsyncValueGetter< String> getter, required AsyncValueSetter<String> setter}) → void -
Registers a service extension method with the given name (full name
"ext.flutter.name"), which optionally takes a single argument with the
name "value". If the argument is omitted, the value is to be read,
otherwise it is to be set. Returns the current value.
protected">@protectedinherited
-
removeTimingsCallback(
TimingsCallback callback) → void -
Removes a callback that was earlier added by addTimingsCallback.
inherited
-
resetEpoch(
) → void -
Prepares the scheduler for a non-monotonic change to how time stamps are
calculated.
inherited
-
scheduleForcedFrame(
) → void -
Schedules a new frame by calling
dart:ui.PlatformDispatcher.scheduleFrame.
inherited
-
scheduleFrame(
) → void -
If necessary, schedules a new frame by calling
dart:ui.PlatformDispatcher.scheduleFrame.
inherited
-
scheduleFrameCallback(
FrameCallback callback, {bool rescheduling = false}) → int -
Schedules the given transient frame callback.
inherited
-
scheduleTask<
T> (TaskCallback< T> task, Priority priority, {String? debugLabel, Flow? flow}) → Future<T> -
Schedules the given
task
with the givenpriority
and returns a Future that completes to thetask
's eventual return value.inherited -
scheduleWarmUpFrame(
) → void -
Schedule a frame to run as soon as possible, rather than waiting for
the engine to request a frame in response to a system "Vsync" signal.
inherited
-
setSystemUiChangeCallback(
SystemUiChangeCallback? callback) → void -
Sets the callback for the
SystemChrome.systemUIChange
method call received on the SystemChannels.platform channel. -
toString(
) → String -
A string representation of this object.
inherited
-
unlocked(
) → void - Called by lockEvents when events get unlocked.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance → ServicesBinding
-
The current ServicesBinding, if one has been created.
read-onlyoverride