react-native-persona/lib/typescript/InquiryEvent.d.ts

Launch a mobile native implementation of the Persona inquiry flow from React Native.

export interface InquiryEvent {
    readonly type: string;
}
export declare namespace InquiryEvent {
    /**
     * Triggered when an Inquiry session has been created in the client.
     *
     * Dynamic Flow Templates will send this event at the same time as 'ready', and it will not
     * indicate user interaction.
     */
    class Start implements InquiryEvent {
        readonly type: string;
        readonly inquiryId: string;
        readonly sessionToken: string;
        constructor(inquiryId: string, sessionToken: string);
    }
    /**
     * The current page in the Inquiry flow changed. This is primarily used with the Inlined React
     * flow to dynamically resize the widget based on the contents of the current page.
     *
     * page-change events receive a metadata object containing the following fields:
     *
     * @param name name of the next step as configured in the Inquiry Template
     * @param path string representing the step type
     */
    class PageChange implements InquiryEvent {
        readonly type: string;
        readonly name: string;
        readonly path: string;
        constructor(name: string, path: string);
    }
    const fromJson: (eventJson: any) => InquiryEvent | null;
}