IOSOptions class

Specific options for iOS platform. Currently there are no specific ios options available, but only shared options from apple options.

Inheritance

• Object
• Options
• AppleOptions
• IOSOptions

Constructors

IOSOptions.new({String? accountName = AppleOptions.defaultAccountName, String? groupId, KeychainAccessibility? accessibility = KeychainAccessibility.unlocked, bool synchronizable = false, String? label, String? description, String? comment, bool? isInvisible, bool? isNegative, DateTime? creationDate, DateTime? lastModifiedDate, int? resultLimit, bool? shouldReturnPersistentReference, String? authenticationUIBehavior, List<AccessControlFlag> accessControlFlags = const []})

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

const

Properties

accessControlFlags → List<AccessControlFlag>

Keychain access control flags define security conditions for accessing items. These flags can be combined to create custom security policies.

final, inherited

accessibility → KeychainAccessibility?

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).

final, inherited

accountName → String?

kSecAttrService: Shared. Represents the service or application name associated with the item. Typically used to group related keychain items.

final, inherited

authenticationUIBehavior → String?

kSecUseAuthenticationUI: Shared. Controls how authentication UI is presented during secure operations. Determines whether authentication prompts are displayed to the user.

final, inherited

comment → String?

kSecAttrComment: Shared or Unique. A comment associated with the keychain item. Often used for metadata or debugging information.

final, inherited

creationDate → DateTime?

kSecAttrCreationDate: Unique. The creation date of the keychain item. Automatically set by the system when an item is created.

final, inherited

description → String?

kSecAttrDescription: Shared or Unique. A description of the keychain item. Can describe a category of items (shared) or be specific to a single item.

final, inherited

groupId → String?

kSecAttrAccessGroup: Shared. Specifies the app group for shared access. Allows multiple apps in the same app group to access the item.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isInvisible → bool?

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).

final, inherited

isNegative → bool?

kSecAttrIsNegative: Unique. Indicates whether the item is a placeholder or a negative entry. Typically unique to individual keychain items.

final, inherited

label → String?

kSecAttrLabel: Unique. A user-visible label for the keychain item. Helps identify the item in keychain management tools.

final, inherited

lastModifiedDate → DateTime?

kSecAttrModificationDate: Unique. The last modification date of the keychain item. Automatically updated when an item is modified.

final, inherited

params → Map<String, String>

A getter that retrieves the options as a map representation.

no setter, inherited

resultLimit → int?

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.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shouldReturnPersistentReference → bool?

kSecReturnPersistentRef: Action-Specific. Indicates whether to return a persistent reference to the keychain item. Used for persistent access across app sessions.

final, inherited

synchronizable → bool

kSecAttrSynchronizable: Shared. Indicates whether the keychain item should be synchronized with iCloud. true enables synchronization, false disables it.

final, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, String>

Converts the options into a map representation.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

defaultOptions → const IOSOptions

A predefined IosOptions instance with default settings.