@sheerid/jslib
    Preparing search index...

    Interface SheerIdJsApi

    The interface exposed on the window object

    interface SheerIdJsApi {
        conversion: Conversion;
        hooks: Hooks;
        overrideComponent: (
            componentName: OverrideableComponentName,
            newComponent: StepComponent,
        ) => void;
        resetOverriddenComponents: () => void;
        resetStore: () => void;
        VerificationForm: new (element: HTMLElement, programId: string) => void;
        addHook(hook: Hook): RegisteredHooks;
        collectDeviceProfile(verificationId: string, programId: string): void;
        getMessages(
            locale:
                | "es"
                | "id"
                | "is"
                | "no"
                | "ar"
                | "bg"
                | "bn-IN"
                | "cs"
                | "da"
                | "de"
                | "el"
                | "en-GB"
                | "en-US"
                | "es-ES"
                | "fi"
                | "fr-CA"
                | "fr"
                | "ga"
                | "hi-IN"
                | "hr"
                | "hu"
                | "it"
                | "iw"
                | "ja"
                | "ko"
                | "lo"
                | "lt"
                | "ms"
                | "nl"
                | "nl-BE"
                | "pl"
                | "pt-BR"
                | "pt"
                | "ro"
                | "ru"
                | "sk"
                | "sl"
                | "sr"
                | "sv"
                | "sw"
                | "uk"
                | "ur"
                | "vi"
                | "th"
                | "tr"
                | "zh-HK"
                | "zh"
                | "zu",
            programThemeMessages?: ProgramThemeMessages,
            segment?: Segment,
        ): Promise<StringMap>;
        getMetadata(): Metadata;
        postVerificationSizeUpdates(options: PostMessagesOptions): void;
        refreshStore(): void;
        resetMetadata(): void;
        resetOptions(): void;
        resetViewModel(): void;
        setMetadata(metadata: Metadata): void;
        setOptions(options: Options): void;
        setProgramTheme(theme: Partial<ProgramTheme>): void;
        setViewModel(viewModel: {} | ViewModel): void;
    }
    Index

    Properties

    conversion hooks overrideComponent resetOverriddenComponents resetStore VerificationForm

    Methods

    addHook collectDeviceProfile getMessages getMetadata postVerificationSizeUpdates refreshStore resetMetadata resetOptions resetViewModel setMetadata setOptions setProgramTheme setViewModel

    Properties

    conversion: Conversion
    hooks: Hooks
    overrideComponent: (
        componentName: OverrideableComponentName,
        newComponent: StepComponent,
    ) => void
    resetOverriddenComponents: () => void
    resetStore: () => void
    VerificationForm: new (element: HTMLElement, programId: string) => void

    Methods

    • Parameters

      • verificationId: string
      • programId: string

      Returns void

    • Parameters

      • locale:
            | "es"
            | "id"
            | "is"
            | "no"
            | "ar"
            | "bg"
            | "bn-IN"
            | "cs"
            | "da"
            | "de"
            | "el"
            | "en-GB"
            | "en-US"
            | "es-ES"
            | "fi"
            | "fr-CA"
            | "fr"
            | "ga"
            | "hi-IN"
            | "hr"
            | "hu"
            | "it"
            | "iw"
            | "ja"
            | "ko"
            | "lo"
            | "lt"
            | "ms"
            | "nl"
            | "nl-BE"
            | "pl"
            | "pt-BR"
            | "pt"
            | "ro"
            | "ru"
            | "sk"
            | "sl"
            | "sr"
            | "sv"
            | "sw"
            | "uk"
            | "ur"
            | "vi"
            | "th"
            | "tr"
            | "zh-HK"
            | "zh"
            | "zu"
      • OptionalprogramThemeMessages: ProgramThemeMessages
      • Optionalsegment: Segment

      Returns Promise<StringMap>

    • Returns Metadata

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods