Skip to main content
Version: 9.0.x

Type Alias: BaseOptions

BaseOptions: object

Base options for keychain functions.

Type declaration​

accessControl?​

optional accessControl: ACCESS_CONTROL

The access control policy to use for the keychain item.

accessGroup?​

optional accessGroup: string

The access group to share keychain items between apps (iOS and visionOS only).

accessible?​

optional accessible: ACCESSIBLE

Specifies when a keychain item is accessible (iOS and visionOS only).

authenticationType?​

optional authenticationType: AUTHENTICATION_TYPE

Authentication type for retrieving keychain item (iOS and visionOS only).

rules?​

optional rules: SECURITY_RULES

The security rules to apply when storing the keychain item (Android only).

securityLevel?​

optional securityLevel: SECURITY_LEVEL

The desired security level of the keychain item.

service?​

optional service: string

The service name to associate with the keychain item.

storage?​

optional storage: STORAGE_TYPE

The storage type (Android only).

Defined in​

index.ts:124