Flutter Secure Storage

https://pub.dev/documentation/flutter_secure_storage/latest/
Admin
A Flutter plugin to securely store sensitive data in a key-value pair format using platform-specific...
Tokens:29,836
Snippets:375
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup Development Workspace

Source: https://pub.dev/documentation/flutter_secure_storage/latest/index.html

Commands to fetch dependencies, activate melos, and bootstrap the project workspace.

```bash
flutter pub get
```

```bash
dart pub global activate melos
```

```bash
export PATH="$PATH":"$HOME/.pub-cache/bin"
```

```bash
melos bootstrap
```

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

### Install Libsecret on Fedora/RHEL/CentOS

Source: https://pub.dev/documentation/flutter_secure_storage/latest/index.html

Installs the required development and runtime packages for Libsecret on Fedora-based Linux distributions.

```bash
sudo dnf install libsecret libsecret-devel
```

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

### Install Libsecret on Ubuntu/Debian

Source: https://pub.dev/documentation/flutter_secure_storage/latest/index.html

Installs the required development and runtime packages for Libsecret on Debian-based Linux distributions.

```bash
sudo apt install libsecret-1-0 libsecret-1-dev
```

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

### Migration Scenarios with Backup Protection

Source: https://pub.dev/documentation/flutter_secure_storage/latest/index.html

Examples of configuring migration with backup protection for algorithm changes and biometric storage transitions.

```dart
// Migrating from old to new algorithm with backup protection
final storage = FlutterSecureStorage(
  aOptions: AndroidOptions(
    migrateWithBackup: true,
    keyCipherAlgorithm: KeyCipherAlgorithm.RSA_ECB_OAEPwithSHA_256andMGF1Padding,
    storageCipherAlgorithm: StorageCipherAlgorithm.AES_GCM_NoPadding,
  ),
);

// Migrating to biometric storage with backup
final storage = FlutterSecureStorage(
  aOptions: AndroidOptions.biometric(
    migrateWithBackup: true,
    enforceBiometrics: false,
  ),
);
```

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

### Install Libsecret on Arch Linux

Source: https://pub.dev/documentation/flutter_secure_storage/latest/index.html

Installs the unified Libsecret package containing both development and runtime modules for Arch-based distributions.

```bash
sudo pacman -S libsecret
```

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

### LinuxOptions()

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/LinuxOptions/LinuxOptions.html

Creates a new instance of LinuxOptions with no additional configuration.

```APIDOC
## LinuxOptions()

### Description
Creates an instance of `LinuxOptions` with no additional configuration.

### Signature
`const LinuxOptions()`
```

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

### IOSOptions Constructor

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/IOSOptions-class.html

Creates an instance of `IOSOptions` with configurable parameters for keychain access and storage behavior.

```APIDOC
## IOSOptions()

### Description
Creates an instance of `IosOptions` with configurable parameters for keychain access and storage behavior.

### Parameters

#### Named Parameters

*   **accountName** (String?) - Optional - `kSecAttrService`: **Shared**. Represents the service or application name associated with the item. Typically used to group related keychain items.
*   **groupId** (String?) - Optional - `kSecAttrAccessGroup`: **Shared**. Specifies the app group for shared access. Allows multiple apps in the same app group to access the item.
*   **accessibility** (KeychainAccessibility?) - Optional - `kSecAttrAccessible`: **Shared**. Defines the accessibility level of the keychain item. Controls when the item is accessible (e.g., when the device is unlocked or after first unlock).
*   **synchronizable** (bool) - Optional - `kSecAttrSynchronizable`: **Shared**. Indicates whether the keychain item should be synchronized with iCloud. `true` enables synchronization, `false` disables it. Defaults to `false`.
*   **label** (String?) - Optional - `kSecAttrLabel`: **Unique**. A user-visible label for the keychain item. Helps identify the item in keychain management tools.
*   **description** (String?) - Optional - `kSecAttrDescription`: **Shared or Unique**. A description of the keychain item. Can describe a category of items (shared) or be specific to a single item.
*   **comment** (String?) - Optional - `kSecAttrComment`: **Shared or Unique**. A comment associated with the keychain item. Often used for metadata or debugging information.
*   **isInvisible** (bool?) - Optional - `kSecAttrIsInvisible`: **Shared or Unique**. Indicates whether the keychain item is hidden from user-visible lists. Can apply to all items in a category (shared) or specific items (unique).
*   **isNegative** (bool?) - Optional - `kSecAttrIsNegative`: **Unique**. Indicates whether the item is a placeholder or a negative entry. Typically unique to individual keychain items.
*   **creationDate** (DateTime?) - Optional - `kSecAttrCreationDate`: **Unique**. The creation date of the keychain item. Automatically set by the system when an item is created.
*   **lastModifiedDate** (DateTime?) - Optional - `kSecAttrModificationDate`: **Unique**. The last modification date of the keychain item. Automatically updated when an item is modified.
*   **resultLimit** (int?) - Optional - `kSecMatchLimit`: **Action-Specific**. Specifies the maximum number of results to return in a query. For example, `1` for a single result, or `all` for all matching results.
*   **shouldReturnPersistentReference** (bool?) - Optional - `kSecReturnPersistentRef`: **Action-Specific**. Indicates whether to return a persistent reference to the keychain item. Used for persistent access across app sessions.
*   **authenticationUIBehavior** (String?) - Optional - `kSecUseAuthenticationUI`: **Shared**. Controls how authentication UI is presented during secure operations. Determines whether authentication prompts are displayed to the user.
*   **accessControlFlags** (List<AccessControlFlag>) - Optional - Keychain access control flags define security conditions for accessing items. These flags can be combined to create custom security policies. Defaults to an empty list.
*   **useSecureEnclave** (bool) - Optional - When true, opts into Secure Enclave–backed protection on iOS/macOS. Defaults to `false`.
```

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

### Initialize WebOptions

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WebOptions/WebOptions.html

Defines the constructor for WebOptions with default values for database and encryption settings.

```dart
const WebOptions({
  this.dbName = 'FlutterEncryptedStorage',
  this.publicKey = 'FlutterSecureStorage',
  this.wrapKey = '',
  this.wrapKeyIv = '',
  this.useSessionStorage = false,
});
```

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

### AppleOptions()

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AppleOptions/AppleOptions.html

Creates an instance of AppleOptions with configurable parameters for keychain access and storage behavior.

```APIDOC
## AppleOptions()

### Description
Creates an instance of `AppleOptions` with configurable parameters for keychain access and storage behavior.

### Parameters
- **accountName** (String?) - Optional - The account name for the keychain item. Defaults to `AppleOptions.defaultAccountName`.
- **groupId** (String?) - Optional - The access group ID for the keychain item.
- **accessibility** (KeychainAccessibility?) - Optional - The accessibility level for the keychain item. Defaults to `KeychainAccessibility.unlocked`.
- **synchronizable** (bool) - Optional - Whether the item should be synchronized via iCloud. Defaults to `false`.
- **label** (String?) - Optional - A label for the keychain item.
- **description** (String?) - Optional - A description for the keychain item.
- **comment** (String?) - Optional - A comment for the keychain item.
- **isInvisible** (bool?) - Optional - Whether the item is invisible.
- **isNegative** (bool?) - Optional - Whether the item is negative.
- **creationDate** (DateTime?) - Optional - The creation date of the item.
- **lastModifiedDate** (DateTime?) - Optional - The last modified date of the item.
- **resultLimit** (int?) - Optional - The result limit for queries.
- **shouldReturnPersistentReference** (bool?) - Optional - Whether to return a persistent reference.
- **authenticationUIBehavior** (String?) - Optional - The authentication UI behavior.
- **accessControlFlags** (List<AccessControlFlag>) - Optional - A list of access control flags. Defaults to `[]`.
- **useSecureEnclave** (bool) - Optional - Whether to use the Secure Enclave. Defaults to `false`.
```

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

### Initialize LinuxOptions

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/LinuxOptions/LinuxOptions.html

Creates a new instance of LinuxOptions using the constant constructor.

```dart
const LinuxOptions();
```

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

### Import Package

Source: https://pub.dev/documentation/flutter_secure_storage/latest/index.html

Import the library to access secure storage functionality.

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

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

### IOSOptions.defaultOptions

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/IOSOptions-class.html

A predefined `IosOptions` instance with default settings.

```APIDOC
## IOSOptions.defaultOptions

### Description
A predefined `IosOptions` instance with default settings.

### Type
`const IOSOptions`
```

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

### Configure Snapcraft Build for Linux

Source: https://pub.dev/documentation/flutter_secure_storage/latest/index.html

Defines the necessary build and stage packages for Libsecret within a snapcraft.yaml file.

```yaml
parts:
  your-app:
    plugin: flutter
    flutter-target: lib/main.dart
    build-packages:
      - libsecret-1-dev
    stage-packages:
      - libsecret-1-0
```

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

### LinuxOptions.params

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/LinuxOptions/params.html

Retrieves the configuration options as a Map<String, String> by invoking the toMap method.

```APIDOC
## LinuxOptions.params

### Description
A getter that retrieves the Linux storage configuration options as a map representation.

### Signature
`Map<String, String> get params`

### Returns
- **Map<String, String>** - A map containing the configuration options.
```

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

### WebOptions Constructor

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WebOptions-class.html

Creates an instance of `WebOptions` with configurable parameters for secure storage behavior on web platforms. You can customize the database name, public key, wrap key, wrap key IV, and whether to use session storage.

```APIDOC
## WebOptions Constructor

### Description
Creates an instance of `WebOptions` with configurable parameters for secure storage behavior on web platforms.

### Parameters
* **dbName** (String) - Optional - The name of the database used for secure storage. Defaults to `'FlutterEncryptedStorage'`.
* **publicKey** (String) - Optional - The public key used for encryption. Defaults to `'FlutterSecureStorage'`.
* **wrapKey** (String) - Optional - The key used to wrap the encryption key.
* **wrapKeyIv** (String) - Optional - The initialization vector (IV) used for the wrap key.
* **useSessionStorage** (bool) - Optional - Whether to use session storage instead of local storage. Defaults to `false`.
```

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

### defaultOptions Constant

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WebOptions-class.html

A predefined `WebOptions` instance with default settings, providing a convenient way to initialize secure storage with standard configurations.

```APIDOC
## defaultOptions Constant

### Description
A predefined `WebOptions` instance with default settings.

### Value
* **WebOptions** - An instance of `WebOptions` with default values for all parameters.
```

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

### AppleOptions Constructor Implementation

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AppleOptions/AppleOptions.html

The constructor initializes the configuration for keychain storage, allowing customization of account names, accessibility, and security flags.

```dart
const AppleOptions({
  this.accountName = AppleOptions.defaultAccountName,
  this.groupId,
  this.accessibility = KeychainAccessibility.unlocked,
  this.synchronizable = false,
  this.label,
  this.description,
  this.comment,
  this.isInvisible,
  this.isNegative,
  this.creationDate,
  this.lastModifiedDate,
  this.resultLimit,
  this.shouldReturnPersistentReference,
  this.authenticationUIBehavior,
  this.accessControlFlags = const [],
  this.useSecureEnclave = false,
});
```

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

### void setMockInitialValues(Map<String, String> values)

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/FlutterSecureStorage/setMockInitialValues.html

Initializes the secure storage platform with mock values for testing. This method is marked as visibleForTesting.

```APIDOC
## setMockInitialValues

### Description
Initializes the secure storage platform with mock values for testing. This method is intended for use in test environments.

### Signature
`static void setMockInitialValues(Map<String, String> values)`

### Parameters
- **values** (Map<String, String>) - Required - A map of key-value pairs to initialize the mock storage.
```

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

### AppleOptions.params

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AppleOptions/params.html

Retrieves the configuration options as a Map<String, String> by invoking the toMap method.

```APIDOC
## Property: params

### Description
A getter that retrieves the AppleOptions configuration as a map representation. This property internally calls the `toMap` method to convert the options into a map of key-value pairs.

### Signature
`Map<String, String> get params`

### Returns
- **Map<String, String>**: A map containing the configuration options.
```

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

### AndroidOptions.params

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AndroidOptions/params.html

Retrieves the configuration options as a Map<String, String>.

```APIDOC
## Property: params

### Description
A getter that retrieves the Android configuration options as a map representation. This property internally calls the `toMap` method to convert the options into a map of key-value pairs.

### Signature
`Map<String, String> get params`

### Returns
- **Map<String, String>**: A map containing the configuration options.
```

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

### WindowsOptions Methods

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WindowsOptions-class.html

Lists the methods available for the WindowsOptions class, including copying instances, handling non-existent methods, and converting to a map or string.

```APIDOC
## Methods

### copyWith

```dart
WindowsOptions copyWith({bool? useBackwardCompatibility})
```

#### Description

Creates a new instance of `WindowsOptions` by copying the current instance and replacing specified properties with new values.

#### Parameters

* **useBackwardCompatibility** (bool?) - Optional - The new value for `useBackwardCompatibility` to be used in the copied instance.

### noSuchMethod

```dart
dynamic noSuchMethod(Invocation invocation)
```

#### Description

Invoked when a nonexistent method or property is accessed. (Inherited from Object)

### toMap

```dart
Map<String, String> toMap()
```

#### Description

Converts the options into a map representation.

#### Returns

A `Map<String, String>` representing the options.
```

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

### IOSOptions Constructor Implementation

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/IOSOptions/IOSOptions.html

The constructor allows for granular control over keychain items, including accessibility levels, synchronization, and Secure Enclave usage.

```dart
const IOSOptions({
  super.accountName,
  super.groupId,
  super.accessibility,
  super.synchronizable,
  super.label,
  super.description,
  super.comment,
  super.isInvisible,
  super.isNegative,
  super.creationDate,
  super.lastModifiedDate,
  super.resultLimit,
  super.shouldReturnPersistentReference,
  super.authenticationUIBehavior,
  super.accessControlFlags,
  super.useSecureEnclave,
});
```

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

### WindowsOptions constructor

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WindowsOptions/WindowsOptions.html

Creates a new instance of WindowsOptions to configure storage behavior on Windows.

```APIDOC
## WindowsOptions

### Description
Configures the Windows storage provider. The `useBackwardCompatibility` flag enables reading from and migrating data written by previous versions of the storage.

### Constructor
`const WindowsOptions({bool useBackwardCompatibility = false})`

### Parameters
- **useBackwardCompatibility** (bool) - Optional - If true, attempts to read from and migrate data from previous storage versions. Defaults to false. Note: Must be false if keys contain restricted characters (\", <, >, |, :, *, ?, /, \\), path traversal sequences (/../, \\..\\), or exceed length limits.
```

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

### WebOptions.params

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WebOptions/params.html

Retrieves the configuration options as a Map<String, String> by invoking the toMap method.

```APIDOC
## Property: params

### Description
A getter that retrieves the configuration options as a map representation. This property internally calls the `toMap` method to convert the options into a map of key-value pairs.

### Signature
`Map<String, String> get params`

### Returns
- **Map<String, String>**: A map containing the configuration options.
```

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

### WindowsOptions Constructor

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WindowsOptions-class.html

Initializes WindowsOptions with optional backward compatibility settings. Backward compatibility can affect performance and key handling.

```APIDOC
## Constructors

### WindowsOptions

```dart
WindowsOptions({bool useBackwardCompatibility = false})
```

#### Description

Initializes `WindowsOptions`. If `useBackwardCompatibility` is set to `true`, the storage will attempt to read from and migrate values written by previous versions. This may introduce a performance hit and potential errors for certain keys. The default value is `false`.

**Important:** Set `useBackwardCompatibility` to `false` if your keys contain characters like `"`, `<`, `>`, `|`, `:`, `*`, `?`, `/`, `\`, or any ASCII control characters, or if keys contain `/../`, `\..`, or their combinations, or if keys are excessively long.

#### Parameters

* **useBackwardCompatibility** (bool) - Optional - If `true`, enables backward compatibility for reading and migrating values from previous storage versions. Defaults to `false`.
```

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

### Migrate legacy data with WindowsOptions

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WindowsOptions/WindowsOptions.html

Use this configuration when reading all values to enable automatic migration from previous storage versions.

```dart
await FlutterSecureStorage().readAll(
    const WindowsOptions(useBackwardCompatibility: true),
);
```

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

### AndroidOptions Constructor

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AndroidOptions-class.html

Creates a standard secure storage configuration for Android using AES-GCM with RSA OAEP key wrapping.

```APIDOC
## AndroidOptions({bool resetOnError, bool migrateOnAlgorithmChange, bool migrateWithBackup, bool enforceBiometrics, KeyCipherAlgorithm keyCipherAlgorithm, StorageCipherAlgorithm storageCipherAlgorithm, AndroidBiometricType biometricType, bool requireBiometricConfirmation, String? preferencesKeyPrefix, String? storageNamespace, String? biometricPromptTitle, String? biometricPromptSubtitle, String? biometricPromptNegativeButton})

### Description
Initializes a new instance of AndroidOptions with standard secure storage settings.

### Parameters
- **resetOnError** (bool) - Optional - Resets storage if an error occurs.
- **migrateOnAlgorithmChange** (bool) - Optional - Migrates data if the encryption algorithm changes.
- **migrateWithBackup** (bool) - Optional - Enables migration with backup.
- **enforceBiometrics** (bool) - Optional - Whether to enforce biometric authentication.
- **keyCipherAlgorithm** (KeyCipherAlgorithm) - Optional - The algorithm used for key wrapping.
- **storageCipherAlgorithm** (StorageCipherAlgorithm) - Optional - The algorithm used for storage encryption.
- **biometricType** (AndroidBiometricType) - Optional - The type of biometric authentication required.
- **requireBiometricConfirmation** (bool) - Optional - Whether user confirmation is required for biometrics.
- **preferencesKeyPrefix** (String?) - Optional - Prefix for shared preference keys.
- **storageNamespace** (String?) - Optional - Namespace for storage isolation.
- **biometricPromptTitle** (String?) - Optional - Title for the biometric prompt.
- **biometricPromptSubtitle** (String?) - Optional - Subtitle for the biometric prompt.
- **biometricPromptNegativeButton** (String?) - Optional - Label for the cancel button in the biometric prompt.
```

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

### LinuxOptions Methods

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/LinuxOptions-class.html

Lists the methods available for the LinuxOptions class, including overridden and inherited ones.

```APIDOC
## Methods

### noSuchMethod(Invocation invocation) → dynamic

- **Description**: Invoked when a nonexistent method or property is accessed.
- **Inherited**: true

### toMap() → Map<String, String>

- **Description**: Converts the `LinuxOptions` instance into a map representation.
- **Override**: true

### toString() → String

- **Description**: A string representation of this object.
- **Inherited**: true
```

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

### LinuxOptions Constructors

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/LinuxOptions-class.html

Provides information about the constructors available for the LinuxOptions class.

```APIDOC
## Constructors

### LinuxOptions()

- **Description**: Creates an instance of `LinuxOptions` with no additional configuration.
- **Const**: true
```

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

### TestFlutterSecureStoragePlatform Constructors

Source: https://pub.dev/documentation/flutter_secure_storage/latest/test_test_flutter_secure_storage_platform/TestFlutterSecureStoragePlatform-class.html

Provides information on how to create an instance of TestFlutterSecureStoragePlatform.

```APIDOC
## TestFlutterSecureStoragePlatform(Map<String, String> data)

### Description
Creates an instance of `TestFlutterSecureStoragePlatform` with an in-memory data store.

### Parameters
#### Path Parameters
- **data** (Map<String, String>) - Required - The initial in-memory data store.
```

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

### MacOsOptions.defaultOptions

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/MacOsOptions-class.html

Provides a predefined `MacosOptions` instance with default settings for macOS secure storage.

```APIDOC
## MacOsOptions.defaultOptions

### Description
A predefined `MacosOptions` instance with default settings. This constant can be used to initialize secure storage operations on macOS with standard configurations.

### Type
`const MacOsOptions`
```

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

### WindowsOptions.copyWith

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WindowsOptions/copyWith.html

Creates a new instance of WindowsOptions by copying the current instance and replacing specified properties with new values.

```APIDOC
## WindowsOptions.copyWith

### Signature
`WindowsOptions copyWith({bool? useBackwardCompatibility})`

### Description
Creates a new instance of `WindowsOptions` by copying the current instance and replacing specified properties with new values.

### Parameters
- **useBackwardCompatibility** (bool?) - Optional - A flag to determine if backward compatibility should be enabled in the new instance.
```

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

### TestFlutterSecureStoragePlatform constructor

Source: https://pub.dev/documentation/flutter_secure_storage/latest/test_test_flutter_secure_storage_platform/TestFlutterSecureStoragePlatform/TestFlutterSecureStoragePlatform.html

Creates an instance of TestFlutterSecureStoragePlatform with an in-memory data store.

```APIDOC
## TestFlutterSecureStoragePlatform

### Description
Creates an instance of `TestFlutterSecureStoragePlatform` with an in-memory data store.

### Parameters
- **data** (Map<String, String>) - Required - A map representing the in-memory storage for key-value pairs.

### Implementation
```dart
TestFlutterSecureStoragePlatform(this.data);
```
```

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

### Accessing the defaultOptions constant

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/LinuxOptions/defaultOptions-constant.html

Use this constant to initialize LinuxOptions with default settings when no custom configuration is needed.

```dart
static const LinuxOptions defaultOptions = LinuxOptions();
```

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

### MacOsOptions Constructor

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/MacOsOptions-class.html

Creates an instance of MacOsOptions with configurable parameters for keychain access and storage behavior on macOS.

```APIDOC
## MacOsOptions

### Description

Creates an instance of `MacosOptions` with configurable parameters for keychain access and storage behavior.

### Parameters

* **accountName** (String?) - Optional - The service or application name associated with the item. Defaults to `AppleOptions.defaultAccountName`.
* **groupId** (String?) - Optional - Specifies the app group for shared access.
* **accessibility** (KeychainAccessibility?) - Optional - Defines the accessibility level of the keychain item. Defaults to `KeychainAccessibility.unlocked`.
* **synchronizable** (bool) - Optional - Indicates whether the keychain item should be synchronized with iCloud. Defaults to `false`.
* **label** (String?) - Optional - A user-visible label for the keychain item.
* **description** (String?) - Optional - A description of the keychain item.
* **comment** (String?) - Optional - A comment associated with the keychain item.
* **isInvisible** (bool?) - Optional - Indicates whether the keychain item is hidden from user-visible lists.
* **isNegative** (bool?) - Optional - Indicates whether the item is a placeholder or a negative entry.
* **creationDate** (DateTime?) - Optional - The creation date of the keychain item.
* **lastModifiedDate** (DateTime?) - Optional - The last modification date of the keychain item.
* **resultLimit** (int?) - Optional - Specifies the maximum number of results to return in a query.
* **shouldReturnPersistentReference** (bool?) - Optional - Indicates whether to return a persistent reference to the keychain item.
* **authenticationUIBehavior** (String?) - Optional - Controls how authentication UI is presented during secure operations.
* **accessControlFlags** (List<AccessControlFlag>) - Optional - Keychain access control flags that define security conditions. Defaults to an empty list.
* **usesDataProtectionKeychain** (bool) - Optional - Indicates whether the macOS data protection keychain is used. Defaults to `true`.
* **useSecureEnclave** (bool) - Optional - When true, opts into Secure Enclave-backed protection on iOS/macOS. Defaults to `false`.
```

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

### AppleOptions Methods

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AppleOptions-class.html

Methods available on the AppleOptions class.

```APIDOC
## Methods

* **toMap() → Map<String, String>**
  Converts the options into a map representation.

* **noSuchMethod(Invocation invocation) → dynamic**
  Invoked when a nonexistent method or property is accessed.
```

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

### Accessing the defaultOptions constant

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WebOptions/defaultOptions-constant.html

Use this constant to initialize WebOptions with default settings when no custom configuration is needed.

```dart
static const WebOptions defaultOptions = WebOptions();
```

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

### Implement MacOsOptions constructor

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/MacOsOptions/MacOsOptions.html

Defines the constructor for MacOsOptions with various configuration parameters for keychain interaction.

```dart
const MacOsOptions({
  super.accountName,
  super.groupId,
  super.accessibility,
  super.synchronizable,
  super.label,
  super.description,
  super.comment,
  super.isInvisible,
  super.isNegative,
  super.creationDate,
  super.lastModifiedDate,
  super.resultLimit,
  super.shouldReturnPersistentReference,
  super.authenticationUIBehavior,
  super.accessControlFlags,
  this.usesDataProtectionKeychain = true,
  super.useSecureEnclave = false,
});
```

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

### Set mock initial values for testing

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/FlutterSecureStorage/setMockInitialValues.html

Initializes the secure storage platform with a provided map of mock values. This method is marked with @visibleForTesting and should only be used in test environments.

```dart
@visibleForTesting
static void setMockInitialValues(Map<String, String> values) {
  FlutterSecureStoragePlatform.instance = TestFlutterSecureStoragePlatform(
    values,
  );
}
```

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

### Initialize Secure Storage Instance

Source: https://pub.dev/documentation/flutter_secure_storage/latest/index.html

Create a storage instance with optional Android-specific configurations, including biometric support.

```dart
// Default secure storage - Uses RSA OAEP + AES-GCM (recommended)
final storage = FlutterSecureStorage();

// Or with explicit Android options
final storage = FlutterSecureStorage(
  aOptions: AndroidOptions(),
);

// Biometric storage with graceful degradation
final storage = FlutterSecureStorage(
  aOptions: AndroidOptions.biometric(
    enforceBiometrics: false, // Works without biometrics
    biometricPromptTitle: 'Authenticate to access data',
  ),
);

// Strict biometric enforcement (requires device security)
final storage = FlutterSecureStorage(
  aOptions: AndroidOptions.biometric(
    enforceBiometrics: true, // Requires biometric/PIN/pattern
    biometricPromptTitle: 'Authentication Required',
  ),
);
```

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

### Implementation of the read method

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/FlutterSecureStorage/read.html

This snippet shows the internal implementation of the read method, which delegates to the platform-specific storage provider.

```dart
Future<String?> read({
  required String key,
  AppleOptions? iOptions,
  AndroidOptions? aOptions,
  LinuxOptions? lOptions,
  WebOptions? webOptions,
  AppleOptions? mOptions,
  WindowsOptions? wOptions,
}) => _platform.read(
  key: key,
  options: _selectOptions(
    iOptions,
    aOptions,
    lOptions,
    webOptions,
    mOptions,
    wOptions,
  ),
);
```

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

### Run Integration Tests

Source: https://pub.dev/documentation/flutter_secure_storage/latest/index.html

Executes the integration tests located in the test_driver directory.

```bash
flutter drive --target=test_driver/app.dart
```

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

### Implementation of readAll

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/FlutterSecureStorage/readAll.html

The internal implementation of the readAll method, showing how platform-specific options are selected and passed to the platform interface.

```dart
Future<Map<String, String>> readAll({
  AppleOptions? iOptions,
  AndroidOptions? aOptions,
  LinuxOptions? lOptions,
  WebOptions? webOptions,
  AppleOptions? mOptions,
  WindowsOptions? wOptions,
}) => _platform.readAll(
  options: _selectOptions(
    iOptions,
    aOptions,
    lOptions,
    webOptions,
    mOptions,
    wOptions,
  ),
);
```

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

### AndroidOptions constructor

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AndroidOptions/AndroidOptions.html

Initializes the Android-specific configuration for secure storage, allowing customization of encryption algorithms and biometric requirements.

```APIDOC
## AndroidOptions()

### Description
Creates a new instance of AndroidOptions to configure secure storage behavior on Android devices.

### Parameters
- **resetOnError** (bool) - Optional - Whether to reset storage if an error occurs. Defaults to true.
- **migrateOnAlgorithmChange** (bool) - Optional - Whether to migrate data when the algorithm changes. Defaults to true.
- **migrateWithBackup** (bool) - Optional - Whether to perform migration with a backup. Defaults to false.
- **enforceBiometrics** (bool) - Optional - Whether to enforce biometric authentication. Defaults to false.
- **keyCipherAlgorithm** (KeyCipherAlgorithm) - Optional - The algorithm used for key protection. Defaults to RSA_ECB_OAEPwithSHA_256andMGF1Padding.
- **storageCipherAlgorithm** (StorageCipherAlgorithm) - Optional - The algorithm used for data encryption. Defaults to AES_GCM_NoPadding.
- **biometricType** (AndroidBiometricType) - Optional - The type of biometric authentication required. Defaults to biometricOrDeviceCredential.
- **requireBiometricConfirmation** (bool) - Optional - Whether biometric confirmation is required. Defaults to true.
- **preferencesKeyPrefix** (String?) - Optional - A prefix for preference keys.
- **storageNamespace** (String?) - Optional - A namespace for the storage.
- **biometricPromptTitle** (String?) - Optional - Title for the biometric prompt.
- **biometricPromptSubtitle** (String?) - Optional - Subtitle for the biometric prompt.
- **biometricPromptNegativeButton** (String?) - Optional - Text for the negative button in the biometric prompt.
```

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

### LinuxOptions Constants

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/LinuxOptions-class.html

Information about the predefined constants for the LinuxOptions class.

```APIDOC
## Constants

### defaultOptions → const LinuxOptions

- **Description**: A predefined `LinuxOptions` instance with default settings.
```

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

### WindowsOptions.defaultOptions

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WindowsOptions/defaultOptions-constant.html

A static constant representing the default configuration for Windows secure storage.

```APIDOC
## WindowsOptions.defaultOptions

### Description
A predefined `WindowsOptions` instance with default settings. This can be used as a fallback or when no specific options are required for secure storage on Windows.

### Signature
`static const WindowsOptions defaultOptions = WindowsOptions();`
```

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

### TestFlutterSecureStoragePlatform Methods

Source: https://pub.dev/documentation/flutter_secure_storage/latest/test_test_flutter_secure_storage_platform/TestFlutterSecureStoragePlatform-class.html

Details on the methods available for interacting with the in-memory secure storage.

```APIDOC
## containsKey({required String key, required Map<String, String> options})

### Description
Checks whether a key exists in secure storage.

### Method
Future<bool>

### Parameters
#### Path Parameters
- **key** (String) - Required - The key to check for.
- **options** (Map<String, String>) - Required - Additional options for the operation.
```

```APIDOC
## delete({required String key, required Map<String, String> options})

### Description
Deletes a key-value pair from secure storage.

### Method
Future<void>

### Parameters
#### Path Parameters
- **key** (String) - Required - The key of the entry to delete.
- **options** (Map<String, String>) - Required - Additional options for the operation.
```

```APIDOC
## deleteAll({required Map<String, String> options})

### Description
Deletes all key-value pairs from secure storage.

### Method
Future<void>

### Parameters
#### Path Parameters
- **options** (Map<String, String>) - Required - Additional options for the operation.
```

```APIDOC
## read({required String key, required Map<String, String> options})

### Description
Reads a value from secure storage by its key.

### Method
Future<String?>

### Parameters
#### Path Parameters
- **key** (String) - Required - The key of the value to read.
- **options** (Map<String, String>) - Required - Additional options for the operation.
```

```APIDOC
## readAll({required Map<String, String> options})

### Description
Reads all key-value pairs from secure storage.

### Method
Future<Map<String, String>>

### Parameters
#### Path Parameters
- **options** (Map<String, String>) - Required - Additional options for the operation.
```

```APIDOC
## write({required String key, required String value, required Map<String, String> options})

### Description
Writes a key-value pair to secure storage.

### Method
Future<void>

### Parameters
#### Path Parameters
- **key** (String) - Required - The key for the value.
- **value** (String) - Required - The value to store.
- **options** (Map<String, String>) - Required - Additional options for the operation.
```

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

### Map<String, String> toMap()

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AppleOptions/toMap.html

Converts the AppleOptions configuration properties into a map representation. This method is intended to be used to serialize the options for the secure storage plugin.

```APIDOC
## Map<String, String> toMap()

### Description
Converts the current AppleOptions configuration into a Map<String, String> format. This is used to pass configuration settings to the underlying platform storage implementation.

### Returns
- **Map<String, String>** - A map containing the configuration options such as accountName, groupId, accessibility, and other Apple-specific security settings.
```

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

### Accessing the defaultOptions constant

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/IOSOptions/defaultOptions-constant.html

Use this constant to initialize IOSOptions with default settings when no custom configuration is needed.

```dart
static const IOSOptions defaultOptions = IOSOptions();
```

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

### WindowsOptions Constants

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WindowsOptions-class.html

Highlights the predefined constant `defaultOptions` for the WindowsOptions class.

```APIDOC
## Constants

### defaultOptions

```dart
static const WindowsOptions defaultOptions
```

#### Description

A predefined `WindowsOptions` instance with default settings.
```

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

### Map<String, String> toMap()

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/LinuxOptions/toMap.html

Converts the LinuxOptions instance into a map representation. This method overrides the base Options.toMap implementation.

```APIDOC
## Method: toMap

### Description
Converts the `LinuxOptions` instance into a map representation. This method is an override of `Options.toMap`.

### Signature
`Map<String, String> toMap()`

### Returns
- **Map<String, String>** - An empty map, as `LinuxOptions` does not require additional configuration.
```

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

### Configure Web Storage with Application-Specific Key

Source: https://pub.dev/documentation/flutter_secure_storage/latest/index.html

Wraps the stored key in LocalStorage with an application-specific key and IV to enhance security on web platforms.

```dart
final _storage = const FlutterSecureStorage(
  webOptions: WebOptions(
    wrapKey: '${your_application_specific_key}',
    wrapKeyIv: '${your_application_specific_iv}',
  ),
);
```

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

### Map<String, String> toMap()

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/WindowsOptions/toMap.html

Converts the WindowsOptions configuration properties into a map. This method is intended to be used to serialize the configuration settings.

```APIDOC
## Map<String, String> toMap()

### Description
Converts the WindowsOptions configuration properties into a map representation. This method is typically used to serialize the configuration for storage or processing.

### Returns
- **Map<String, String>** - A map containing the configuration options, specifically including the 'useBackwardCompatibility' setting.
```

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

### write

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/FlutterSecureStorage-class.html

Encrypts and saves a key-value pair to secure storage. Platform-specific options can be provided.

```APIDOC
## write({required String key, required String? value, AppleOptions? iOptions, AndroidOptions? aOptions, LinuxOptions? lOptions, WebOptions? webOptions, AppleOptions? mOptions, WindowsOptions? wOptions})

### Description
Encrypts and saves the `key` with the given `value`.

### Parameters
- **key** (String) - Required - The key under which to store the value.
- **value** (String?) - Required - The value to encrypt and store.
- **iOptions** (AppleOptions) - Optional - Platform-specific options for iOS.
- **aOptions** (AndroidOptions) - Optional - Platform-specific options for Android.
- **lOptions** (LinuxOptions) - Optional - Platform-specific options for Linux.
- **webOptions** (WebOptions) - Optional - Platform-specific options for Web.
- **mOptions** (AppleOptions) - Optional - Platform-specific options for macOS.
- **wOptions** (WindowsOptions) - Optional - Platform-specific options for Windows.

### Returns
- Future<void>
```

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

### Initialize TestFlutterSecureStoragePlatform

Source: https://pub.dev/documentation/flutter_secure_storage/latest/test_test_flutter_secure_storage_platform/TestFlutterSecureStoragePlatform/TestFlutterSecureStoragePlatform.html

Instantiates the platform mock using a provided map for key-value storage.

```dart
TestFlutterSecureStoragePlatform(this.data);
```

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

### Future<Map<String, String>> readAll({AppleOptions? iOptions, AndroidOptions? aOptions, LinuxOptions? lOptions, WebOptions? webOptions, AppleOptions? mOptions, WindowsOptions? wOptions})

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/FlutterSecureStorage/readAll.html

Decrypts and returns all keys with associated values from secure storage. This method can throw a PlatformException if an error occurs during the retrieval process.

```APIDOC
## Method Signature
`Future<Map<String, String>> readAll({AppleOptions? iOptions, AndroidOptions? aOptions, LinuxOptions? lOptions, WebOptions? webOptions, AppleOptions? mOptions, WindowsOptions? wOptions})`

### Description
Decrypts and returns all keys with associated values stored in the secure storage. The method allows for platform-specific configuration via optional parameters.

### Parameters
- **iOptions** (AppleOptions) - Optional: iOS specific configuration options.
- **aOptions** (AndroidOptions) - Optional: Android specific configuration options.
- **lOptions** (LinuxOptions) - Optional: Linux specific configuration options.
- **webOptions** (WebOptions) - Optional: Web specific configuration options.
- **mOptions** (AppleOptions) - Optional: macOS specific configuration options.
- **wOptions** (WindowsOptions) - Optional: Windows specific configuration options.

### Returns
- **Future<Map<String, String>>** - A map containing all stored keys and their corresponding values.

### Exceptions
- **PlatformException** - Thrown if the underlying platform fails to retrieve the data.
```

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

### Implement toMap for AndroidOptions

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AndroidOptions/toMap.html

This implementation maps Android configuration properties to a Map<String, String> format.

```dart
@override
Map<String, String> toMap() => <String, String>{
  'resetOnError': '$_resetOnError',
  'migrateOnAlgorithmChange': '$_migrateOnAlgorithmChange',
  'migrateWithBackup': '$_migrateWithBackup',
  'enforceBiometrics': '$_enforceBiometrics',
  'keyCipherAlgorithm': _keyCipherAlgorithm.name,
  'storageCipherAlgorithm': _storageCipherAlgorithm.name,
  'biometricType': _biometricType.name,
  'requireBiometricConfirmation': '$_requireBiometricConfirmation',
  'preferencesKeyPrefix': preferencesKeyPrefix ?? '',
  'storageNamespace': storageNamespace ?? '',
  'biometricPromptTitle': biometricPromptTitle ?? 'Authenticate to access',
  'biometricPromptSubtitle':
      biometricPromptSubtitle ?? 'Use biometrics or device credentials',
  'biometricPromptNegativeButton': biometricPromptNegativeButton ?? 'Cancel',
};
```

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

### Future<void> write({required String key, required String value, required Map<String, String> options})

Source: https://pub.dev/documentation/flutter_secure_storage/latest/test_test_flutter_secure_storage_platform/TestFlutterSecureStoragePlatform/write.html

Writes a key-value pair to secure storage. Returns a Future that completes when the write operation finishes.

```APIDOC
## write

### Description
Writes a key-value pair to secure storage.

### Signature
`Future<void> write({required String key, required String value, required Map<String, String> options})`

### Parameters
- **key** (String) - Required - The key to identify the stored value.
- **value** (String) - Required - The value to store.
- **options** (Map<String, String>) - Required - A map of platform-specific options for the write operation.

### Returns
- **Future<void>** - A Future that completes when the write operation finishes.
```

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

### void registerListener({required String key, required ValueChanged<String?> listener})

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/FlutterSecureStorage/registerListener.html

Registers a listener for a specific key. The listener is invoked with the new value when the key is updated, or with null when the key is deleted.

```APIDOC
## void registerListener({required String key, required ValueChanged<String?> listener})

### Description
Registers a `listener` for a specific `key`. The provided listener will be triggered whenever the value for the key changes, or when the key is deleted (in which case the listener receives null).

### Parameters
- **key** (String) - Required - The key to monitor for changes.
- **listener** (ValueChanged<String?>) - Required - The callback function to execute when the key's value changes or is deleted.
```

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

### AppleOptions.description

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AppleOptions/description.html

The description property is a String that maps to the kSecAttrDescription attribute in the Apple Keychain. It can be used to provide a label or category for the stored item.

```APIDOC
## AppleOptions.description

### Description
A string property that maps to the `kSecAttrDescription` attribute in the Apple Keychain. It is used to provide a description for the keychain item, which can be shared across a category of items or unique to a specific entry.

### Type
`String?`

### Usage
This property is part of the `AppleOptions` configuration used when interacting with the secure storage on iOS/macOS platforms.
```

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

### IOSOptions.toMap

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/IOSOptions-class.html

Converts the options into a map representation.

```APIDOC
## toMap()

### Description
Converts the options into a map representation.

### Returns
`Map<String, String>` - A map containing the options.
```

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

### AndroidOptions.biometric Implementation

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AndroidOptions/AndroidOptions.biometric.html

The constructor initializes secure storage options including biometric authentication settings and encryption algorithms.

```dart
const AndroidOptions.biometric({
  bool resetOnError = true,
  bool migrateOnAlgorithmChange = true,
  bool migrateWithBackup = false,
  bool enforceBiometrics = false,
  AndroidBiometricType biometricType =
      AndroidBiometricType.biometricOrDeviceCredential,
  bool requireBiometricConfirmation = true,
  this.preferencesKeyPrefix,
  this.storageNamespace,
  this.biometricPromptTitle,
  this.biometricPromptSubtitle,
  this.biometricPromptNegativeButton,
}) : _resetOnError = resetOnError,
     _migrateOnAlgorithmChange = migrateOnAlgorithmChange,
     _migrateWithBackup = migrateWithBackup,
     _enforceBiometrics = enforceBiometrics,
     _keyCipherAlgorithm = KeyCipherAlgorithm.AES_GCM_NoPadding,
     _storageCipherAlgorithm = StorageCipherAlgorithm.AES_GCM_NoPadding,
     _biometricType = biometricType,
     _requireBiometricConfirmation = requireBiometricConfirmation;
```

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

### IOSOptions.defaultOptions

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/IOSOptions/defaultOptions-constant.html

A static constant providing a default instance of IOSOptions. This is useful when no custom configuration is required for secure storage on iOS.

```APIDOC
## IOSOptions.defaultOptions

### Description
A predefined `IOSOptions` instance with default settings. This can be used as a fallback or when no specific options are required for iOS secure storage.

### Signature
`static const IOSOptions defaultOptions = IOSOptions();`
```

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

### Future<void> delete({required String key, AppleOptions? iOptions, AndroidOptions? aOptions, LinuxOptions? lOptions, WebOptions? webOptions, AppleOptions? mOptions, WindowsOptions? wOptions})

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/FlutterSecureStorage/delete.html

Deletes the value associated with the provided key. If the key does not exist, the operation completes without error.

```APIDOC
## delete(key, [options])

### Description
Deletes the value associated with the given `key`. If the key does not exist, no action is taken.

### Parameters
- **key** (String) - Required - The key of the value to delete.
- **iOptions** (AppleOptions) - Optional - iOS specific configuration.
- **aOptions** (AndroidOptions) - Optional - Android specific configuration.
- **lOptions** (LinuxOptions) - Optional - Linux specific configuration.
- **webOptions** (WebOptions) - Optional - Web specific configuration.
- **mOptions** (AppleOptions) - Optional - macOS specific configuration.
- **wOptions** (WindowsOptions) - Optional - Windows specific configuration.

### Exceptions
- **PlatformException** - Thrown if the underlying platform operation fails.
```

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

### Define preferencesKeyPrefix implementation

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AndroidOptions/preferencesKeyPrefix.html

The property is defined as a nullable String within the AndroidOptions configuration.

```dart
final String? preferencesKeyPrefix;
```

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

### Map<String, String> toMap()

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/IOSOptions/toMap.html

Converts the IOSOptions configuration into a map representation. This method is intended to be used to retrieve the current configuration settings as a key-value map.

```APIDOC
## Method Signature

### Map<String, String> toMap()

### Description
Converts the configuration options into a map representation. This method is intended to be overridden by subclasses to provide a specific mapping of their configuration properties.

### Returns
- **Map<String, String>** - A map containing the configuration options.
```

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

### Define WindowsOptions wOptions

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/FlutterSecureStorage/wOptions.html

Declaration of the WindowsOptions property for platform-specific configuration.

```dart
final WindowsOptions wOptions;
```

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

### LinuxOptions Properties

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/LinuxOptions-class.html

Details the properties available for the LinuxOptions class, including inherited ones.

```APIDOC
## Properties

### hashCode → int

- **Description**: The hash code for this object.
- **Inherited**: true

### params → Map<String, String>

- **Description**: A getter that retrieves the options as a map representation.
- **Inherited**: true

### runtimeType → Type

- **Description**: A representation of the runtime type of the object.
- **Inherited**: true
```

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

### AndroidOptions.copyWith

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/AndroidOptions/copyWith.html

Creates a copy of the current AndroidOptions instance with the specified fields replaced.

```APIDOC
## AndroidOptions.copyWith

### Description
Creates a copy of this AndroidOptions instance with the given fields replaced. This is useful for updating specific configuration settings while keeping others unchanged.

### Signature
`AndroidOptions copyWith({bool? resetOnError, bool? migrateOnAlgorithmChange, bool? migrateWithBackup, bool? enforceBiometrics, KeyCipherAlgorithm? keyCipherAlgorithm, StorageCipherAlgorithm? storageCipherAlgorithm, AndroidBiometricType? biometricType, bool? requireBiometricConfirmation, String? preferencesKeyPrefix, String? storageNamespace, String? biometricPromptTitle, String? biometricPromptSubtitle, String? biometricPromptNegativeButton})`

### Parameters
- **resetOnError** (bool?) - Optional - Whether to reset storage on error.
- **migrateOnAlgorithmChange** (bool?) - Optional - Whether to migrate data when the algorithm changes.
- **migrateWithBackup** (bool?) - Optional - Whether to include backups during migration.
- **enforceBiometrics** (bool?) - Optional - Whether to enforce biometric authentication.
- **keyCipherAlgorithm** (KeyCipherAlgorithm?) - Optional - The algorithm used for key encryption.
- **storageCipherAlgorithm** (StorageCipherAlgorithm?) - Optional - The algorithm used for storage encryption.
- **biometricType** (AndroidBiometricType?) - Optional - The type of biometric authentication to use.
- **requireBiometricConfirmation** (bool?) - Optional - Whether biometric confirmation is required.
- **preferencesKeyPrefix** (String?) - Optional - Prefix for preferences keys.
- **storageNamespace** (String?) - Optional - Namespace for storage.
- **biometricPromptTitle** (String?) - Optional - Title for the biometric prompt.
- **biometricPromptSubtitle** (String?) - Optional - Subtitle for the biometric prompt.
- **biometricPromptNegativeButton** (String?) - Optional - Text for the negative button in the biometric prompt.
```

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

### Map<String, String> toMap()

Source: https://pub.dev/documentation/flutter_secure_storage/latest/flutter_secure_storage/MacOsOptions/toMap.html

Converts the MacOsOptions configuration into a map representation for internal use.

```APIDOC
## Map<String, String> toMap()

### Description
Converts the MacOsOptions configuration properties into a map representation. This method is used to serialize the options for storage configuration.

### Returns
- **Map<String, String>** - A map containing the configuration options, including 'usesDataProtectionKeychain'.
```
Tokens:
Raw