Home Reference Source Test Repository
import Auth from 'jexia-sdk-js/src/Auth.js'
public class | source

Auth

Managing the session between jexia-sdk-js and Jexia.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Create a new Auth object with some initial values.

Member Summary

Public Members
public
public
public
public
public
public
public

Method Summary

Public Methods
public

Refresh the session after a given time delay

public

Get current refresh token

public

Get current token

public

Initialize a new session between jexia-sdk-js and Jexia

public

setRefreshToken(refreshToken: string)

Set current refresh token

public

setToken(token: string)

Set current token

Public Constructors

public constructor(options: Object) source

Create a new Auth object with some initial values.

Params:

NameTypeAttributeDescription
options Object

Initial options object

options.url string

Authentication app url

options.key string

Authentication app key

options.secret string

Authentication app secret

options.client Object

JexiaClient

Public Members

public bus: Object source

public client: Object source

public key: string source

public refreshToken: string source

public secret: string source

public token: string source

public url: string source

Public Methods

public autoRefresh(delay: number) source

Refresh the session after a given time delay

Params:

NameTypeAttributeDescription
delay number

delay in milliseconds

Emit:

jexia.auth.token

emit an authentication event when we successfully refreshed the session with Jexia

public getRefreshToken(): string source

Get current refresh token

Return:

string

Current refresh token

public getToken(): string source

Get current token

Return:

string

Current token

public init(): Promise<Auth, Error> source

Initialize a new session between jexia-sdk-js and Jexia

Return:

Promise<Auth, Error>

public setRefreshToken(refreshToken: string) source

Set current refresh token

Params:

NameTypeAttributeDescription
refreshToken string

the new token

public setToken(token: string) source

Set current token

Params:

NameTypeAttributeDescription
token string

the new token