@cap-kit/settings 8.0.0-next.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CapKitSettings.podspec +17 -0
- package/LICENSE +21 -0
- package/Package.swift +29 -0
- package/README.md +428 -0
- package/android/build.gradle +103 -0
- package/android/src/main/AndroidManifest.xml +2 -0
- package/android/src/main/java/io/capkit/settings/SettingsConfig.kt +39 -0
- package/android/src/main/java/io/capkit/settings/SettingsImpl.kt +95 -0
- package/android/src/main/java/io/capkit/settings/SettingsPlugin.kt +91 -0
- package/android/src/main/java/io/capkit/settings/utils/SettingsLogger.kt +85 -0
- package/android/src/main/java/io/capkit/settings/utils/SettingsUtils.kt +75 -0
- package/android/src/main/res/.gitkeep +0 -0
- package/dist/docs.json +877 -0
- package/dist/esm/definitions.d.ts +686 -0
- package/dist/esm/definitions.js +423 -0
- package/dist/esm/definitions.js.map +1 -0
- package/dist/esm/index.d.ts +16 -0
- package/dist/esm/index.js +19 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/web.d.ts +43 -0
- package/dist/esm/web.js +68 -0
- package/dist/esm/web.js.map +1 -0
- package/dist/plugin.cjs.js +516 -0
- package/dist/plugin.cjs.js.map +1 -0
- package/dist/plugin.js +519 -0
- package/dist/plugin.js.map +1 -0
- package/ios/Sources/SettingsPlugin/SettingsConfig.swift +54 -0
- package/ios/Sources/SettingsPlugin/SettingsImpl.swift +84 -0
- package/ios/Sources/SettingsPlugin/SettingsPlugin.swift +103 -0
- package/ios/Sources/SettingsPlugin/Utils/SettingsLogger.swift +57 -0
- package/ios/Sources/SettingsPlugin/Utils/SettingsUtils.swift +70 -0
- package/ios/Sources/SettingsPlugin/Version.swift +16 -0
- package/ios/Tests/SettingsPluginTests/SettingsPluginTests.swift +21 -0
- package/package.json +98 -0
package/dist/docs.json
ADDED
|
@@ -0,0 +1,877 @@
|
|
|
1
|
+
{
|
|
2
|
+
"api": {
|
|
3
|
+
"name": "SettingsPlugin",
|
|
4
|
+
"slug": "settingsplugin",
|
|
5
|
+
"docs": "Public JavaScript API for the Settings Capacitor plugin.\n\nThis plugin uses a state-based result model:\n- operations never throw\n- Promise rejection is not used\n- failures are reported via `{ success, error?, code? }`\n\nThis design ensures consistent behavior across Android, iOS, and Web.",
|
|
6
|
+
"tags": [],
|
|
7
|
+
"methods": [
|
|
8
|
+
{
|
|
9
|
+
"name": "open",
|
|
10
|
+
"signature": "(options: PlatformOptions) => Promise<SettingsResult>",
|
|
11
|
+
"parameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "options",
|
|
14
|
+
"docs": "Platform-specific settings options.",
|
|
15
|
+
"type": "PlatformOptions"
|
|
16
|
+
}
|
|
17
|
+
],
|
|
18
|
+
"returns": "Promise<SettingsResult>",
|
|
19
|
+
"tags": [
|
|
20
|
+
{
|
|
21
|
+
"name": "param",
|
|
22
|
+
"text": "options Platform-specific settings options."
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"name": "returns",
|
|
26
|
+
"text": "A promise resolving to the operation result."
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
"name": "since",
|
|
30
|
+
"text": "1.0.0"
|
|
31
|
+
}
|
|
32
|
+
],
|
|
33
|
+
"docs": "Opens the specified settings option on the current platform.\nOn Web, this method is not supported.",
|
|
34
|
+
"complexTypes": [
|
|
35
|
+
"SettingsResult",
|
|
36
|
+
"PlatformOptions"
|
|
37
|
+
],
|
|
38
|
+
"slug": "open"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"name": "openIOS",
|
|
42
|
+
"signature": "(options: IOSOptions) => Promise<SettingsResult>",
|
|
43
|
+
"parameters": [
|
|
44
|
+
{
|
|
45
|
+
"name": "options",
|
|
46
|
+
"docs": "iOS settings options.",
|
|
47
|
+
"type": "IOSOptions"
|
|
48
|
+
}
|
|
49
|
+
],
|
|
50
|
+
"returns": "Promise<SettingsResult>",
|
|
51
|
+
"tags": [
|
|
52
|
+
{
|
|
53
|
+
"name": "platforms",
|
|
54
|
+
"text": "iOS"
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "remarks",
|
|
58
|
+
"text": "Apple officially supports opening only the app-specific settings screen.\nOther settings destinations rely on undocumented URL schemes and may:\n- behave differently across iOS versions\n- stop working in future releases\n- be restricted during App Store review\n\nWhen unavailable, the method resolves with:\n`{ success: false, code: SettingsErrorCode.UNAVAILABLE }`."
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
"name": "param",
|
|
62
|
+
"text": "options iOS settings options."
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "returns",
|
|
66
|
+
"text": "A promise resolving to the operation result."
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"name": "since",
|
|
70
|
+
"text": "1.0.0"
|
|
71
|
+
}
|
|
72
|
+
],
|
|
73
|
+
"docs": "Opens a specific system settings section. (iOS Only)",
|
|
74
|
+
"complexTypes": [
|
|
75
|
+
"SettingsResult",
|
|
76
|
+
"IOSOptions"
|
|
77
|
+
],
|
|
78
|
+
"slug": "openios"
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"name": "openAndroid",
|
|
82
|
+
"signature": "(options: AndroidOptions) => Promise<SettingsResult>",
|
|
83
|
+
"parameters": [
|
|
84
|
+
{
|
|
85
|
+
"name": "options",
|
|
86
|
+
"docs": "Android settings options.",
|
|
87
|
+
"type": "AndroidOptions"
|
|
88
|
+
}
|
|
89
|
+
],
|
|
90
|
+
"returns": "Promise<SettingsResult>",
|
|
91
|
+
"tags": [
|
|
92
|
+
{
|
|
93
|
+
"name": "platforms",
|
|
94
|
+
"text": "Android"
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
"name": "param",
|
|
98
|
+
"text": "options Android settings options."
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"name": "returns",
|
|
102
|
+
"text": "A promise resolving to the operation result."
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"name": "since",
|
|
106
|
+
"text": "1.0.0"
|
|
107
|
+
}
|
|
108
|
+
],
|
|
109
|
+
"docs": "Opens a specific Android Intent. (Android Only)\nOn Web, this method is not supported.",
|
|
110
|
+
"complexTypes": [
|
|
111
|
+
"SettingsResult",
|
|
112
|
+
"AndroidOptions"
|
|
113
|
+
],
|
|
114
|
+
"slug": "openandroid"
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"name": "getPluginVersion",
|
|
118
|
+
"signature": "() => Promise<PluginVersionResult>",
|
|
119
|
+
"parameters": [],
|
|
120
|
+
"returns": "Promise<PluginVersionResult>",
|
|
121
|
+
"tags": [
|
|
122
|
+
{
|
|
123
|
+
"name": "returns",
|
|
124
|
+
"text": "A promise resolving to the plugin version."
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
"name": "example",
|
|
128
|
+
"text": "```ts\nconst { version } = await Settings.getPluginVersion();\n```"
|
|
129
|
+
},
|
|
130
|
+
{
|
|
131
|
+
"name": "since",
|
|
132
|
+
"text": "1.0.0"
|
|
133
|
+
}
|
|
134
|
+
],
|
|
135
|
+
"docs": "Returns the native plugin version.\n\nThe returned version corresponds to the native implementation\nbundled with the application.",
|
|
136
|
+
"complexTypes": [
|
|
137
|
+
"PluginVersionResult"
|
|
138
|
+
],
|
|
139
|
+
"slug": "getpluginversion"
|
|
140
|
+
}
|
|
141
|
+
],
|
|
142
|
+
"properties": []
|
|
143
|
+
},
|
|
144
|
+
"interfaces": [
|
|
145
|
+
{
|
|
146
|
+
"name": "SettingsResult",
|
|
147
|
+
"slug": "settingsresult",
|
|
148
|
+
"docs": "Response object for settings open operations.\n\nAll platforms return a state-based result object.\nPromise rejection is NOT used.",
|
|
149
|
+
"tags": [],
|
|
150
|
+
"methods": [],
|
|
151
|
+
"properties": [
|
|
152
|
+
{
|
|
153
|
+
"name": "success",
|
|
154
|
+
"tags": [],
|
|
155
|
+
"docs": "Indicates if the operation was successful.",
|
|
156
|
+
"complexTypes": [],
|
|
157
|
+
"type": "boolean"
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"name": "error",
|
|
161
|
+
"tags": [],
|
|
162
|
+
"docs": "Human-readable error message, if the operation failed.",
|
|
163
|
+
"complexTypes": [],
|
|
164
|
+
"type": "string | undefined"
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"name": "code",
|
|
168
|
+
"tags": [
|
|
169
|
+
{
|
|
170
|
+
"text": "SettingsErrorCode.UNAVAILABLE",
|
|
171
|
+
"name": "example"
|
|
172
|
+
}
|
|
173
|
+
],
|
|
174
|
+
"docs": "Machine-readable error code.\n\nThis field is present when `success` is false and allows\nprogrammatic handling of platform limitations or failures.",
|
|
175
|
+
"complexTypes": [
|
|
176
|
+
"SettingsErrorCode"
|
|
177
|
+
],
|
|
178
|
+
"type": "SettingsErrorCode"
|
|
179
|
+
}
|
|
180
|
+
]
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"name": "PlatformOptions",
|
|
184
|
+
"slug": "platformoptions",
|
|
185
|
+
"docs": "Platform-specific options for opening system settings.\n\nThis interface allows specifying settings options for both\nAndroid and iOS in a single call.",
|
|
186
|
+
"tags": [
|
|
187
|
+
{
|
|
188
|
+
"text": "The plugin will use the option corresponding to the\ncurrent runtime platform.\n\nUnsupported or unavailable options on the current platform\nwill result in a resolved response with:\n`{ success: false, code: SettingsErrorCode.UNAVAILABLE }`\n\nAvailability and behavior depend on platform-specific\nsystem capabilities and restrictions.",
|
|
189
|
+
"name": "remarks"
|
|
190
|
+
}
|
|
191
|
+
],
|
|
192
|
+
"methods": [],
|
|
193
|
+
"properties": [
|
|
194
|
+
{
|
|
195
|
+
"name": "optionAndroid",
|
|
196
|
+
"tags": [],
|
|
197
|
+
"docs": "Android settings option to open.\n\nUsed only when running on Android.\nMapped internally to a system Intent.",
|
|
198
|
+
"complexTypes": [
|
|
199
|
+
"AndroidSettings"
|
|
200
|
+
],
|
|
201
|
+
"type": "AndroidSettings"
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
"name": "optionIOS",
|
|
205
|
+
"tags": [],
|
|
206
|
+
"docs": "iOS settings option to open.\n\nUsed only when running on iOS.\nMapped internally to an iOS settings URL scheme.",
|
|
207
|
+
"complexTypes": [
|
|
208
|
+
"IOSSettings"
|
|
209
|
+
],
|
|
210
|
+
"type": "IOSSettings"
|
|
211
|
+
}
|
|
212
|
+
]
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"name": "IOSOptions",
|
|
216
|
+
"slug": "iosoptions",
|
|
217
|
+
"docs": "iOS-specific options for opening system settings.",
|
|
218
|
+
"tags": [
|
|
219
|
+
{
|
|
220
|
+
"text": "iOS",
|
|
221
|
+
"name": "platform"
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
"text": "Apple officially supports opening only the app-specific settings screen.\nAll other settings destinations rely on undocumented URL schemes and may:\n\n- behave differently across iOS versions\n- stop working in future iOS releases\n- be restricted or rejected during App Store review\n\nFor unsupported or unavailable settings, the plugin resolves with:\n`{ success: false, code: SettingsErrorCode.UNAVAILABLE }`\n\nThis interface does NOT guarantee that a given settings screen\nwill open successfully on all devices.",
|
|
225
|
+
"name": "remarks"
|
|
226
|
+
}
|
|
227
|
+
],
|
|
228
|
+
"methods": [],
|
|
229
|
+
"properties": [
|
|
230
|
+
{
|
|
231
|
+
"name": "option",
|
|
232
|
+
"tags": [
|
|
233
|
+
{
|
|
234
|
+
"text": "IOSSettings.App",
|
|
235
|
+
"name": "example"
|
|
236
|
+
},
|
|
237
|
+
{
|
|
238
|
+
"text": "IOSSettings.AppNotification",
|
|
239
|
+
"name": "example"
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"text": "IOSSettings.Bluetooth",
|
|
243
|
+
"name": "example"
|
|
244
|
+
}
|
|
245
|
+
],
|
|
246
|
+
"docs": "The iOS settings section to open.\n\nMost values correspond to internal iOS URL schemes.\nAvailability depends on the iOS version and system configuration.",
|
|
247
|
+
"complexTypes": [
|
|
248
|
+
"IOSSettings"
|
|
249
|
+
],
|
|
250
|
+
"type": "IOSSettings"
|
|
251
|
+
}
|
|
252
|
+
]
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
"name": "AndroidOptions",
|
|
256
|
+
"slug": "androidoptions",
|
|
257
|
+
"docs": "Android-specific options for opening system settings.",
|
|
258
|
+
"tags": [
|
|
259
|
+
{
|
|
260
|
+
"text": "Android",
|
|
261
|
+
"name": "platform"
|
|
262
|
+
},
|
|
263
|
+
{
|
|
264
|
+
"text": "Android settings are opened via system Intents.\nAvailability and behavior depend on:\n\n- Android version\n- device manufacturer (OEM)\n- system configuration and user restrictions\n\nSome settings rely on intents that are not part of the public\nAndroid SDK and may not be available on all devices.\n\nWhen a requested settings screen cannot be resolved, the plugin\nresolves with:\n`{ success: false, code: SettingsErrorCode.UNAVAILABLE }`\n\nThis interface does NOT guarantee that a given settings screen\nwill open successfully on all devices.",
|
|
265
|
+
"name": "remarks"
|
|
266
|
+
}
|
|
267
|
+
],
|
|
268
|
+
"methods": [],
|
|
269
|
+
"properties": [
|
|
270
|
+
{
|
|
271
|
+
"name": "option",
|
|
272
|
+
"tags": [
|
|
273
|
+
{
|
|
274
|
+
"text": "AndroidSettings.Wifi",
|
|
275
|
+
"name": "example"
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
"text": "AndroidSettings.Bluetooth",
|
|
279
|
+
"name": "example"
|
|
280
|
+
},
|
|
281
|
+
{
|
|
282
|
+
"text": "AndroidSettings.ApplicationDetails",
|
|
283
|
+
"name": "example"
|
|
284
|
+
}
|
|
285
|
+
],
|
|
286
|
+
"docs": "The Android settings section to open.\n\nEach value maps to a specific Android system Intent.\nSupport varies depending on the device and OS version.",
|
|
287
|
+
"complexTypes": [
|
|
288
|
+
"AndroidSettings"
|
|
289
|
+
],
|
|
290
|
+
"type": "AndroidSettings"
|
|
291
|
+
}
|
|
292
|
+
]
|
|
293
|
+
},
|
|
294
|
+
{
|
|
295
|
+
"name": "PluginVersionResult",
|
|
296
|
+
"slug": "pluginversionresult",
|
|
297
|
+
"docs": "Result object returned by the `getPluginVersion()` method.",
|
|
298
|
+
"tags": [],
|
|
299
|
+
"methods": [],
|
|
300
|
+
"properties": [
|
|
301
|
+
{
|
|
302
|
+
"name": "version",
|
|
303
|
+
"tags": [],
|
|
304
|
+
"docs": "The native plugin version string.",
|
|
305
|
+
"complexTypes": [],
|
|
306
|
+
"type": "string"
|
|
307
|
+
}
|
|
308
|
+
]
|
|
309
|
+
}
|
|
310
|
+
],
|
|
311
|
+
"enums": [
|
|
312
|
+
{
|
|
313
|
+
"name": "SettingsErrorCode",
|
|
314
|
+
"slug": "settingserrorcode",
|
|
315
|
+
"members": [
|
|
316
|
+
{
|
|
317
|
+
"name": "UNAVAILABLE",
|
|
318
|
+
"value": "'UNAVAILABLE'",
|
|
319
|
+
"tags": [],
|
|
320
|
+
"docs": "The device does not have the requested hardware."
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"name": "PERMISSION_DENIED",
|
|
324
|
+
"value": "'PERMISSION_DENIED'",
|
|
325
|
+
"tags": [],
|
|
326
|
+
"docs": "The user denied the permission or the feature is disabled in settings."
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"name": "INIT_FAILED",
|
|
330
|
+
"value": "'INIT_FAILED'",
|
|
331
|
+
"tags": [],
|
|
332
|
+
"docs": "The Settings plugin failed to initialize (e.g., runtime error or Looper failure)."
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"name": "UNKNOWN_TYPE",
|
|
336
|
+
"value": "'UNKNOWN_TYPE'",
|
|
337
|
+
"tags": [],
|
|
338
|
+
"docs": "The requested Settings plugin type is not valid or not supported by the plugin."
|
|
339
|
+
}
|
|
340
|
+
]
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"name": "AndroidSettings",
|
|
344
|
+
"slug": "androidsettings",
|
|
345
|
+
"members": [
|
|
346
|
+
{
|
|
347
|
+
"name": "Accessibility",
|
|
348
|
+
"value": "'accessibility'",
|
|
349
|
+
"tags": [],
|
|
350
|
+
"docs": "Opens Accessibility settings."
|
|
351
|
+
},
|
|
352
|
+
{
|
|
353
|
+
"name": "Account",
|
|
354
|
+
"value": "'account'",
|
|
355
|
+
"tags": [],
|
|
356
|
+
"docs": "Opens the Add Account screen."
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"name": "AirplaneMode",
|
|
360
|
+
"value": "'airplane_mode'",
|
|
361
|
+
"tags": [],
|
|
362
|
+
"docs": "Opens Airplane Mode settings."
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
"name": "Apn",
|
|
366
|
+
"value": "'apn'",
|
|
367
|
+
"tags": [],
|
|
368
|
+
"docs": "Opens Access Point Name (APN) settings."
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
"name": "ApplicationDetails",
|
|
372
|
+
"value": "'application_details'",
|
|
373
|
+
"tags": [],
|
|
374
|
+
"docs": "Opens the Application Details screen for the current app."
|
|
375
|
+
},
|
|
376
|
+
{
|
|
377
|
+
"name": "ApplicationDevelopment",
|
|
378
|
+
"value": "'application_development'",
|
|
379
|
+
"tags": [],
|
|
380
|
+
"docs": "Opens Application Development settings.\n\nAvailability depends on developer options being enabled."
|
|
381
|
+
},
|
|
382
|
+
{
|
|
383
|
+
"name": "Application",
|
|
384
|
+
"value": "'application'",
|
|
385
|
+
"tags": [],
|
|
386
|
+
"docs": "Opens Application settings."
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"name": "AppNotification",
|
|
390
|
+
"value": "'app_notification'",
|
|
391
|
+
"tags": [],
|
|
392
|
+
"docs": "Opens app-specific notification settings."
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
"name": "BatteryOptimization",
|
|
396
|
+
"value": "'battery_optimization'",
|
|
397
|
+
"tags": [],
|
|
398
|
+
"docs": "Opens Battery Optimization settings.\n\nAllows managing apps excluded from battery optimizations."
|
|
399
|
+
},
|
|
400
|
+
{
|
|
401
|
+
"name": "Bluetooth",
|
|
402
|
+
"value": "'bluetooth'",
|
|
403
|
+
"tags": [],
|
|
404
|
+
"docs": "Opens Bluetooth settings."
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"name": "Captioning",
|
|
408
|
+
"value": "'captioning'",
|
|
409
|
+
"tags": [],
|
|
410
|
+
"docs": "Opens Captioning settings."
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"name": "Cast",
|
|
414
|
+
"value": "'cast'",
|
|
415
|
+
"tags": [],
|
|
416
|
+
"docs": "Opens Cast device settings."
|
|
417
|
+
},
|
|
418
|
+
{
|
|
419
|
+
"name": "DataRoaming",
|
|
420
|
+
"value": "'data_roaming'",
|
|
421
|
+
"tags": [],
|
|
422
|
+
"docs": "Opens Data Roaming settings."
|
|
423
|
+
},
|
|
424
|
+
{
|
|
425
|
+
"name": "Date",
|
|
426
|
+
"value": "'date'",
|
|
427
|
+
"tags": [],
|
|
428
|
+
"docs": "Opens Date & Time settings."
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"name": "Display",
|
|
432
|
+
"value": "'display'",
|
|
433
|
+
"tags": [],
|
|
434
|
+
"docs": "Opens Display settings."
|
|
435
|
+
},
|
|
436
|
+
{
|
|
437
|
+
"name": "Dream",
|
|
438
|
+
"value": "'dream'",
|
|
439
|
+
"tags": [],
|
|
440
|
+
"docs": "Opens Dream (Daydream / Screensaver) settings."
|
|
441
|
+
},
|
|
442
|
+
{
|
|
443
|
+
"name": "Home",
|
|
444
|
+
"value": "'home'",
|
|
445
|
+
"tags": [],
|
|
446
|
+
"docs": "Opens Home app selection settings."
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
"name": "Keyboard",
|
|
450
|
+
"value": "'keyboard'",
|
|
451
|
+
"tags": [],
|
|
452
|
+
"docs": "Opens Input Method (Keyboard) settings."
|
|
453
|
+
},
|
|
454
|
+
{
|
|
455
|
+
"name": "KeyboardSubType",
|
|
456
|
+
"value": "'keyboard_subtype'",
|
|
457
|
+
"tags": [],
|
|
458
|
+
"docs": "Opens Input Method Subtype settings."
|
|
459
|
+
},
|
|
460
|
+
{
|
|
461
|
+
"name": "Locale",
|
|
462
|
+
"value": "'locale'",
|
|
463
|
+
"tags": [],
|
|
464
|
+
"docs": "Opens Language & Input (Locale) settings."
|
|
465
|
+
},
|
|
466
|
+
{
|
|
467
|
+
"name": "Location",
|
|
468
|
+
"value": "'location'",
|
|
469
|
+
"tags": [],
|
|
470
|
+
"docs": "Opens Location Services settings."
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"name": "ManageApplications",
|
|
474
|
+
"value": "'manage_applications'",
|
|
475
|
+
"tags": [],
|
|
476
|
+
"docs": "Opens Manage Applications settings."
|
|
477
|
+
},
|
|
478
|
+
{
|
|
479
|
+
"name": "ManageAllApplications",
|
|
480
|
+
"value": "'manage_all_applications'",
|
|
481
|
+
"tags": [],
|
|
482
|
+
"docs": "Opens Manage All Applications settings.\n\nAvailability depends on Android version and OEM."
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
"name": "MemoryCard",
|
|
486
|
+
"value": "'memory_card'",
|
|
487
|
+
"tags": [],
|
|
488
|
+
"docs": "Show settings for memory card storage"
|
|
489
|
+
},
|
|
490
|
+
{
|
|
491
|
+
"name": "Network",
|
|
492
|
+
"value": "'network'",
|
|
493
|
+
"tags": [],
|
|
494
|
+
"docs": "Opens Network Operator settings."
|
|
495
|
+
},
|
|
496
|
+
{
|
|
497
|
+
"name": "Nfc",
|
|
498
|
+
"value": "'nfc'",
|
|
499
|
+
"tags": [],
|
|
500
|
+
"docs": "Opens NFC settings."
|
|
501
|
+
},
|
|
502
|
+
{
|
|
503
|
+
"name": "NfcSharing",
|
|
504
|
+
"value": "'nfcsharing'",
|
|
505
|
+
"tags": [],
|
|
506
|
+
"docs": "Opens NFC Sharing settings."
|
|
507
|
+
},
|
|
508
|
+
{
|
|
509
|
+
"name": "NfcPayment",
|
|
510
|
+
"value": "'nfc_payment'",
|
|
511
|
+
"tags": [],
|
|
512
|
+
"docs": "Opens NFC Payment settings."
|
|
513
|
+
},
|
|
514
|
+
{
|
|
515
|
+
"name": "Print",
|
|
516
|
+
"value": "'print'",
|
|
517
|
+
"tags": [],
|
|
518
|
+
"docs": "Opens Print settings."
|
|
519
|
+
},
|
|
520
|
+
{
|
|
521
|
+
"name": "Privacy",
|
|
522
|
+
"value": "'privacy'",
|
|
523
|
+
"tags": [],
|
|
524
|
+
"docs": "Opens Privacy settings."
|
|
525
|
+
},
|
|
526
|
+
{
|
|
527
|
+
"name": "QuickLaunch",
|
|
528
|
+
"value": "'quick_launch'",
|
|
529
|
+
"tags": [],
|
|
530
|
+
"docs": "Opens Quick Launch settings."
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
"name": "Search",
|
|
534
|
+
"value": "'search'",
|
|
535
|
+
"tags": [],
|
|
536
|
+
"docs": "Opens Search settings."
|
|
537
|
+
},
|
|
538
|
+
{
|
|
539
|
+
"name": "Security",
|
|
540
|
+
"value": "'security'",
|
|
541
|
+
"tags": [],
|
|
542
|
+
"docs": "Opens Security settings."
|
|
543
|
+
},
|
|
544
|
+
{
|
|
545
|
+
"name": "Settings",
|
|
546
|
+
"value": "'settings'",
|
|
547
|
+
"tags": [],
|
|
548
|
+
"docs": "Opens the main System Settings screen."
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
"name": "ShowRegulatoryInfo",
|
|
552
|
+
"value": "'show_regulatory_info'",
|
|
553
|
+
"tags": [],
|
|
554
|
+
"docs": "Opens Regulatory Information screen."
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
"name": "Sound",
|
|
558
|
+
"value": "'sound'",
|
|
559
|
+
"tags": [],
|
|
560
|
+
"docs": "Opens Sound & Volume settings."
|
|
561
|
+
},
|
|
562
|
+
{
|
|
563
|
+
"name": "Storage",
|
|
564
|
+
"value": "'storage'",
|
|
565
|
+
"tags": [],
|
|
566
|
+
"docs": "Opens Internal Storage settings."
|
|
567
|
+
},
|
|
568
|
+
{
|
|
569
|
+
"name": "Sync",
|
|
570
|
+
"value": "'sync'",
|
|
571
|
+
"tags": [],
|
|
572
|
+
"docs": "Opens Sync settings."
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
"name": "TextToSpeech",
|
|
576
|
+
"value": "'text_to_speech'",
|
|
577
|
+
"tags": [],
|
|
578
|
+
"docs": "Opens Text-to-Speech (TTS) settings.\n\nUses a non-public intent on some devices."
|
|
579
|
+
},
|
|
580
|
+
{
|
|
581
|
+
"name": "Usage",
|
|
582
|
+
"value": "'usage'",
|
|
583
|
+
"tags": [],
|
|
584
|
+
"docs": "Opens Usage Access settings.\n\nAllows managing apps with access to usage data."
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
"name": "UserDictionary",
|
|
588
|
+
"value": "'user_dictionary'",
|
|
589
|
+
"tags": [],
|
|
590
|
+
"docs": "Opens User Dictionary settings."
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
"name": "VoiceInput",
|
|
594
|
+
"value": "'voice_input'",
|
|
595
|
+
"tags": [],
|
|
596
|
+
"docs": "Opens Voice Input settings."
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
"name": "VPN",
|
|
600
|
+
"value": "'vpn'",
|
|
601
|
+
"tags": [],
|
|
602
|
+
"docs": "Opens VPN settings."
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
"name": "Wifi",
|
|
606
|
+
"value": "'wifi'",
|
|
607
|
+
"tags": [],
|
|
608
|
+
"docs": "Opens Wi-Fi settings."
|
|
609
|
+
},
|
|
610
|
+
{
|
|
611
|
+
"name": "WifiIp",
|
|
612
|
+
"value": "'wifi_ip'",
|
|
613
|
+
"tags": [],
|
|
614
|
+
"docs": "Opens Wi-Fi IP settings.\n\nAvailability varies by device and Android version."
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"name": "Wireless",
|
|
618
|
+
"value": "'wireless'",
|
|
619
|
+
"tags": [],
|
|
620
|
+
"docs": "Opens Wireless & Networks settings."
|
|
621
|
+
},
|
|
622
|
+
{
|
|
623
|
+
"name": "ZenMode",
|
|
624
|
+
"value": "'zen_mode'",
|
|
625
|
+
"tags": [],
|
|
626
|
+
"docs": "Opens Zen Mode (Do Not Disturb) settings.\n\nThis uses a non-public intent and may not work on all devices."
|
|
627
|
+
},
|
|
628
|
+
{
|
|
629
|
+
"name": "ZenModePriority",
|
|
630
|
+
"value": "'zen_mode_priority'",
|
|
631
|
+
"tags": [],
|
|
632
|
+
"docs": "Opens Zen Mode Priority settings."
|
|
633
|
+
},
|
|
634
|
+
{
|
|
635
|
+
"name": "ZenModeBlockedEffects",
|
|
636
|
+
"value": "'zen_mode_blocked_effects'",
|
|
637
|
+
"tags": [],
|
|
638
|
+
"docs": "Opens Zen Mode Blocked Effects settings."
|
|
639
|
+
}
|
|
640
|
+
]
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
"name": "IOSSettings",
|
|
644
|
+
"slug": "iossettings",
|
|
645
|
+
"members": [
|
|
646
|
+
{
|
|
647
|
+
"name": "App",
|
|
648
|
+
"value": "'app'",
|
|
649
|
+
"tags": [],
|
|
650
|
+
"docs": "Opens the app-specific settings screen.\n\nThis is the ONLY settings destination officially supported by Apple\nand is considered App Store safe."
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
"name": "AppNotification",
|
|
654
|
+
"value": "'appNotification'",
|
|
655
|
+
"tags": [],
|
|
656
|
+
"docs": "Opens the app-specific notification settings.\n\n- iOS 16+: opens the dedicated notification settings screen\n- iOS <16: falls back to the app settings screen"
|
|
657
|
+
},
|
|
658
|
+
{
|
|
659
|
+
"name": "About",
|
|
660
|
+
"value": "'about'",
|
|
661
|
+
"tags": [],
|
|
662
|
+
"docs": "Opens iOS \"About\" settings."
|
|
663
|
+
},
|
|
664
|
+
{
|
|
665
|
+
"name": "AutoLock",
|
|
666
|
+
"value": "'autoLock'",
|
|
667
|
+
"tags": [],
|
|
668
|
+
"docs": "Opens Auto-Lock settings."
|
|
669
|
+
},
|
|
670
|
+
{
|
|
671
|
+
"name": "Bluetooth",
|
|
672
|
+
"value": "'bluetooth'",
|
|
673
|
+
"tags": [],
|
|
674
|
+
"docs": "Opens Bluetooth settings."
|
|
675
|
+
},
|
|
676
|
+
{
|
|
677
|
+
"name": "DateTime",
|
|
678
|
+
"value": "'dateTime'",
|
|
679
|
+
"tags": [],
|
|
680
|
+
"docs": "Opens Date & Time settings."
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"name": "FaceTime",
|
|
684
|
+
"value": "'facetime'",
|
|
685
|
+
"tags": [],
|
|
686
|
+
"docs": "Opens FaceTime settings."
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"name": "General",
|
|
690
|
+
"value": "'general'",
|
|
691
|
+
"tags": [],
|
|
692
|
+
"docs": "Opens General settings."
|
|
693
|
+
},
|
|
694
|
+
{
|
|
695
|
+
"name": "Keyboard",
|
|
696
|
+
"value": "'keyboard'",
|
|
697
|
+
"tags": [],
|
|
698
|
+
"docs": "Opens Keyboard settings."
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
"name": "ICloud",
|
|
702
|
+
"value": "'iCloud'",
|
|
703
|
+
"tags": [],
|
|
704
|
+
"docs": "Opens iCloud settings."
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
"name": "ICloudStorageBackup",
|
|
708
|
+
"value": "'iCloudStorageBackup'",
|
|
709
|
+
"tags": [],
|
|
710
|
+
"docs": "Opens iCloud Storage & Backup settings."
|
|
711
|
+
},
|
|
712
|
+
{
|
|
713
|
+
"name": "International",
|
|
714
|
+
"value": "'international'",
|
|
715
|
+
"tags": [],
|
|
716
|
+
"docs": "Opens Language & Region (International) settings."
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
"name": "LocationServices",
|
|
720
|
+
"value": "'locationServices'",
|
|
721
|
+
"tags": [],
|
|
722
|
+
"docs": "Opens Location Services settings."
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
"name": "Music",
|
|
726
|
+
"value": "'music'",
|
|
727
|
+
"tags": [],
|
|
728
|
+
"docs": "Opens Music settings."
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
"name": "Notes",
|
|
732
|
+
"value": "'notes'",
|
|
733
|
+
"tags": [],
|
|
734
|
+
"docs": "Opens Notes settings."
|
|
735
|
+
},
|
|
736
|
+
{
|
|
737
|
+
"name": "Notifications",
|
|
738
|
+
"value": "'notifications'",
|
|
739
|
+
"tags": [],
|
|
740
|
+
"docs": "Opens Notifications settings.\n\nNote: this is the global notifications screen,\nnot app-specific notifications."
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
"name": "Phone",
|
|
744
|
+
"value": "'phone'",
|
|
745
|
+
"tags": [],
|
|
746
|
+
"docs": "Opens Phone settings."
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
"name": "Photos",
|
|
750
|
+
"value": "'photos'",
|
|
751
|
+
"tags": [],
|
|
752
|
+
"docs": "Opens Photos settings."
|
|
753
|
+
},
|
|
754
|
+
{
|
|
755
|
+
"name": "ManagedConfigurationList",
|
|
756
|
+
"value": "'managedConfigurationList'",
|
|
757
|
+
"tags": [],
|
|
758
|
+
"docs": "Opens Managed Configuration profiles list."
|
|
759
|
+
},
|
|
760
|
+
{
|
|
761
|
+
"name": "Reset",
|
|
762
|
+
"value": "'reset'",
|
|
763
|
+
"tags": [],
|
|
764
|
+
"docs": "Opens Reset settings."
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
"name": "Ringtone",
|
|
768
|
+
"value": "'ringtone'",
|
|
769
|
+
"tags": [],
|
|
770
|
+
"docs": "Opens Ringtone settings."
|
|
771
|
+
},
|
|
772
|
+
{
|
|
773
|
+
"name": "Sounds",
|
|
774
|
+
"value": "'sounds'",
|
|
775
|
+
"tags": [],
|
|
776
|
+
"docs": "Opens Sounds settings."
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"name": "SoftwareUpdate",
|
|
780
|
+
"value": "'softwareUpdate'",
|
|
781
|
+
"tags": [],
|
|
782
|
+
"docs": "Opens Software Update settings."
|
|
783
|
+
},
|
|
784
|
+
{
|
|
785
|
+
"name": "Store",
|
|
786
|
+
"value": "'store'",
|
|
787
|
+
"tags": [],
|
|
788
|
+
"docs": "Opens App Store settings."
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
"name": "Tracking",
|
|
792
|
+
"value": "'tracking'",
|
|
793
|
+
"tags": [],
|
|
794
|
+
"docs": "Opens App Tracking Transparency settings.\n\nAvailable on iOS 14+."
|
|
795
|
+
},
|
|
796
|
+
{
|
|
797
|
+
"name": "Wallpaper",
|
|
798
|
+
"value": "'wallpaper'",
|
|
799
|
+
"tags": [],
|
|
800
|
+
"docs": "Opens Wallpaper settings."
|
|
801
|
+
},
|
|
802
|
+
{
|
|
803
|
+
"name": "WiFi",
|
|
804
|
+
"value": "'wifi'",
|
|
805
|
+
"tags": [],
|
|
806
|
+
"docs": "Opens Wi-Fi settings."
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"name": "Tethering",
|
|
810
|
+
"value": "'tethering'",
|
|
811
|
+
"tags": [],
|
|
812
|
+
"docs": "Opens Personal Hotspot (Tethering) settings."
|
|
813
|
+
},
|
|
814
|
+
{
|
|
815
|
+
"name": "DoNotDisturb",
|
|
816
|
+
"value": "'doNotDisturb'",
|
|
817
|
+
"tags": [],
|
|
818
|
+
"docs": "Opens Do Not Disturb settings."
|
|
819
|
+
},
|
|
820
|
+
{
|
|
821
|
+
"name": "TouchIdPasscode",
|
|
822
|
+
"value": "'touchIdPasscode'",
|
|
823
|
+
"tags": [],
|
|
824
|
+
"docs": "Opens Touch ID / Passcode settings."
|
|
825
|
+
},
|
|
826
|
+
{
|
|
827
|
+
"name": "ScreenTime",
|
|
828
|
+
"value": "'screenTime'",
|
|
829
|
+
"tags": [],
|
|
830
|
+
"docs": "Opens Screen Time settings."
|
|
831
|
+
},
|
|
832
|
+
{
|
|
833
|
+
"name": "Accessibility",
|
|
834
|
+
"value": "'accessibility'",
|
|
835
|
+
"tags": [],
|
|
836
|
+
"docs": "Opens Accessibility settings."
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"name": "VPN",
|
|
840
|
+
"value": "'vpn'",
|
|
841
|
+
"tags": [],
|
|
842
|
+
"docs": "Opens VPN settings."
|
|
843
|
+
}
|
|
844
|
+
]
|
|
845
|
+
}
|
|
846
|
+
],
|
|
847
|
+
"typeAliases": [],
|
|
848
|
+
"pluginConfigs": [
|
|
849
|
+
{
|
|
850
|
+
"name": "Settings",
|
|
851
|
+
"slug": "settings",
|
|
852
|
+
"properties": [
|
|
853
|
+
{
|
|
854
|
+
"name": "verboseLogging",
|
|
855
|
+
"tags": [
|
|
856
|
+
{
|
|
857
|
+
"text": "false",
|
|
858
|
+
"name": "default"
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"text": "true",
|
|
862
|
+
"name": "example"
|
|
863
|
+
},
|
|
864
|
+
{
|
|
865
|
+
"text": "1.0.0",
|
|
866
|
+
"name": "since"
|
|
867
|
+
}
|
|
868
|
+
],
|
|
869
|
+
"docs": "Enables verbose native logging.\n\nWhen enabled, additional debug information is printed\nto the native console (Logcat on Android, Xcode on iOS).\n\nThis option affects native logging behavior only and\nhas no impact on the JavaScript API.",
|
|
870
|
+
"complexTypes": [],
|
|
871
|
+
"type": "boolean | undefined"
|
|
872
|
+
}
|
|
873
|
+
],
|
|
874
|
+
"docs": "Configuration options for the Settings plugin."
|
|
875
|
+
}
|
|
876
|
+
]
|
|
877
|
+
}
|