services library
Platform services exposed to Flutter apps.
To use, import package:flutter/services.dart.
This library depends only on core Dart libraries and the foundation
library.
Classes
- AndroidMotionEvent
- A Dart version of Android's MotionEvent.
- AndroidPointerCoords
- Position information for an Android pointer. [...]
- AndroidPointerProperties
- Properties of an Android pointer. [...]
- AndroidViewController
- Controls an Android view. [...]
- ApplicationSwitcherDescription
- Specifies a description of the application that is pertinent to the embedder's application switcher (also known as "recent tasks") user interface. [...]
- AssetBundle
- A collection of resources used by the application. [...]
-
BasicMessageChannel<
T> - A named channel for communicating with platform plugins using asynchronous message passing. [...]
- BinaryCodec
- MessageCodec with unencoded binary messages represented using ByteData. [...]
- BinaryMessages
- Sends binary messages to and receives binary messages from platform plugins. [...]
- BinaryMessenger
- A messenger which sends binary data across the Flutter platform barrier. [...]
- BlacklistingTextInputFormatter
- A TextInputFormatter that prevents the insertion of blacklisted characters patterns. [...]
- ByteData
- A fixed-length, random-access sequence of bytes that also provides random and unaligned access to the fixed-width integers and floating point numbers represented by those bytes. [...]
- CachingAssetBundle
- An AssetBundle that permanently caches string and structured resources that have been fetched. [...]
- Clipboard
- Utility methods for interacting with the system's clipboard.
- ClipboardData
- Data stored on the system clipboard. [...]
- EventChannel
- A named channel for communicating with platform plugins using event streams. [...]
- FontLoader
- A class that enables the dynamic loading of fonts at runtime. [...]
- GLFWKeyHelper
- Helper class that uses GLFW-specific key mappings.
- HapticFeedback
- Allows access to the haptic feedback interface on the device. [...]
- JSONMessageCodec
- MessageCodec with UTF-8 encoded JSON messages. [...]
- JSONMethodCodec
- MethodCodec with UTF-8 encoded JSON method calls and result envelopes. [...]
- KeyboardKey
- A base class for all keyboard key types. [...]
- KeyHelper
- Abstract class for window-specific key mappings. [...]
- LengthLimitingTextInputFormatter
- A TextInputFormatter that prevents the insertion of more characters (currently defined as Unicode scalar values) than allowed. [...]
- LogicalKeyboardKey
- A class with static values that describe the keys that are returned from RawKeyEvent.logicalKey. [...]
-
MessageCodec<
T> - A message encoding/decoding mechanism. [...]
- MethodCall
- An command object representing the invocation of a named method.
- MethodChannel
- A named channel for communicating with platform plugins using asynchronous method calls. [...]
- MethodCodec
- A codec for method calls and enveloped results. [...]
- NetworkAssetBundle
- An AssetBundle that loads resources over the network. [...]
- OptionalMethodChannel
- A MethodChannel that ignores missing platform plugins. [...]
- PhysicalKeyboardKey
- A class with static values that describe the keys that are returned from RawKeyEvent.physicalKey. [...]
- PlatformAssetBundle
- An AssetBundle that loads resources using platform messages.
- PlatformViewController
- An interface for a controlling a single platform view. [...]
- PlatformViewsRegistry
- A registry responsible for generating unique identifier for platform views. [...]
- PlatformViewsService
- Provides access to the platform views service. [...]
- RawFloatingCursorPoint
- The current state and position of the floating cursor.
- RawKeyboard
- An interface for listening to raw key events. [...]
- RawKeyDownEvent
- The user has pressed a key on the keyboard. [...]
- RawKeyEvent
- Defines the interface for raw key events. [...]
- RawKeyEventData
- Base class for platform-specific key event data. [...]
- RawKeyEventDataAndroid
- Platform-specific key event data for Android. [...]
- RawKeyEventDataFuchsia
- Platform-specific key event data for Fuchsia. [...]
- RawKeyEventDataLinux
- Platform-specific key event data for Linux. [...]
- RawKeyEventDataMacOs
- Platform-specific key event data for macOS. [...]
- RawKeyEventDataWeb
- Platform-specific key event data for Web. [...]
- RawKeyUpEvent
- The user has released a key on the keyboard. [...]
- StandardMessageCodec
- MessageCodec using the Flutter standard binary encoding. [...]
- StandardMethodCodec
- MethodCodec using the Flutter standard binary encoding. [...]
- StringCodec
- MessageCodec with UTF-8 encoded String messages. [...]
- SystemChannels
- Platform channels used by the Flutter system.
- SystemChrome
- Controls specific aspects of the operating system's graphical interface and how it interacts with the application.
- Controls specific aspects of the system navigation stack.
- SystemSound
- Provides access to the library of short system specific sounds for common tasks.
- SystemUiOverlayStyle
- Specifies a preference for the style of the system overlays. [...]
- TextEditingValue
- The current text, selection, and composing state for editing a run of text.
- TextInput
- An interface to the system's text input control.
- TextInputClient
- An interface to receive information from TextInput. [...]
- TextInputConfiguration
- Controls the visual appearance of the text input control. [...]
- TextInputConnection
- An interface for interacting with a text input control. [...]
- TextInputFormatter
- A TextInputFormatter can be optionally injected into an EditableText to provide as-you-type validation and formatting of the text being edited. [...]
- TextInputType
- The type of information for which to optimize the text input control. [...]
- TextPosition
- A position in a string of text. [...]
- TextRange
- A range of characters in a string of text.
- TextSelection
- A range of text that represents a selection.
- TextSelectionDelegate
- An interface for manipulating the selection, to be used by the implementor of the toolbar widget.
- UiKitViewController
- Controls an iOS UIView. [...]
- WhitelistingTextInputFormatter
- A TextInputFormatter that allows only the insertion of whitelisted characters patterns. [...]
Mixins
- ServicesBinding
- Listens for platform messages and directs them to the defaultBinaryMessenger. [...]
Constants
-
kAndroidNumPadMap
→ const Map<
int, LogicalKeyboardKey> -
A map of Android key codes which have printable representations, but appear
on the number pad. Used to provide different key objects for keys like
KEY_EQUALS and NUMPAD_EQUALS.
<int, LogicalKeyboardKey>{154 : LogicalKeyboardKey.numpadDivide, 155 : LogicalKeyboardKey.numpadMultiply, 156 : LogicalKeyboardKey.numpadSubtract, 157 : LogicalKeyboardKey.numpadAdd, 145 : Logic… -
kAndroidToLogicalKey
→ const Map<
int, LogicalKeyboardKey> -
Maps Android-specific key codes to the matching LogicalKeyboardKey.
<int, LogicalKeyboardKey>{0 : LogicalKeyboardKey.none, 223 : LogicalKeyboardKey.sleep, 224 : LogicalKeyboardKey.wakeUp, 29 : LogicalKeyboardKey.keyA, 30 : LogicalKeyboardKey.keyB, 31 : LogicalKe… -
kAndroidToPhysicalKey
→ const Map<
int, PhysicalKeyboardKey> -
Maps Android-specific scan codes to the matching PhysicalKeyboardKey.
<int, PhysicalKeyboardKey>{205 : PhysicalKeyboardKey.suspend, 142 : PhysicalKeyboardKey.sleep, 143 : PhysicalKeyboardKey.wakeUp, 30 : PhysicalKeyboardKey.keyA, 48 : PhysicalKeyboardKey.keyB, 46 … -
kFuchsiaToLogicalKey
→ const Map<
int, LogicalKeyboardKey> -
Maps Fuchsia-specific IDs to the matching LogicalKeyboardKey.
<int, LogicalKeyboardKey>{0 : LogicalKeyboardKey.none, 16 : LogicalKeyboardKey.hyper, 17 : LogicalKeyboardKey.superKey, 19 : LogicalKeyboardKey.fnLock, 20 : LogicalKeyboardKey.suspend, 21 : Logi… -
kFuchsiaToPhysicalKey
→ const Map<
int, PhysicalKeyboardKey> -
Maps Fuchsia-specific USB HID Usage IDs to the matching
PhysicalKeyboardKey.
<int, PhysicalKeyboardKey>{0 : PhysicalKeyboardKey.none, 16 : PhysicalKeyboardKey.hyper, 17 : PhysicalKeyboardKey.superKey, 19 : PhysicalKeyboardKey.fnLock, 20 : PhysicalKeyboardKey.suspend, 21 … -
kGlfwNumpadMap
→ const Map<
int, LogicalKeyboardKey> -
A map of GLFW key codes which have printable representations, but appear
on the number pad. Used to provide different key objects for keys like
KEY_EQUALS and NUMPAD_EQUALS.
<int, LogicalKeyboardKey>{331 : LogicalKeyboardKey.numpadDivide, 332 : LogicalKeyboardKey.numpadMultiply, 334 : LogicalKeyboardKey.numpadAdd, 321 : LogicalKeyboardKey.numpad1, 322 : LogicalKeybo… -
kGlfwToLogicalKey
→ const Map<
int, LogicalKeyboardKey> -
Maps GLFW-specific key codes to the matching LogicalKeyboardKey.
<int, LogicalKeyboardKey>{65 : LogicalKeyboardKey.keyA, 66 : LogicalKeyboardKey.keyB, 67 : LogicalKeyboardKey.keyC, 68 : LogicalKeyboardKey.keyD, 69 : LogicalKeyboardKey.keyE, 70 : LogicalKeyboa… -
kLinuxToPhysicalKey
→ const Map<
int, PhysicalKeyboardKey> -
Maps XKB specific key code values representing PhysicalKeyboardKey.
<int, PhysicalKeyboardKey>{150 : PhysicalKeyboardKey.sleep, 151 : PhysicalKeyboardKey.wakeUp, 235 : PhysicalKeyboardKey.displayToggleIntExt, 38 : PhysicalKeyboardKey.keyA, 56 : PhysicalKeyboardK… -
kMacOsFunctionKeyMap
→ const Map<
int, LogicalKeyboardKey> -
A map of macOS key codes which are numbered function keys, so that they
can be excluded when asking "is the Fn modifier down?".
<int, LogicalKeyboardKey>{122 : LogicalKeyboardKey.f1, 120 : LogicalKeyboardKey.f2, 99 : LogicalKeyboardKey.f3, 118 : LogicalKeyboardKey.f4, 96 : LogicalKeyboardKey.f5, 97 : LogicalKeyboardKey.f… -
kMacOsNumPadMap
→ const Map<
int, LogicalKeyboardKey> -
A map of macOS key codes which have printable representations, but appear
on the number pad. Used to provide different key objects for keys like
KEY_EQUALS and NUMPAD_EQUALS.
<int, LogicalKeyboardKey>{75 : LogicalKeyboardKey.numpadDivide, 67 : LogicalKeyboardKey.numpadMultiply, 78 : LogicalKeyboardKey.numpadSubtract, 69 : LogicalKeyboardKey.numpadAdd, 83 : LogicalKey… -
kMacOsToPhysicalKey
→ const Map<
int, PhysicalKeyboardKey> -
Maps macOS-specific key code values representing PhysicalKeyboardKey. [...]
<int, PhysicalKeyboardKey>{0 : PhysicalKeyboardKey.keyA, 11 : PhysicalKeyboardKey.keyB, 8 : PhysicalKeyboardKey.keyC, 2 : PhysicalKeyboardKey.keyD, 14 : PhysicalKeyboardKey.keyE, 3 : PhysicalKey… -
kWebNumPadMap
→ const Map<
String, LogicalKeyboardKey> -
A map of Web KeyboardEvent codes which have printable representations, but appear
on the number pad. Used to provide different key objects for keys like
KEY_EQUALS and NUMPAD_EQUALS.
<String, LogicalKeyboardKey>{'NumpadDivide' : LogicalKeyboardKey.numpadDivide, 'NumpadMultiply' : LogicalKeyboardKey.numpadMultiply, 'NumpadSubtract' : LogicalKeyboardKey… -
kWebToLogicalKey
→ const Map<
String, LogicalKeyboardKey> -
Maps Web KeyboardEvent codes to the matching LogicalKeyboardKey.
<String, LogicalKeyboardKey>{'None' : LogicalKeyboardKey.none, 'Hyper' : LogicalKeyboardKey.hyper, 'Super' : LogicalKeyboardKey.superKey, 'FnLock' : LogicalKeyboa… -
kWebToPhysicalKey
→ const Map<
String, PhysicalKeyboardKey> -
Maps Web KeyboardEvent codes to the matching PhysicalKeyboardKey.
<String, PhysicalKeyboardKey>{'None' : PhysicalKeyboardKey.none, 'Hyper' : PhysicalKeyboardKey.hyper, 'Super' : PhysicalKeyboardKey.superKey, 'FnLock' : PhysicalK…
Properties
- defaultBinaryMessenger → BinaryMessenger
-
The default instance of BinaryMessenger. [...]
@Deprecated('Use ServicesBinding.instance.defaultBinaryMessenger instead. ' 'This feature was deprecated after v1.6.5.'), read-only
- platformViewsRegistry → PlatformViewsRegistry
-
The PlatformViewsRegistry responsible for generating unique identifiers for platform views.
final
- rootBundle → AssetBundle
-
The AssetBundle from which this application was loaded. [...]
final
Enums
- Brightness
- Describes the contrast of a theme or color palette.
- DeviceOrientation
- Specifies a particular device orientation. [...]
- FloatingCursorDragState
- A floating cursor state the user has induced by force pressing an iOS keyboard.
- KeyboardSide
- An enum describing the side of the keyboard that a key is on, to allow discrimination between which key is pressed (e.g. the left or right SHIFT key). [...]
- ModifierKey
- An enum describing the type of modifier key that is being pressed. [...]
- SystemSoundType
- A sound provided by the system.
- SystemUiOverlay
- Specifies a system overlay at a particular location. [...]
- TextAffinity
- A way to disambiguate a TextPosition when its offset could match two different locations in the rendered string. [...]
- TextCapitalization
- Configures how the platform keyboard will select an uppercase or lowercase keyboard. [...]
- TextInputAction
- An action the user has requested the text input control to perform. [...]
Typedefs
-
MessageHandler(
ByteData message ) → Future< ByteData> - A function which takes a platform message and asynchronously returns an encoded response.
-
PlatformViewCreatedCallback(
int id ) → void - Callback signature for when a platform view was created. [...]
-
TextInputFormatFunction(
TextEditingValue oldValue, TextEditingValue newValue ) → TextEditingValue - Function signature expected for creating custom TextInputFormatter shorthands via TextInputFormatter.withFunction;
Exceptions / Errors
- MissingPluginException
- Thrown to indicate that a platform interaction failed to find a handling plugin. [...]
- PlatformException
- Thrown to indicate that a platform interaction failed in the platform plugin. [...]