Skip to main content

Type Alias: SetOptions

SetOptions: object & BaseOptions & AccessControlOption

Base options for keychain functions.

Type declaration​

accessGroup?​

optional accessGroup: string

The access group to share keychain items between apps.

Platform​

iOS, visionOS

accessible?​

optional accessible: ACCESSIBLE

Specifies when a keychain item is accessible.

Platform​

iOS, visionOS

Default​

ACCESSIBLE.AFTER_FIRST_UNLOCK

authenticationPrompt?​

optional authenticationPrompt: string | AuthenticationPrompt

Authentication prompt details or a title string.

Default​

{
  "title": "Authenticate to retrieve secret",
  "cancel": "Cancel"
}

securityLevel?​

optional securityLevel: SECURITY_LEVEL

The desired security level of the keychain item.

Platform​

Android

storage?​

optional storage: STORAGE_TYPE

The storage type.

Platform​

Android

Default​

'Best available storage'

Defined in​

types.ts:44