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