Aller au contenu
rdlabo.devdocs

API

Méthodes publiques, types de résultat, types d’erreur et événements résolus par @capacitor/docgen depuis @capacitor-community/stripe-identity v8.2.1.

addListener est généré pour les trois noms d’événement pris en charge : Loaded, FailedToLoad et VerificationResult. Completed, Canceled et Failed sont des valeurs d’IdentityVerificationResult.result (IdentityVerificationSheetResultInterface). Ce ne sont pas des surcharges addListener prises en charge séparément.

Méthodes

method initialize(...)

Initialise Stripe Identity. Appelez cette méthode avant create() sur le Web.

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

method create(...)

Crée un Identity VerificationSheet à partir des identifiants générés par votre serveur. Attendez la résolution de cette Promise ou l’événement Loaded avant present().

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

method present()

Présente le VerificationSheet créé par create(). Écoutez VerificationResult pour distinguer les parcours terminés, annulés et échoués.

present() => Promise<void>

method addListener(IdentityVerificationSheetEventsEnum.Loaded, ...)

Émis lorsque VerificationSheet est prêt à être présenté.

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

method addListener(IdentityVerificationSheetEventsEnum.FailedToLoad, ...)

Émis lorsque VerificationSheet n’a pas pu être créé.

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

method addListener(IdentityVerificationSheetEventsEnum.VerificationResult, ...)

Émis lorsque le parcours de vérification présenté se termine.

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

Interfaces

interface InitializeIdentityVerificationSheetOption

Propriété Type Description Depuis
publishableKey string Clé publique Stripe utilisée par le SDK Identity Web. Les plateformes natives acceptent cette option pour assurer la parité de l’API, mais initialisent Identity à partir des identifiants de session de vérification fournis à create(). 5.4.0

interface CreateIdentityVerificationSheetOption

Propriété Type Description Depuis
verificationId string Identifiant de la VerificationSession créée par votre serveur. Obligatoire sur iOS et Android. 5.0.3
ephemeralKeySecret string Secret de clé éphémère limité à la VerificationSession. Obligatoire sur iOS et Android ; il doit être renvoyé par votre serveur. 5.0.3
clientSecret string Secret client de la VerificationSession. Obligatoire sur le Web ; ignoré par les SDK Identity natifs. 5.4.0

interface IdentityVerificationResult

Propriété Type Description Depuis
result IdentityVerificationSheetResultInterface État final du parcours de vérification présenté. 4.2.0
error StripeIdentityError Détails de l’erreur lorsque result vaut Failed. 4.2.0

interface StripeIdentityError

Propriété Type Description Depuis
code string Code d’erreur Stripe, lorsqu’il est disponible. 5.1.0
message string Message d’erreur lisible, adapté à la journalisation ou à l’affichage. 5.1.0

interface PluginListenerHandle

Propriété Type
remove () => Promise<void>

Alias de types

type alias IdentityVerificationSheetResultInterface

IdentityVerificationSheetEventsEnum.Completed | IdentityVerificationSheetEventsEnum.Canceled | IdentityVerificationSheetEventsEnum.Failed

Énumérations

enum IdentityVerificationSheetEventsEnum

Membre Valeur
Loaded 'identityVerificationSheetLoaded'
FailedToLoad 'identityVerificationSheetFailedToLoad'
Completed 'identityVerificationSheetCompleted'
Canceled 'identityVerificationSheetCanceled'
Failed 'identityVerificationSheetFailed'
VerificationResult 'identityVerificationResult'
Modifier cette page sur GitHub