Class API

Index

Constructors

Methods

createAccount errorLogger loginAnonymously loginWithCredentials loginWithRefreshToken queryServices sendEmailVerification verifyOobCode

Properties

connectionTimeout firebaseKey idToken instance protocol proxy

Constructors

constructor

new API(params?: Partial<APIParams>): API
Parameters
- params: Partial<APIParams> = {}
Returns API

Methods

`Readonly`createAccount

createAccount(
    email: string,
    password: string,
    customServicesParams?: Record<string, any>,
): Promise<QueryResponseError | AuthResponse>
Parameters
- email: string
- password: string
- OptionalcustomServicesParams: Record<string, any>
Returns Promise<QueryResponseError | AuthResponse>

errorLogger

errorLogger(...args: any[]): void
Parameters
- ...args: any[]
Returns void

loginAnonymously

loginAnonymously(
customServicesParams?: Record<string, any>,
): Promise<QueryResponseError | AuthResponse>
Parameters
- OptionalcustomServicesParams: Record<string, any>
Returns Promise<QueryResponseError | AuthResponse>

`Readonly`loginWithCredentials

loginWithCredentials(
    email: string,
    password: string,
    customServicesParams?: Record<string, any>,
): Promise<QueryResponseError | AuthResponse>
Parameters
- email: string
- password: string
- OptionalcustomServicesParams: Record<string, any>
Returns Promise<QueryResponseError | AuthResponse>

loginWithRefreshToken

loginWithRefreshToken(
refreshToken: string,
customServicesParams?: Record<string, any>,
): Promise<QueryResponseError | AuthResponse>
Parameters
- refreshToken: string
- OptionalcustomServicesParams: Record<string, any>
Returns Promise<QueryResponseError | AuthResponse>

queryServices

queryServices(
request: QueryRequest,
): Promise<QueryResponseOK | QueryResponseError>
Parameters
- request: QueryRequest
Returns Promise<QueryResponseOK | QueryResponseError>

sendEmailVerification

sendEmailVerification(
idToken?: string | null,
): Promise<QueryResponseError | EmailResponse>
Parameters
- idToken: string | null = ...
Returns Promise<QueryResponseError | EmailResponse>

verifyOobCode

verifyOobCode(oobCode: string): Promise<QueryResponseError | EmailResponse>
Parameters
- oobCode: string
Returns Promise<QueryResponseError | EmailResponse>

Properties

connectionTimeout

connectionTimeout: number

firebaseKey

firebaseKey: string

idToken

idToken: string | null = null

instance

instance: string

protocol

protocol: string

proxy

proxy: string