UNPKG

1.53 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2020 Google LLC
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17import { MultiFactorAssertion, MultiFactorInfo, MultiFactorSession, MultiFactorUser, User } from '../model/public_types';
18import { UserInternal } from '../model/user';
19export declare class MultiFactorUserImpl implements MultiFactorUser {
20 readonly user: UserInternal;
21 enrolledFactors: MultiFactorInfo[];
22 private constructor();
23 static _fromUser(user: UserInternal): MultiFactorUserImpl;
24 getSession(): Promise<MultiFactorSession>;
25 enroll(assertionExtern: MultiFactorAssertion, displayName?: string | null): Promise<void>;
26 unenroll(infoOrUid: MultiFactorInfo | string): Promise<void>;
27}
28/**
29 * The {@link MultiFactorUser} corresponding to the user.
30 *
31 * @remarks
32 * This is used to access all multi-factor properties and operations related to the user.
33 *
34 * @param user - The user.
35 *
36 * @public
37 */
38export declare function multiFactor(user: User): MultiFactorUser;