@capgo/capacitor-autofill-save-password/dist/esm/definitions.d.ts

Prompt to display dialog for saving password to keychain from webview app

/**
 * @interface Options
 * @description The options for the prompt.
 */
export interface Options {
    /**
     * The username to save.
     */
    username: string;
    /**
     * The password to save.
     */
    password: string;
    /**
     * The url to save the password for. (For example: "console.capgo.app")
     * iOS only.
     */
    url?: string;
}
export interface ReadPasswordResult {
    /**
     * The username of the password.
     */
    username: string;
    /**
     * The password of the password.
     */
    password: string;
}
/**
 * @interface SavePasswordPlugin
 * @description Capacitor plugin for saving passwords to the keychain.
 */
export interface SavePasswordPlugin {
    /**
     * Save a password to the keychain.
     * @param {Options} options - The options for the password.
     * @returns {Promise<void>} Success status
     * @example
     * await SavePassword.promptDialog({
     *   username: 'your-username',
     *   password: 'your-password'
     * });
     */
    promptDialog(options: Options): Promise<void>;
    /**
     * Read a password from the keychain. Requires the developer to setup associated domain for the app for iOS.
     * @returns {Promise<ReadPasswordResult>} The retrieved password credentials
     */
    readPassword(): Promise<ReadPasswordResult>;
    /**
     * Get the native Capacitor plugin version.
     *
     * @returns Promise that resolves with the plugin version
     * @since 1.0.0
     */
    getPluginVersion(): Promise<{
        version: string;
    }>;
}