1// Copyright 2014 The Flutter Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5/// @docImport 'dart:ui';
6///
7/// @docImport 'binding.dart';
8/// @docImport 'debug.dart';
9/// @docImport 'platform.dart';
10library;
11
12/// Service extension constants for the foundation library.
13///
14/// These constants will be used when registering service extensions in the
15/// framework, and they will also be used by tools and services that call these
16/// service extensions.
17///
18/// The String value for each of these extension names should be accessed by
19/// calling the `.name` property on the enum value.
20enum FoundationServiceExtensions {
21 /// Name of service extension that, when called, will cause the entire
22 /// application to redraw.
23 ///
24 /// See also:
25 ///
26 /// * [BindingBase.initServiceExtensions], where the service extension is
27 /// registered.
28 reassemble,
29
30 /// Name of service extension that, when called, will terminate the Flutter
31 /// application.
32 ///
33 /// See also:
34 ///
35 /// * [BindingBase.initServiceExtensions], where the service extension is
36 /// registered.
37 exit,
38
39 /// Name of service extension that, when called, will get or set the value of
40 /// [connectedVmServiceUri].
41 ///
42 /// See also:
43 ///
44 /// * [connectedVmServiceUri], which stores the uri for the connected vm service
45 /// protocol.
46 /// * [BindingBase.initServiceExtensions], where the service extension is
47 /// registered.
48 connectedVmServiceUri,
49
50 /// Name of service extension that, when called, will get or set the value of
51 /// [activeDevToolsServerAddress].
52 ///
53 /// See also:
54 ///
55 /// * [activeDevToolsServerAddress], which stores the address for the active
56 /// DevTools server used for debugging this application.
57 /// * [BindingBase.initServiceExtensions], where the service extension is
58 /// registered.
59 activeDevToolsServerAddress,
60
61 /// Name of service extension that, when called, will change the value of
62 /// [defaultTargetPlatform], which controls which [TargetPlatform] that the
63 /// framework will execute for.
64 ///
65 /// See also:
66 ///
67 /// * [debugDefaultTargetPlatformOverride], which is the flag that this service
68 /// extension exposes.
69 /// * [BindingBase.initServiceExtensions], where the service extension is
70 /// registered.
71 platformOverride,
72
73 /// Name of service extension that, when called, will override the platform
74 /// [Brightness].
75 ///
76 /// See also:
77 ///
78 /// * [debugBrightnessOverride], which is the flag that this service
79 /// extension exposes.
80 /// * [BindingBase.initServiceExtensions], where the service extension is
81 /// registered.
82 brightnessOverride,
83}
84