@nevis-security/nevis-mobile-authentication-sdk-react
Version:
React Native plugin for Nevis Mobile Authentication SDK. Supports only mobile.
38 lines • 1.61 kB
TypeScript
/**
* Copyright © 2023 Nevis Security AG. All rights reserved.
*/
import { Account } from './Account';
/**
* The object exposing the registration information for an {@link Authenticator}.
*/
export declare abstract class RegistrationInfo {
/**
* Returns the objects representing the accounts that are registered with this authenticator.
*
* If an authenticator that is registered for a given username is provided through
* {@link AuthenticatorSelector} for registration operations associated with the account
* associated with the username, an {@link OperationError} will be returned as a result
* of the operation.
*
* If an authenticator that is not registered for a given username is provided through
* {@link AuthenticatorSelector} for authentication operations associated with the account
* associated with the username, an {@link OperationError} will be returned as a result
* of the operation.
*/
abstract registeredAccounts: Array<Account>;
/**
* Alternate constructor that creates a {@link RegistrationInfo} from a json.
*
* @param json contains the source for instance creation.
* @returns a {@link RegistrationInfo} instance.
*/
static fromJson(json: any): RegistrationInfo;
/**
* Returns `true` if the provided user is registered and `false` otherwise.
*
* @param username the username.
* @returns `true` if the provided user is registered and `false` otherwise.
*/
abstract isRegistered(username: string): boolean;
}
//# sourceMappingURL=RegistrationInfo.d.ts.map