App Settings

https://github.com/spencerccf/app_settings
Admin
A Flutter plugin that allows opening iOS and Android phone settings, including specific pages like...
Tokens:32,639
Snippets:190
Trust Score:6.6
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Usage example for opening NFC panel

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_method_channel.md

An example of how to call openAppSettingsPanel to open the NFC settings panel, including error handling for unsupported platforms.

```dart
import 'package:app_settings/app_settings.dart';
import 'package:flutter/services.dart';

Future<void> openNfcPanel() async {
  try {
    await AppSettings.openAppSettingsPanel(AppSettingsPanelType.nfc);
  } on MissingPluginException {
    // Not supported on this platform.
  }
}
```

--------------------------------

### Open volume settings panel with AppSettings.openAppSettingsPanel

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

Basic usage example: opens the volume settings panel on Android Q+ by calling AppSettings.openAppSettingsPanel with AppSettingsPanelType.volume. The method returns a Future<void> that completes normally even if the panel is silently skipped (SDK < Q or no Activity attached).

```dart
import 'package:app_settings/app_settings.dart';

void onVolumePressed() {
  AppSettings.openAppSettingsPanel(AppSettingsPanelType.volume);
}
```

--------------------------------

### Basic usage of AppSettings.openAppSettings

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_method_channel.md

Example of calling openAppSettings through the public facade, which routes to the method channel by default.

```dart
import 'package:app_settings/app_settings.dart';

Future<void> open() async {
  await AppSettings.openAppSettings(type: AppSettingsType.bluetooth);
}
```

--------------------------------

### openAppSettings

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_method_channel.md

Documentation for the openAppSettings method on the MethodChannelAppSettings class, including parameters, return type, wire format, and usage examples.

```APIDOC
## Method: `openAppSettings`

### Description
Opens the app settings screen on the platform. This method is part of the `MethodChannelAppSettings` class and is invoked through the public `AppSettings` facade by default.

### Method
`invokeMethod` on `MethodChannel`

### Channel
`com.spencerccf.app_settings/methods`

### Parameters
- `type` (`AppSettingsType`) - Optional - Default: `AppSettingsType.settings` - Serialized via `type.name` into the `'type'` argument (a `String`).
- `asAnotherTask` (`bool`) - Optional - Default: `false` - Serialized verbatim into the `'asAnotherTask'` argument.

### Return Type
`Future<void>` - Resolves to the value the native handler returns via `result.success(null)` (Android/iOS/macOS all return `null` on success). Rejects with `PlatformException` or `MissingPluginException` as described in errors.md.

### Wire Format
```dart
MethodChannel('com.spencerccf.app_settings/methods')
  .invokeMethod('openSettings', {'asAnotherTask': <bool>, 'type': <String>})
```

### Usage Example
```dart
import 'package:app_settings/app_settings.dart';

Future<void> open() async {
  await AppSettings.openAppSettings(type: AppSettingsType.bluetooth);
}
```
```

--------------------------------

### openSettings: Start intent with fallback to app settings

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/android_native_plugin.md

Attempts to start an intent from a URL string. If asAnotherTask is true, adds FLAG_ACTIVITY_NEW_TASK. On any exception (e.g., ActivityNotFoundException), it swallows the error and calls openAppSettings instead. This fallback applies to openSettings, openSettingsWithIntent, and transitively to vpn, hotspot, and fallback branches.

```kotlin
private fun openSettings(
  url: String,
  result: Result,
  asAnotherTask: Boolean = false,
) {
  try {
    val intent = Intent(url)
    if (asAnotherTask) {
      intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
    }
    this.activity?.startActivity(intent)
    result.success(null)
  } catch (e: Exception) {
    // If the Activity fails to start, show the app settings instead.
    openAppSettings(result, asAnotherTask)
  }
}
```

--------------------------------

### Handle MissingPluginException when opening settings panel

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

Error handling example: attempts to open the wifi settings panel and catches MissingPluginException, which occurs on iOS/macOS because the native plugins return FlutterMethodNotImplemented for the openSettingsPanel method. On catching the exception, it falls back to opening the full settings page via AppSettings.openAppSettings(type: AppSettingsType.wifi).

```dart
import 'package:app_settings/app_settings.dart';
import 'package:flutter/services.dart';

Future<void> openPanelSafely() async {
  try {
    await AppSettings.openAppSettingsPanel(AppSettingsPanelType.wifi);
  } on MissingPluginException {
    // Panels are not supported on this platform (e.g. iOS),
    // fall back to the full settings page.
    await AppSettings.openAppSettings(type: AppSettingsType.wifi);
  }
}
```

--------------------------------

### handleOpenSettingsPanel: Dispatch panel intents with silent fallbacks

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/android_native_plugin.md

Handles the 'openSettingsPanel' method channel call. For Android SDK < 29 (Q) or when activity is null, it silently succeeds with result.success(null). Otherwise it starts the panel intent based on the 'type' value; unknown types call result.notImplemented().

```kotlin
private fun handleOpenSettingsPanel(call: MethodCall, result: Result) {
  if(Build.VERSION.SDK_INT < Build.VERSION_CODES.Q) {
    result.success(null)
    return
  }
  this.activity?.let { ... } ?: run { result.success(null) }
}
```

--------------------------------

### AppSettingsPlugin fields: activity and channel

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/android_native_plugin.md

Defines the plugin's fields: an optional Activity reference for starting intents and a late-initialized MethodChannel for Flutter communication. The channel is kept to allow proper teardown in onDetachedFromEngine.

```kotlin
/// The Activity that will be used to start intents
/// when the settings are opened as another task.
private var activity: Activity? = null

/// The MethodChannel that will the communication between Flutter and native Android
///
/// This local reference serves to register the plugin with the Flutter Engine and unregister it
/// when the Flutter Engine is detached from the Activity
private lateinit var channel : MethodChannel
```

--------------------------------

### openSettingsPanel

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/endpoints.md

Opens an Android Settings Panel dialog (Android Q+). Accepts a type argument specifying which settings panel to open. Returns null on success or a MissingPluginException on unsupported platforms or types.

```APIDOC
## openSettingsPanel

### Description
Opens an Android Settings Panel dialog (Android Q+).

### Method
openSettingsPanel

### Arguments
- **type** (String) - Required - `AppSettingsPanelType` emitted as `type.name`: `'internetConnectivity'`, `'nfc'`, `'volume'`, or `'wifi'`.

### Response
| Platform | Result |
|----------|--------|
| Android (SDK ≥ 29, activity attached) | `result.success(null)` after `startActivity(Intent(Settings.Panel.ACTION_…))` (`AppSettingsPlugin.kt:122-141`). |
| Android (SDK < 29) | `result.success(null)` — silent no-op (`AppSettingsPlugin.kt:116-120`). |
| Android (no activity) | `result.success(null)` — silent no-op (`AppSettingsPlugin.kt:143-145`). |
| Android (unknown type) | `result.notImplemented()` → `MissingPluginException` on Dart side. |
| iOS / macOS | `FlutterMethodNotImplemented` (only `openSettings` is handled) → `MissingPluginException` on Dart side. |

### Status-code summary (channel semantics)
| Dart-side outcome | Meaning |
|-------------------|---------|
| resolves with `null` | native accepted the call (may still have silently done nothing — no-op cases above) |
| rejects with `MissingPluginException` | native returned `FlutterMethodNotImplemented`/`result.notImplemented()` (unsupported method or type on that platform) |
| rejects with `PlatformException` | native threw an error through the channel (no code path in this package does this) |
| rejects with `MissingPluginException` | no native handler registered at all (plugin not registered on platform) |
```

--------------------------------

### iOS: openSettings and openSubscriptionSettings helpers

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/apple_native_plugins.md

Swift helpers for opening settings URLs and managing subscriptions. openSettings guards URL creation and checks canOpenURL before opening. openSubscriptionSettings uses AppStore.showManageSubscriptions and falls back to general settings on error.

```swift
private func openSettings(settingsUrl: String) {
    guard let url = URL(string: settingsUrl) else {
        return
    }
    if (UIApplication.shared.canOpenURL(url)) {
        UIApplication.shared.open(url, options: [:], completionHandler: nil)
    }
}

@available(iOS 15.0.0, *)
private func openSubscriptionSettings(_ windowScene: UIWindowScene) async {
    do {
        try await AppStore.showManageSubscriptions(in: windowScene)
    } catch {
        // Show the default settings as fallback.
        openSettings(settingsUrl: UIApplication.openSettingsURLString)
    }
}
```

--------------------------------

### openSettings

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/endpoints.md

Opens a system settings page for the given type. Accepts a map with an optional asAnotherTask flag and a required type string. Returns null on success on all platforms.

```APIDOC
## openSettings

### Description
Opens a system settings page for the given type.

### Method
Method name: openSettings

### Arguments
- asAnotherTask (bool) - Optional (default false) - Android-only flag; sets Intent.FLAG_ACTIVITY_NEW_TASK when true. Ignored on iOS/macOS.
- type (String) - Required - AppSettingsType emitted as type.name (e.g. 'location', 'wifi', 'settings'). Must be one of the values in types.md.

### Response
- Success payload: null (void) on every platform.
- Android: result.success(null) after dispatch. Unknown type -> result.notImplemented().
- iOS: result(nil) after every handled openSettings branch.
- macOS: result(nil) after every handled branch.

### Per-platform behavior matrix
| type | Android | iOS | macOS |
|------|---------|-----|-------|
| accessibility | open ACTION_ACCESSIBILITY_SETTINGS | fallback: general settings | fallback: general preferences |
| alarm | API 31+: exact-alarm request; else app settings | fallback | fallback |
| apn | open ACTION_APN_SETTINGS | fallback | fallback |
| appLocale | API 33+: app-locale settings; else successful no-op | fallback | fallback |
| batteryOptimization | API 23+: ignore-battery-optimization; else app settings | fallback | fallback |
| bluetooth | open ACTION_BLUETOOTH_SETTINGS | fallback | fallback |
| dataRoaming | open ACTION_DATA_ROAMING_SETTINGS | fallback | fallback |
| date | open ACTION_DATE_SETTINGS | fallback | fallback |
| developer | open ACTION_APPLICATION_DEVELOPMENT_SETTINGS | fallback | fallback |
| device | open ACTION_DEVICE_INFO_SETTINGS | fallback | fallback |
| generalSettings | open ACTION_SETTINGS | fallback | fallback |
| display | open ACTION_DISPLAY_SETTINGS | fallback | fallback |
| hotspot | TetherSettings explicit class | fallback | fallback |
| internalStorage | open ACTION_INTERNAL_STORAGE_SETTINGS | fallback | fallback |
| location | open ACTION_LOCATION_SOURCE_SETTINGS | fallback | fallback |
| lockAndPassword | DevicePolicyManager.ACTION_SET_NEW_PASSWORD | fallback | fallback |
| manageUnknownAppSources | open ACTION_MANAGE_UNKNOWN_APP_SOURCES | fallback | fallback |
| nfc | open ACTION_NFC_SETTINGS | fallback | fallback |
| notification | API 26+: app notification settings; else app settings | iOS 16.0+: notification URL; 15.4+: legacy notification URL; else general settings | Notifications pane |
| security | open ACTION_SECURITY_SETTINGS | fallback | fallback |
| settings | app details settings (package Uri) | general settings | general preferences |
| sound | open ACTION_SOUND_SETTINGS | fallback | fallback |
| subscriptions | notImplemented -> MissingPluginException | iOS 15.0+: AppStore.showManageSubscriptions; else general settings | fallback: general preferences |
| vpn | API 24+: ACTION_VPN_SETTINGS; else "android.net.vpn.SETTINGS" | fallback | fallback |
| wifi | open ACTION_WIFI_SETTINGS | fallback | fallback |
| wireless | open ACTION_WIRELESS_SETTINGS | fallback | fallback |
| camera | notImplemented | fallback: general settings | Camera pane |
| unknown | result.notImplemented() | fallback (default branch) | fallback (default branch) |

### Notes
- "fallback" on iOS/macOS means the general settings URL/preference pane is opened and the call still resolves successfully.
- Android's generic openSettings(url, ...) and openSettingsWithIntent(...) helpers wrap startActivity in try/catch; any Exception triggers a fallback to the app settings page.
- Android no-op success cases (still resolve with null): activity == null for any opener; appLocale below API 33; alarm with unresolvable package Uri.
```

--------------------------------

### Import app_settings

Source: https://github.com/spencerccf/app_settings/blob/master/README.md

Include the plugin in your Dart files.

```dart
import 'package:app_settings/app_settings.dart';
```

--------------------------------

### Enable Swift Package Manager

Source: https://github.com/spencerccf/app_settings/blob/master/README.md

Enable SPM support for your Flutter project.

```bash
  flutter config --enable-swift-package-manager 
```

--------------------------------

### openAppSettings method signature

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

Shows the actual implementation of the openAppSettings method as found in the source file. It delegates to AppSettingsPlatform.instance.openAppSettings. Called without arguments, it opens the general app settings page.

```dart
static Future<void> openAppSettings({
  AppSettingsType type = AppSettingsType.settings,
  bool asAnotherTask = false,
}) {
  return AppSettingsPlatform.instance
      .openAppSettings(type: type, asAnotherTask: asAnotherTask);
}
```

--------------------------------

### AppSettingsPlatform() constructor

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

Creates an AppSettingsPlatform instance. The constructor passes a private token to the PlatformInterface superclass, enabling the instance setter to verify subclass identity.

```APIDOC
## AppSettingsPlatform()

### Description
Creates an AppSettingsPlatform instance. The constructor passes a private static final Object _token to the PlatformInterface constructor so that the instance setter can verify subclass identity.

### Constructor
AppSettingsPlatform()

### Parameters
None.

### Example
```dart
AppSettingsPlatform() : super(token: _token);
```

```

--------------------------------

### openAppSettings

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

Base implementation of the openAppSettings method. It is intended to be overridden by platform-specific implementations. Throws UnimplementedError by default.

```APIDOC
## Method: openAppSettings

### Description
Opens the specified app settings page. This is the base implementation that always throws UnimplementedError and must be overridden by a platform-specific implementation.

### Signature
Future<void> openAppSettings({AppSettingsType type = AppSettingsType.settings, bool asAnotherTask = false})

### Parameters
- **type** (AppSettingsType) - Optional, default: AppSettingsType.settings - The settings page to open.
- **asAnotherTask** (bool) - Optional, default: false - Open as a new task on Android.

### Return Type
Future<void> - The base implementation never returns; it always throws.

### Throws
UnimplementedError - Thrown unconditionally with message 'openAppSettings() has not yet been implemented.' when a subclass registered as AppSettingsPlatform.instance fails to override this method.

### Example
```dart
Future<void> openAppSettings({
  AppSettingsType type = AppSettingsType.settings,
  bool asAnotherTask = false,
}) {
  throw UnimplementedError('openAppSettings() has not yet been implemented.');
}
```
```

--------------------------------

### macOS: AppSettingsPlugin class

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/apple_native_plugins.md

Full macOS plugin implementation. Registers a method channel, handles 'openSettings' calls, and maps 'notification' and 'camera' types to specific System Preferences URLs, falling back to general preferences. Uses NSWorkspace.shared.open and force-casts arguments.

```swift
import Cocoa
import FlutterMacOS
import AppKit
import StoreKit

public class AppSettingsPlugin: NSObject, FlutterPlugin {
    public static func register(with registrar: FlutterPluginRegistrar) {
        let channel = FlutterMethodChannel(name: "com.spencerccf.app_settings/methods", binaryMessenger: registrar.messenger)
        registrar.addMethodCallDelegate(AppSettingsPlugin(), channel: channel)
    }

    public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
        switch(call.method) {
        case "openSettings":
            handleOpenSettings(call: call, result: result)
            break
        default:
            result(FlutterMethodNotImplemented)
            break
        }
    }

    private func handleOpenSettings(call: FlutterMethodCall, result: @escaping FlutterResult) {
        let arguments = call.arguments as! Dictionary<String, Any?>
        let type = arguments["type"] as! String

        switch(type) {
        case "notification":
            openSettings(settingsUrl: SettingsGeneral.notifications.rawValue)
            result(nil)
            break
        case "camera":
            openSettings(settingsUrl: SettingsGeneral.camera.rawValue)
            result(nil)
            break
        default:
            // Show the default settings as fallback.
            openSettings(settingsUrl: SettingsGeneral.preference.rawValue)
            result(nil)
            break
        }
    }

    private func openSettings(settingsUrl: String) {
        guard let url = URL(string: settingsUrl) else {
            return
        }
        NSWorkspace.shared.open(url)
    }
}
```

--------------------------------

### AppSettingsPlatform.instance

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

Static getter and setter for the singleton AppSettingsPlatform instance. The getter returns the current instance, and the setter replaces it after verifying the token. Throws ArgumentError if the instance was not created via the AppSettingsPlatform() constructor token chain.

```APIDOC
## AppSettingsPlatform.instance

### Description
Static property that holds the singleton AppSettingsPlatform instance. The getter returns the current instance, and the setter replaces it after verifying the token. Throws ArgumentError if the value was not created via the AppSettingsPlatform() constructor token chain.

### Getter
static AppSettingsPlatform get instance

### Setter
static set instance(AppSettingsPlatform instance)

### Parameters
- **instance** (AppSettingsPlatform) - Required - The new instance to set.

### Throws
- **ArgumentError** - If the instance was not created via the AppSettingsPlatform() constructor token chain.

### Example
```dart
class MyCustomAppSettings extends AppSettingsPlatform {
  @override
  Future<void> openAppSettings({
    AppSettingsType type = AppSettingsType.settings,
    bool asAnotherTask = false,
  }) async {
    // custom routing logic
    return myCustomHandler.open(type);
  }

  @override
  Future<void> openAppSettingsPanel(AppSettingsPanelType type) async {
    return myCustomHandler.openPanel(type);
  }
}

void register() {
  AppSettingsPlatform.instance = MyCustomAppSettings();
}
```

```

--------------------------------

### AppSettingsPlatform class definition

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

The abstract platform interface that all implementations must extend. It provides a singleton instance and defines two methods for opening app settings.

```APIDOC
## Class: AppSettingsPlatform (abstract)

### Description
The abstract platform interface for the app_settings plugin. All platform-specific implementations must extend this class. It provides a singleton instance and defines methods to open app settings.

### Properties
- **instance** (static getter/setter) - The default instance of AppSettingsPlatform. Defaults to MethodChannelAppSettings. Setting a new instance requires token verification.

### Methods

#### openAppSettings

Opens the app settings page.

##### Signature
Future<void> openAppSettings({AppSettingsType type = AppSettingsType.settings, bool asAnotherTask = false})

##### Parameters
- **type** (AppSettingsType) - Optional - The type of settings to open. Defaults to AppSettingsType.settings.
- **asAnotherTask** (bool) - Optional - Whether to open the settings as another task. Defaults to false.

##### Returns
Future<void> - Completes when the operation is done.

##### Throws
UnimplementedError if not overridden by a subclass.

#### openAppSettingsPanel

Opens a specific settings panel.

##### Signature
Future<void> openAppSettingsPanel(AppSettingsPanelType type)

##### Parameters
- **type** (AppSettingsPanelType) - Required - The type of settings panel to open.

##### Returns
Future<void> - Completes when the operation is done.

##### Throws
UnimplementedError if not overridden by a subclass.
```

--------------------------------

### Configure iOS Podfile for Objective-C

Source: https://github.com/spencerccf/app_settings/blob/master/README.md

Add use_frameworks! to your Runner project podfile if using Objective-C.

```pod
target 'Runner' do
  use_frameworks!
```

--------------------------------

### Registering a Custom AppSettingsPlatform Implementation

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

Demonstrates how to extend AppSettingsPlatform to provide custom routing logic and register it as the active instance.

```dart
import 'package:app_settings/app_settings_platform_interface.dart';
import 'package:app_settings/app_settings_method_channel.dart';

class MyCustomAppSettings extends AppSettingsPlatform {
  @override
  Future<void> openAppSettings({
    AppSettingsType type = AppSettingsType.settings,
    bool asAnotherTask = false,
  }) async {
    // custom routing logic
    return myCustomHandler.open(type);
  }

  @override
  Future<void> openAppSettingsPanel(AppSettingsPanelType type) async {
    return myCustomHandler.openPanel(type);
  }
}

void register() {
  AppSettingsPlatform.instance = MyCustomAppSettings();
}
```

--------------------------------

### Open Application Settings

Source: https://github.com/spencerccf/app_settings/blob/master/README.md

Use AppSettings.openAppSettings to navigate to specific system settings pages.

```dart
Widget build(BuildContext context) {
  return ElevatedButton(
    onPressed: () => AppSettings.openAppSettings(type: AppSettingsType.location),
    child: const Text('Open Location Settings'),
  );
}
```

--------------------------------

### Add app_settings dependency

Source: https://github.com/spencerccf/app_settings/blob/master/README.md

Add the package to your project using the Flutter CLI.

```bash
flutter pub add app_settings
```

--------------------------------

### Basic usage: open default app settings

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

Basic call to open the default app settings page using the app_settings package. It imports the package and specifies that this is equivalent to explicitly passing type: AppSettingsType.settings.

```dart
import 'package:app_settings/app_settings.dart';

Future<void> openAppSettings() async {
  await AppSettings.openAppSettings();
  // Equivalent: await AppSettings.openAppSettings(type: AppSettingsType.settings);
}
```

--------------------------------

### AppSettingsPlatform abstract class

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

Abstract platform interface for the app_settings plugin. Extends PlatformInterface and uses a token to enforce that implementations extend this class. The instance setter verifies the token and throws ArgumentError if not. Base methods throw UnimplementedError by default.

```dart
abstract class AppSettingsPlatform extends PlatformInterface {
  /// Constructs a AppSettingsPlatform.
  AppSettingsPlatform() : super(token: _token);

  static final Object _token = Object();

  static AppSettingsPlatform _instance = MethodChannelAppSettings();

  /// The default instance of [AppSettingsPlatform] to use.
  ///
  /// Defaults to [MethodChannelAppSettings].
  static AppSettingsPlatform get instance => _instance;

  /// Platform-specific implementations should set this with their own
  /// platform-specific class that extends [AppSettingsPlatform] when
  /// they register themselves.
  static set instance(AppSettingsPlatform instance) {
    PlatformInterface.verifyToken(instance, _token);
    _instance = instance;
  }

  Future<void> openAppSettings({
    AppSettingsType type = AppSettingsType.settings,
    bool asAnotherTask = false,
  }) {
    throw UnimplementedError('openAppSettings() has not yet been implemented.');
  }

  Future<void> openAppSettingsPanel(AppSettingsPanelType type) {
    throw UnimplementedError('openAppSettingsPanel() has not yet been implemented.');
  }
}
```

--------------------------------

### AppSettings.openAppSettingsPanel

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

Opens an application settings panel. Only supported on Android, and only from Android Q onwards. Does nothing on Android Pie and lower.

```APIDOC
## AppSettings.openAppSettingsPanel

### Description
Opens an application settings panel. Only supported on Android, and only from Android Q onwards. Does nothing on Android Pie and lower.

### Method
static Future<void> openAppSettingsPanel(AppSettingsPanelType type)

### Parameters
- **type** (AppSettingsPanelType) - Required - The type of settings panel to open.

### Returns
Future<void> - Completes after the native side finishes dispatching the intent/URL open; does not wait for the settings page to close.

### Behavior
- Only supported on Android.
- Does nothing on Android Pie and lower.
```

--------------------------------

### AppSettingsPlatform Constructor

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

Initializes the platform interface by passing a private token to the superclass to verify subclass identity.

```dart
AppSettingsPlatform() : super(token: _token);
```

--------------------------------

### AppSettings class definition

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

Defines the AppSettings static facade class with two methods: openAppSettings and openAppSettingsPanel. openAppSettings opens a specific settings panel if the type is supported, otherwise falls back to the general settings page. openAppSettingsPanel only works on Android Q and above; it does nothing on Android Pie and lower. All calls are forwarded to AppSettingsPlatform.instance.

```dart
class AppSettings {
  /// Open the app settings.
  ///
  /// If [type] is supported, opens a specific app settings panel.
  /// If [asAnotherTask] is true, opens the app settings as another task on Android.
  static Future<void> openAppSettings({
    AppSettingsType type = AppSettingsType.settings,
    bool asAnotherTask = false,
  }) {
    return AppSettingsPlatform.instance
        .openAppSettings(type: type, asAnotherTask: asAnotherTask);
  }

  /// Open an application settings panel.
  ///
  /// App Settings Panels are only supported on Android.
  ///
  /// This method does nothing on Android Pie and lower,
  /// as settings panels are only available from Android Q onwards.
  static Future<void> openAppSettingsPanel(AppSettingsPanelType type) {
    return AppSettingsPlatform.instance.openAppSettingsPanel(type);
  }
}
```

--------------------------------

### openAppSettingsPanel

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

Base implementation of the openAppSettingsPanel method. It is intended to be overridden by platform-specific implementations. Throws UnimplementedError by default.

```APIDOC
## Method: openAppSettingsPanel

### Description
Opens the specified Android settings panel. This is the base implementation that always throws UnimplementedError and must be overridden by a platform-specific implementation.

### Signature
Future<void> openAppSettingsPanel(AppSettingsPanelType type)

### Parameters
- **type** (AppSettingsPanelType) - Required - The Android settings panel to open.

### Return Type
Future<void> - The base implementation never returns; it always throws.

### Throws
UnimplementedError - Thrown unconditionally with message 'openAppSettingsPanel() has not yet been implemented.' when a subclass registered as AppSettingsPlatform.instance fails to override this method.

### Example
```dart
Future<void> openAppSettingsPanel(AppSettingsPanelType type) {
  throw UnimplementedError('openAppSettingsPanel() has not yet been implemented.');
}
```
```

--------------------------------

### AppSettingsPlatform Instance Getter and Setter

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

Manages the singleton instance of the platform interface. The setter verifies the token to ensure the instance was created correctly.

```dart
static AppSettingsPlatform get instance => _instance;

static set instance(AppSettingsPlatform instance) {
  PlatformInterface.verifyToken(instance, _token);
  _instance = instance;
}
```

--------------------------------

### handleOpenSettings per-type behavior

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/apple_native_plugins.md

Handles the 'openSettings' method by reading the 'type' argument and opening the appropriate settings URL based on iOS version. For 'notification' and 'subscriptions' types, uses version-specific APIs; otherwise falls back to the default settings URL. Force casts may crash on malformed arguments.

```swift
private func handleOpenSettings(call: FlutterMethodCall, result: @escaping FlutterResult) {
    let arguments = call.arguments as! Dictionary<String, Any?>
    let type = arguments["type"] as! String

    switch(type) {
    case "notification":
        if #available(iOS 16.0, *) {
            openSettings(settingsUrl: UIApplication.openNotificationSettingsURLString)
        } else if #available(iOS 15.4, *) {
            openSettings(settingsUrl: UIApplicationOpenNotificationSettingsURLString)
        } else {
            openSettings(settingsUrl: UIApplication.openSettingsURLString)
        }
        result(nil)
        break
    case "subscriptions":
        if #available(iOS 15.0, *) {
            Task {
                let windowScene = UIApplication.shared.connectedScenes.first as? UIWindowScene
                if(windowScene != nil) {
                    await openSubscriptionSettings(windowScene!)
                } else {
                    openSettings(settingsUrl: UIApplication.openSettingsURLString)
                }
                result(nil)
            }
        } else {
            // Show the default settings as fallback.
            openSettings(settingsUrl: UIApplication.openSettingsURLString)
            result(nil)
        }
        break
    default:
        // Show the default settings as fallback.
        openSettings(settingsUrl: UIApplication.openSettingsURLString)
        result(nil)
        break
    }
}
```

--------------------------------

### AppSettings.openAppSettings

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

Static method that opens the native app settings page. Accepts an optional AppSettingsType and an asAnotherTask flag for Android. Returns a Future that completes when the native platform initiates the settings open.

```APIDOC
## AppSettings.openAppSettings

### Description
Opens the native app settings page on the current platform. The method accepts an optional settings type and an Android-specific flag to open the settings as a separate task. The returned Future completes when the native platform has initiated the settings open, not when the user interacts with the screen.

### Method
static Future<void> openAppSettings({AppSettingsType type = AppSettingsType.settings, bool asAnotherTask = false})

### Parameters
#### Parameters
- **type** (AppSettingsType) - Optional - Default: AppSettingsType.settings - The settings page to open. Enum values are documented in types.md. Unsupported values fall back to the general app settings page on the native side.
- **asAnotherTask** (bool) - Optional - Default: false - Only meaningful on Android. When true, the settings Intent is started with Intent.FLAG_ACTIVITY_NEW_TASK, i.e. the settings screen opens as a separate task/Activity. Ignored on iOS and macOS.

### Return Type
Future<void> - Completes when the native platform has initiated the settings open. It does not indicate that the user saw or interacted with the settings screen, and on several fallback paths it completes successfully (null) even when nothing was opened.

### Throws
- **UnimplementedError** - If AppSettingsPlatform.instance was replaced with a custom implementation that does not override openAppSettings (base class throws).
- **MissingPluginException** - If AppSettingsPlatform.instance is MethodChannelAppSettings but no native plugin handler is registered on the current platform (e.g. an unsupported platform).

### Request Example
```dart
import 'package:app_settings/app_settings.dart';

Future<void> openAppSettings() async {
  await AppSettings.openAppSettings();
  // Equivalent: await AppSettings.openAppSettings(type: AppSettingsType.settings);
}
```

### Response Example
```dart
import 'package:app_settings/app_settings.dart';
import 'package:flutter/services.dart';

Future<void> openLocationSettings() async {
  try {
    await AppSettings.openAppSettings(
      type: AppSettingsType.location,
      asAnotherTask: true,
    );
  } on MissingPluginException {
    // No native app_settings plugin registered (unsupported platform /
    // missing registration). Show a fallback UI to the user.
    debugPrint('app_settings plugin not available');
  } on UnimplementedError {
    // A custom AppSettingsPlatform implementation was installed
    // without implementing openAppSettings().
    debugPrint('custom platform does not implement openAppSettings');
  }
}
```
```

--------------------------------

### AppSettingsPlugin class registration and method handling

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/apple_native_plugins.md

Defines the AppSettingsPlugin class, registers the method channel 'com.spencerccf.app_settings/methods', and handles the 'openSettings' method. Other methods return FlutterMethodNotImplemented.

```swift
@preconcurrency import Flutter
import UIKit
import StoreKit

@MainActor
public class AppSettingsPlugin: NSObject, @preconcurrency FlutterPlugin, UIWindowSceneDelegate {
    public static func register(with registrar: FlutterPluginRegistrar) {
        let channel = FlutterMethodChannel(name: "com.spencerccf.app_settings/methods", binaryMessenger: registrar.messenger())
        let instance = AppSettingsPlugin()
        registrar.addMethodCallDelegate(instance, channel: channel)
    }

    public func handle(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
        switch(call.method) {
        case "openSettings":
            handleOpenSettings(call: call, result: result)
            break
        default:
            result(FlutterMethodNotImplemented)
            break
        }
    }
    ...
}
```

--------------------------------

### Open Android Q Settings Panels

Source: https://github.com/spencerccf/app_settings/blob/master/README.md

Use AppSettings.openAppSettingsPanel to open specific settings panels on Android Q and higher.

```dart
Widget build(BuildContext context) {
  return ElevatedButton(
    onPressed: () => AppSettings.openAppSettingsPanel(AppSettingsPanelType.volume),
    child: const Text('Open Volume Settings Panel'),
  );
}
```

--------------------------------

### AppSettings.openAppSettings

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

Opens the app settings. If the specified type is supported, opens a specific settings panel; otherwise falls back to the general app settings. Optionally opens as another task on Android.

```APIDOC
## AppSettings.openAppSettings

### Description
Opens the app settings. If the specified type is supported, opens a specific settings panel; otherwise falls back to the general app settings. Optionally opens as another task on Android.

### Method
static Future<void> openAppSettings({AppSettingsType type = AppSettingsType.settings, bool asAnotherTask = false})

### Parameters
- **type** (AppSettingsType) - Optional - The type of settings panel to open. Defaults to AppSettingsType.settings.
- **asAnotherTask** (bool) - Optional - If true, opens the app settings as another task on Android. Defaults to false.

### Returns
Future<void> - Completes after the native side finishes dispatching the intent/URL open; does not wait for the settings page to close.

### Behavior
- If type is supported, opens the specific settings page.
- If type is not supported, opens the general application settings page instead.
```

--------------------------------

### Test openAppSettings with mock messenger

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_method_channel.md

Direct use in a test/mock-messenger harness, as used in test/app_settings_method_channel_test.dart. Sets up a mock method call handler and verifies the arguments sent.

```dart
import 'package:flutter_test/flutter_test.dart';
import 'package:flutter/services.dart';
import 'package:app_settings/app_settings_method_channel.dart';

void main() {
  TestWidgetsFlutterBinding.ensureInitialized();
  final platform = MethodChannelAppSettings();

  test('sends openSettings with expected arguments', () async {
    const channel = MethodChannel('com.spencerccf.app_settings/methods');
    final log = <MethodCall>[];
    TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger
        .setMockMethodCallHandler(channel, (call) async {
      log.add(call);
      return null;
    });

    await platform.openAppSettings(
      type: AppSettingsType.location,
      asAnotherTask: true,
    );

    expect(log.single, isMethodCall('openSettings',
        arguments: {'asAnotherTask': true, 'type': 'location'}));
  });
}
```

--------------------------------

### Wire format for openSettings invocation

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_method_channel.md

Shows the wire format of the method channel invocation, with placeholders for the boolean and string arguments.

```dart
MethodChannel('com.spencerccf.app_settings/methods')
  .invokeMethod('openSettings', {'asAnotherTask': <bool>, 'type': <String>})
```

--------------------------------

### openAppSettingsPanel base implementation

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

The base implementation of openAppSettingsPanel that throws an UnimplementedError. It requires an AppSettingsPanelType to specify the Android settings panel.

```dart
Future<void> openAppSettingsPanel(AppSettingsPanelType type) {
  throw UnimplementedError('openAppSettingsPanel() has not yet been implemented.');
}
```

--------------------------------

### openAppSettings base implementation

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

The base implementation of openAppSettings that throws an UnimplementedError. It accepts an optional AppSettingsType and an asAnotherTask boolean for Android.

```dart
Future<void> openAppSettings({
  AppSettingsType type = AppSettingsType.settings,
  bool asAnotherTask = false,
}) {
  throw UnimplementedError('openAppSettings() has not yet been implemented.');
}
```

--------------------------------

### AppSettings.openAppSettingsPanel

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

Opens a specific Android Settings panel. The method is Android-only and completes successfully even when the panel is silently skipped on Android Pie and lower or on platforms without an Activity.

```APIDOC
## AppSettings.openAppSettingsPanel

### Description
Opens a specific Android Settings panel. The method is Android-only and completes successfully even when the panel is silently skipped on Android Pie and lower or on platforms without an Activity.

### Method
openAppSettingsPanel

### Signature
static Future<void> openAppSettingsPanel(AppSettingsPanelType type)

### Parameters
- **type** (AppSettingsPanelType) - Required - The Android Settings Panel to show. The four values are documented in types.md.

### Return Type
Future<void> - Completes immediately after the native side handles the call. The method does nothing (completes successfully) on Android Pie and lower and on any platform without an available Activity.

### Throws
- **UnimplementedError** - If AppSettingsPlatform.instance is a custom implementation that does not override openAppSettingsPanel (base class throws).
- **MissingPluginException** - On iOS and macOS: the native plugins return FlutterMethodNotImplemented for the openSettingsPanel method, which surfaces to Dart as MissingPluginException.

### Usage Examples

Basic call - open the volume settings panel (Android Q+):

```dart
import 'package:app_settings/app_settings.dart';

void onVolumePressed() {
  AppSettings.openAppSettingsPanel(AppSettingsPanelType.volume);
}
```

Error handling - the panel API is Android-only; on iOS/macOS it rejects with MissingPluginException:

```dart
import 'package:app_settings/app_settings.dart';
import 'package:flutter/services.dart';

Future<void> openPanelSafely() async {
  try {
    await AppSettings.openAppSettingsPanel(AppSettingsPanelType.wifi);
  } on MissingPluginException {
    // Panels are not supported on this platform (e.g. iOS),
    // fall back to the full settings page.
    await AppSettings.openAppSettings(type: AppSettingsType.wifi);
  }
}
```
```

--------------------------------

### Kotlin handleOpenSettings method

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/android_native_plugin.md

This is the method-channel handler for opening Android settings. It reads the asAnotherTask argument (default false) and the type string (the Dart enum name), then dispatches to the native action. The remainder of the mapping is shown in the table below, including API-level fallbacks and the notImplemented response for camera/subscriptions.

```kotlin
private fun handleOpenSettings(call: MethodCall, result: Result) {
  val asAnotherTask = call.argument<Boolean>("asAnotherTask") ?: false

  when(call.argument<String>("type")) { ... }
}
```

--------------------------------

### AppSettings.openAppSettingsPanel method signature

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

The full signature of the openAppSettingsPanel method, copied from lib/src/app_settings.dart:23-28. It delegates to AppSettingsPlatform.instance.openAppSettingsPanel(type) and returns a Future<void> that completes immediately after the native side handles the call. On Android Pie and lower, or on platforms without an available Activity, it does nothing and completes successfully.

```dart
static Future<void> openAppSettingsPanel(AppSettingsPanelType type) {
  return AppSettingsPlatform.instance.openAppSettingsPanel(type);
}
```

--------------------------------

### openAppSettingsPanel(AppSettingsPanelType type)

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_method_channel.md

Invokes the native settings panel for the given panel type via the method channel 'com.spencerccf.app_settings/methods'. Returns a Future that resolves to null on Android (including no-op cases) and throws MissingPluginException on iOS/macOS when not implemented.

```APIDOC
## Method: openAppSettingsPanel

### Description
Invokes the native settings panel for the specified panel type using the method channel 'com.spencerccf.app_settings/methods'.

### Method
invokeMethod (MethodChannel)

### Endpoint
MethodChannel('com.spencerccf.app_settings/methods').invokeMethod('openSettingsPanel', {'type': <String>})

### Parameters
#### Arguments
- **type** (AppSettingsPanelType) - Required - The panel type to open, serialized via type.name (e.g., 'volume').

### Return Type
Future<void> - Resolves with null on Android (including no-op cases: SDK < Android Q, or missing Activity). On iOS and macOS, returns FlutterMethodNotImplemented which surfaces as MissingPluginException.

### Usage Example
```dart
import 'package:app_settings/app_settings.dart';
import 'package:flutter/services.dart';

Future<void> openNfcPanel() async {
  try {
    await AppSettings.openAppSettingsPanel(AppSettingsPanelType.nfc);
  } on MissingPluginException {
    // Not supported on this platform.
  }
}
```
```

--------------------------------

### AppSettingsPlugin lifecycle method overrides (Kotlin)

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/android_native_plugin.md

Lists the override signatures for the Flutter plugin lifecycle methods. The table describes each method's behavior: onAttachedToEngine creates the MethodChannel, onMethodCall dispatches to handlers, onDetachedFromEngine unregisters the handler, onAttachedToActivity stores the activity, and the config-change methods clear/restore it. When no Activity is attached, the let block is skipped but result.success(null) still runs, causing a silent no-op.

```kotlin
override fun onAttachedToEngine(flutterPluginBinding: FlutterPlugin.FlutterPluginBinding)
override fun onMethodCall(call: MethodCall, result: Result)
override fun onDetachedFromEngine(binding: FlutterPlugin.FlutterPluginBinding)
override fun onAttachedToActivity(binding: ActivityPluginBinding)
override fun onDetachedFromActivityForConfigChanges()
override fun onReattachedToActivityForConfigChanges(binding: ActivityPluginBinding)
override fun onDetachedFromActivity()
```

--------------------------------

### Imports for AppSettingsPlatform

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_platform_interface.md

Imports required for the platform interface: the plugin_platform_interface package, the method channel implementation, and the app settings type enums.

```dart
import 'package:plugin_platform_interface/plugin_platform_interface.dart';

import 'app_settings_method_channel.dart';
import 'src/app_settings_panel_type.dart';
import 'src/app_settings_type.dart';
```

--------------------------------

### Model Class Implementation

Source: https://github.com/spencerccf/app_settings/blob/master/example/android/build/reports/problems/problems-report.html

Implementation of the Model class, providing methods for copying, string representation, hashing, and equality checks.

```javascript
se(mo).mc=function(n,t,r,i,e,u,o,f){return new mo(n,t,r,i,e,u,o,f)},se(mo).nc=function(n,t,r,i,e,u,o,f,s){return n=n===A?this.ec_1:n,t=t===A?this.fc_1:t,r=r===A?this.gc_1:r,i=i===A?this.hc_1:i,e=e===A?this.ic_1:e,u=u===A?this.jc_1:u,o=o===A?this.kc_1:o,f=f===A?this.lc_1:f,s===A?this.mc(n,t,r,i,e,u,o,f):s.mc.call(this,n,t,r,i,e,u,o,f)},se(mo).toString=function(){return"Model(heading="+this.ec_1+", summary="+this.fc_1+", learnMore="+this.gc_1+", messageTree="+this.hc_1+", locationTree="+this.ic_1+", inputTree="+this.jc_1+", incompatibleTaskTree="+this.kc_1+", tab="+this.lc_1+")"},se(mo).hashCode=function(){var n=this.ec_1.hashCode();return n=zn(n,31)+ee(this.fc_1)|0,n=zn(n,31)+this.gc_1.hashCode()|0,n=zn(n,31)+this.hc_1.hashCode()|0,n=zn(n,31)+this.ic_1.hashCode()|0,n=zn(n,31)+this.jc_1.hashCode()|0,n=zn(n,31)+this.kc_1.hashCode()|0,zn(n,31)+this.lc_1.hashCode()|0},se(mo).equals=function(n){if(this===n)return!0;if(!(n instanceof mo))return!1;var t=n instanceof mo?n:_e();return!!(this.ec_1.equals(t.ec_1)&&oe(this.fc_1,t.fc_1)&&this.gc_1.equals(t.gc_1)&&this.hc_1.equals(t.hc_1)&&this.ic_1.equals(t.ic_1)&&this.jc_1.equals(t.jc_1)&&this.kc_1.equals(t.kc_1)&&this.lc_1.equals(t.lc_1))}
```

--------------------------------

### Method Channel wire format

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_method_channel.md

The expected wire format for the openSettingsPanel method call over the method channel.

```dart
MethodChannel('com.spencerccf.app_settings/methods')
  .invokeMethod('openSettingsPanel', {'type': <String>})
```

--------------------------------

### Usage with error handling: location settings as separate Android task

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings.md

Shows how to open location settings with asAnotherTask: true, which is only meaningful on Android. Includes error handling for MissingPluginException and UnimplementedError, logging fallback messages via debugPrint.

```dart
import 'package:app_settings/app_settings.dart';
import 'package:flutter/services.dart';

Future<void> openLocationSettings() async {
  try {
    await AppSettings.openAppSettings(
      type: AppSettingsType.location,
      asAnotherTask: true,
    );
  } on MissingPluginException {
    // No native app_settings plugin registered (unsupported platform /
    // missing registration). Show a fallback UI to the user.
    debugPrint('app_settings plugin not available');
  } on UnimplementedError {
    // A custom AppSettingsPlatform implementation was installed
    // without implementing openAppSettings().
    debugPrint('custom platform does not implement openAppSettings');
  }
}
```

--------------------------------

### Override openAppSettingsPanel implementation

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_method_channel.md

The implementation of the openAppSettingsPanel method using the method channel to invoke the native 'openSettingsPanel' command.

```dart
@override
Future<void> openAppSettingsPanel(AppSettingsPanelType type) {
  return methodChannel.invokeMethod<void>('openSettingsPanel', {
    'type': type.name,
  });
}
```

--------------------------------

### Imports for MethodChannelAppSettings

Source: https://github.com/spencerccf/app_settings/blob/master/_autodocs/api-reference/app_settings_method_channel.md

Imports required for the MethodChannelAppSettings implementation, including Flutter foundation and services, and the app_settings platform interface.

```dart
import 'package:flutter/foundation.dart';
import 'package:flutter/services.dart';

import 'app_settings.dart';
import 'app_settings_platform_interface.dart';
```
Tokens:
Raw