API

Public methods, result types, error types, and events that @capacitor/docgen resolves from @capacitor-community/stripe-identity v8.2.0.

addListener is generated for the three supported event names: Loaded, FailedToLoad, and VerificationResult. Completed, Canceled, and Failed are values of IdentityVerificationResult.result (IdentityVerificationSheetResultInterface). They are not separately supported addListener overloads.

Methods

method initialize(...)

initialize(options: InitializeIdentityVerificationSheetOption) => Promise<void>

method create(...)

create(options: CreateIdentityVerificationSheetOption) => Promise<void>

method present()

present() => Promise<void>

method addListener(IdentityVerificationSheetEventsEnum.Loaded, ...)

addListener(eventName: IdentityVerificationSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

method addListener(IdentityVerificationSheetEventsEnum.FailedToLoad, ...)

addListener(eventName: IdentityVerificationSheetEventsEnum.FailedToLoad, listenerFunc: (info: StripeIdentityError) => void) => Promise<PluginListenerHandle>

method addListener(IdentityVerificationSheetEventsEnum.VerificationResult, ...)

addListener(eventName: IdentityVerificationSheetEventsEnum.VerificationResult, listenerFunc: (result: IdentityVerificationResult) => void) => Promise<PluginListenerHandle>

Interfaces

interface InitializeIdentityVerificationSheetOption

Prop	Type
publishableKey	string

interface CreateIdentityVerificationSheetOption

Prop	Type	Description
verificationId	string
ephemeralKeySecret	string
clientSecret	string	This client secret is used only for the web platform.

interface IdentityVerificationResult

Prop	Type
result	IdentityVerificationSheetResultInterface
error	StripeIdentityError

interface StripeIdentityError

Prop	Type
code	string
message	string

interface PluginListenerHandle

Prop	Type
remove	() => Promise<void>

Type aliases

type alias IdentityVerificationSheetResultInterface

IdentityVerificationSheetEventsEnum.Completed | IdentityVerificationSheetEventsEnum.Canceled | IdentityVerificationSheetEventsEnum.Failed

Enums

enum IdentityVerificationSheetEventsEnum

Member	Value
Loaded	'identityVerificationSheetLoaded'
FailedToLoad	'identityVerificationSheetFailedToLoad'
Completed	'identityVerificationSheetCompleted'
Canceled	'identityVerificationSheetCanceled'
Failed	'identityVerificationSheetFailed'
VerificationResult	'identityVerificationResult'