Class GoogleAuthentifier

Hierarchy

GoogleAuthentifier

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GoogleAuthentifier(secret_key: string, credentials?: CredentialsBody): GoogleAuthentifier

- Defined in src/GoogleAuthentifier.ts:17
Parameters
- secret_key: string
- Optional credentials: CredentialsBody
Returns GoogleAuthentifier

Properties

authorisationDataCache

authorisationDataCache: AuthorisationCache

Optional credentials

credentials?: CredentialsBody

secret_key

secret_key: string

signInUserUrlTemplate

signInUserUrlTemplate: string = 'https://www.googleapis.com/identitytoolkit/v3/relyingparty/verifyPassword?key=%(key)s'

signUpUserUrlTemplate

signUpUserUrlTemplate: string = 'https://www.googleapis.com/identitytoolkit/v3/relyingparty/signupNewUser?key=%(key)s'

tokenRefreshUrlTemplate

tokenRefreshUrlTemplate: string = 'https://securetoken.googleapis.com/v1/token?key=%(key)s'

Methods

buildSignInUserUrl

buildSignInUserUrl(): string

- Defined in src/GoogleAuthentifier.ts:30
Returns string

buildSignUpUserUrl

buildSignUpUserUrl(): string

- Defined in src/GoogleAuthentifier.ts:22
Returns string

buildTokenRefreshUrl

buildTokenRefreshUrl(): string

- Defined in src/GoogleAuthentifier.ts:26
Returns string

ensureCacheValidity

ensureCacheValidity(): Promise<AuthorisationCache>

- Defined in src/GoogleAuthentifier.ts:165
Makes sure that the authorisation cache is valid
example
```
authentifierInstance.ensureCacheValidity().then(console.log)
```
Returns Promise<AuthorisationCache>

isCacheValid

isCacheValid(): boolean

- Defined in src/GoogleAuthentifier.ts:188
Test if the authorisation cache is valid
example
```
authentifierInstance.isCacheValid().then(console.log)
```
Returns boolean

obtainAuthorisationToken

obtainAuthorisationToken(): Promise<string>

- Defined in src/GoogleAuthentifier.ts:119
Always obtain a valid authorisation token
example
```
authentifierInstance.obtainAuthorisationToken().then(console.log)
```
Returns Promise<string>

refreshAuthorisationToken

refreshAuthorisationToken(): Promise<AuthorisationCache>

- Defined in src/GoogleAuthentifier.ts:131
Refresh the current authorisation token
example
```
authentifierInstance.refreshAuthorisationToken().then(console.log)
```
Returns Promise<AuthorisationCache>

signIn

signIn(signInBody?: CredentialsBody): Promise<AuthorisationCache>

- Defined in src/GoogleAuthentifier.ts:78
Sign in
example
Sign in with instance credentials
```
authentifierInstance.signIn().then(console.log)
```
example
Sign in with new credentials
```
authentifierInstance.signIn({
        email: "my@mail.com",
        password: "myPassword"
    }).then(console.log)
```
Parameters
- signInBody: CredentialsBody = ...
Returns Promise<AuthorisationCache>

signUp

signUp(signUpBody?: CredentialsBody): Promise<AuthorisationCache>

- Defined in src/GoogleAuthentifier.ts:49
Sign up a new user
example
Sign up as anonymous
```
authentifierInstance.signUp().then(console.log)
```
example
Sign up as new user
```
authentifierInstance.signUp({
        email: "my@mail.com",
        password: "myPassword"
    }).then(console.log)
```
Parameters
- Optional signUpBody: CredentialsBody
Returns Promise<AuthorisationCache>

Generated using TypeDoc