@nevis-security/nevis-mobile-authentication-sdk-react/lib/typescript/operations/outOfBand/PendingOutOfBandOperations.d.ts

React Native plugin for Nevis Mobile Authentication SDK. Supports only mobile.

/**
 * Copyright © 2024 Nevis Security AG. All rights reserved.
 */
import type { PendingOutOfBandOperationsResult } from './PendingOutOfBandOperationsResult';
import { HttpOperation, HttpOperationImpl } from '../HttpOperation';
/**
 * The operation retrieving the out-of-band operations that have been started in
 * the server, and must be handled by the application running the Mobile Authentication
 * SDK on the device.
 *
 * The retrieved operations have been neither timed-out, nor have been processed
 * by the SDK, that is, they have not been processed using an {@link OutOfBandOperation}
 * operation.
 *
 * **IMPORTANT** \
 * It is recommended to use this operation as sparsely as possible, because of
 * the performance impact that it can have in the server. Do not use it for example
 * with a polling mechanism.
 *
 * This is supported only when the backend uses nevisFIDO 7.2402.** or later.
 *
 * Usage example:
 * ```ts
 *    [...]
 *    async retrievePendingOutOfBandOperations(
 *        operations: Operations
 *    ): Promise<void> {
 *        await operations.pendingOutOfBandOperations
 *            .onResult((result) => {
 *                // handle the retrieved out-of-band operations. For example
 *                // they can be processed using an OutOfBandOperation.
 *            })
 *            .execute();
 *    }
 *    [...]
 * ```
 *
 * @see
 * - {@link PendingOutOfBandOperationsResult}
 * - {@link PendingOutOfBandOperation.payload}
 * - {@link OutOfBandOperation}
 * - {@link Operations#pendingOutOfBandOperations}
 */
export declare abstract class PendingOutOfBandOperations extends HttpOperation<PendingOutOfBandOperations> {
    /**
     * Specifies the object that will be invoked with the {@link PendingOutOfBandOperationsResult}
     * containing the pending out-of-band operations for this application and the
     * errors (if any).
     *
     * **IMPORTANT** \
     * Providing the {@link onResult} callback is required.
     *
     * @param onResult the callback that will be invoked when the operation finishes.
     * @returns a {@link PendingOutOfBandOperations} object.
     */
    abstract onResult(onResult: (result: PendingOutOfBandOperationsResult) => void): PendingOutOfBandOperations;
}
export declare class PendingOutOfBandOperationsImpl extends HttpOperationImpl<PendingOutOfBandOperations> implements PendingOutOfBandOperations {
    private _onResult?;
    constructor();
    onResult(onResult: (result: PendingOutOfBandOperationsResult) => void): PendingOutOfBandOperations;
    execute(): Promise<void>;
}
//# sourceMappingURL=PendingOutOfBandOperations.d.ts.map