1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/*
* Copyright (C) 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.app;
import android.Manifest;
import android.annotation.NonNull;
import android.annotation.RequiresPermission;
import android.annotation.SystemApi;
import android.annotation.SystemService;
import android.annotation.TestApi;
import android.annotation.UserHandleAware;
import android.content.Context;
import android.content.res.Configuration;
import android.os.LocaleList;
import android.os.RemoteException;
/**
* This class gives access to system locale services. These services allow applications to control
* granular locale settings (such as per-app locales).
*
* <p> Third party applications should treat this as a write-side surface, and continue reading
* locales via their in-process {@link LocaleList}s.
*/
@SystemService(Context.LOCALE_SERVICE)
public class LocaleManager {
private static final String TAG = "LocaleManager";
/** Context required for getting the user for which API calls are made. */
private Context mContext;
private ILocaleManager mService;
/** @hide Instantiated by ContextImpl */
public LocaleManager(Context context, ILocaleManager service) {
mContext = context;
mService = service;
}
/**
* Sets the UI locales for the calling app.
*
* <p>Pass a {@link LocaleList#getEmptyLocaleList()} to reset to the system locale.
*
* <p><b>Note:</b> Changes to app locales will result in a configuration change (and potentially
* an Activity lifecycle event) being applied to the calling application. For more information,
* see the <a
* href="https://developer.android.com/guide/topics/resources/runtime-changes">section on
* handling configuration changes</a>. The set locales are persisted; they are backed up if the
* user has enabled Backup & Restore.
*
* <p><b>Note:</b> Users' locale preferences are passed to applications by creating a union of
* any app-specific locales and system locales, with the app-specific locales appearing first.
* Language resources are then chosen per usual (as described in the <a
* href="https://developer.android.com/guide/topics/resources/multilingual-support">section on
* locale resolution</a>).
*
* @param locales the desired locales for the calling app.
*/
@UserHandleAware
public void setApplicationLocales(@NonNull LocaleList locales) {
setApplicationLocales(mContext.getPackageName(), locales);
}
/**
* Sets the UI locales for a specified app (described by package name).
*
* <p>Pass a {@link LocaleList#getEmptyLocaleList()} to reset to the system locale.
*
* <p><b>Note:</b> Changes to app locales will result in a configuration change (and potentially
* an Activity lifecycle event) being applied to the specified application. For more
* information, see the <a
* href="https://developer.android.com/guide/topics/resources/runtime-changes">section on
* handling configuration changes</a>. The set locales are persisted; they are backed up if the
* user has enabled Backup & Restore.
*
* <p><b>Note:</b> Users' locale preferences are passed to applications by creating a union of
* any app-specific locales and system locales, with the app-specific locales appearing first.
* Language resources are then chosen per usual (as described in the <a
* href="https://developer.android.com/guide/topics/resources/multilingual-support">section on
* locale resolution</a>).
*
* @param appPackageName the package name of the app for which to set the locales.
* @param locales the desired locales for the specified app.
* @hide
*/
@SystemApi
@RequiresPermission(Manifest.permission.CHANGE_CONFIGURATION)
@UserHandleAware
public void setApplicationLocales(@NonNull String appPackageName, @NonNull LocaleList locales) {
try {
mService.setApplicationLocales(appPackageName, mContext.getUser().getIdentifier(),
locales);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Returns the UI locales for the calling app.
*
* <p>Returns a {@link LocaleList#getEmptyLocaleList()} if no app-specific locales are set.
*/
@UserHandleAware
@NonNull
public LocaleList getApplicationLocales() {
return getApplicationLocales(mContext.getPackageName());
}
/**
* Returns the current UI locales for a specified app (described by package name).
*
* <p>Returns a {@link LocaleList#getEmptyLocaleList()} if no app-specific locales are set.
*
* <p>This API can be used by an app's installer
* (per {@link android.content.pm.InstallSourceInfo#getInstallingPackageName}) to retrieve
* the app's locales.
* All other cases require {@code android.Manifest.permission#READ_APP_SPECIFIC_LOCALES}.
* Apps should generally retrieve their own locales via their in-process LocaleLists,
* or by calling {@link #getApplicationLocales()}.
*
* @param appPackageName the package name of the app for which to retrieve the locales.
*/
@RequiresPermission(value = Manifest.permission.READ_APP_SPECIFIC_LOCALES, conditional = true)
@UserHandleAware
@NonNull
public LocaleList getApplicationLocales(@NonNull String appPackageName) {
try {
return mService.getApplicationLocales(appPackageName, mContext.getUser()
.getIdentifier());
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Returns the current system locales, ignoring app-specific overrides.
*
* <p><b>Note:</b> Apps should generally access the user's locale preferences as indicated in
* their in-process {@link LocaleList}s. However, in case an app-specific locale is set, this
* method helps cater to rare use-cases which might require specifically knowing the system
* locale.
*
* <p><b>Note:</b> This API is not user-aware. It returns the system locales for the foreground
* user.
*/
@NonNull
public LocaleList getSystemLocales() {
try {
return mService.getSystemLocales();
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
/**
* Sets the current system locales to the provided value.
*
* @hide
*/
@TestApi
public void setSystemLocales(@NonNull LocaleList locales) {
try {
Configuration conf = new Configuration();
conf.setLocales(locales);
ActivityManager.getService().updatePersistentConfiguration(conf);
} catch (RemoteException e) {
throw e.rethrowFromSystemServer();
}
}
}
|
