Zum Inhalt springen
rdlabo.devdocs

API

Öffentliche Methoden, Ergebnistypen, Fehlertypen und Ereignisse, die @capacitor/docgen aus @capacitor-community/stripe-identity v8.2.1 auflöst.

addListener wird für die drei unterstützten Ereignisnamen Loaded, FailedToLoad und VerificationResult generiert. Completed, Canceled und Failed sind Werte von IdentityVerificationResult.result (IdentityVerificationSheetResultInterface). Sie werden nicht als separate addListener-Überladungen unterstützt.

Methoden

method initialize(...)

Initialisiert Stripe Identity. Im Web vor create() aufrufen.

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

method create(...)

Erstellt ein Identity VerificationSheet mit den vom
Server erzeugten Zugangsdaten. Vor present() dieses Promise oder das Ereignis Loaded abwarten.

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

method present()

Zeigt das mit create() erstellte VerificationSheet an. Auf
VerificationResult reagieren, um abgeschlossene, abgebrochene und fehlgeschlagene Abläufe zu unterscheiden.

present() => Promise<void>

method addListener(IdentityVerificationSheetEventsEnum.Loaded, ...)

Wird ausgelöst, wenn das VerificationSheet zur Anzeige bereit ist.

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

method addListener(IdentityVerificationSheetEventsEnum.FailedToLoad, ...)

Wird ausgelöst, wenn das VerificationSheet nicht erstellt werden konnte.

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

method addListener(IdentityVerificationSheetEventsEnum.VerificationResult, ...)

Wird ausgelöst, wenn der angezeigte Verifizierungsablauf beendet ist.

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

Interfaces

interface InitializeIdentityVerificationSheetOption

Eigenschaft Typ Beschreibung Seit
publishableKey string Veröffentlichbarer Stripe-Schlüssel für das Web Identity SDK. Native Plattformen akzeptieren diese Option zur API-Gleichheit, initialisieren Identity aber mit den Zugangsdaten der Verifizierungssitzung, die an create() übergeben werden. 5.4.0

interface CreateIdentityVerificationSheetOption

Eigenschaft Typ Beschreibung Seit
verificationId string Kennung der vom Server erstellten VerificationSession. Auf iOS und Android erforderlich. 5.0.3
ephemeralKeySecret string Auf die VerificationSession beschränktes Secret des temporären Schlüssels. Auf iOS und Android erforderlich; muss vom Server zurückgegeben werden. 5.0.3
clientSecret string Client Secret der VerificationSession. Im Web erforderlich; von den nativen Identity-SDKs ignoriert. 5.4.0

interface IdentityVerificationResult

Eigenschaft Typ Beschreibung Seit
result IdentityVerificationSheetResultInterface Endzustand des angezeigten Verifizierungsablaufs. 4.2.0
error StripeIdentityError Fehlerdetails, wenn result Failed ist. 4.2.0

interface StripeIdentityError

Eigenschaft Typ Beschreibung Seit
code string Stripe-Fehlercode, sofern verfügbar. 5.1.0
message string Verständliche Fehlermeldung, die sich zur Protokollierung oder Anzeige eignet. 5.1.0

interface PluginListenerHandle

Eigenschaft Typ
remove () => Promise<void>

Typaliase

type alias IdentityVerificationSheetResultInterface

IdentityVerificationSheetEventsEnum.Completed | IdentityVerificationSheetEventsEnum.Canceled | IdentityVerificationSheetEventsEnum.Failed

Enums

enum IdentityVerificationSheetEventsEnum

Mitglied Wert
Loaded 'identityVerificationSheetLoaded'
FailedToLoad 'identityVerificationSheetFailedToLoad'
Completed 'identityVerificationSheetCompleted'
Canceled 'identityVerificationSheetCanceled'
Failed 'identityVerificationSheetFailed'
VerificationResult 'identityVerificationResult'
Diese Seite auf GitHub bearbeiten