KeycloakStoreService

Defined in: services/store.service.ts:16

Service for handling Storage Access to Keycloak Tokens

Constructors

Constructor

new KeycloakStoreService(): KeycloakStoreService;

Returns

KeycloakStoreService

Accessors

accessToken

Get Signature

get accessToken(): string | undefined;

Defined in: services/store.service.ts:164

Getter for getting the Keycloak Access Token

Author

Simon Kovtyk

Since

1.0.0

Returns

string | undefined

Keycloak Access Token

---

email

Get Signature

get email(): string | null;

Defined in: services/store.service.ts:96

Getter for getting email key from Storage

Author

Simon Kovtyk

Since

1.0.0

Returns

string | null

The existing email, or null if not existing

Set Signature

set email(email): void;

Defined in: services/store.service.ts:68

Setter for setting email in Storage

Author

Simon Kovtyk

Since

1.0.0

Parameters

Parameter	Type	Description
email	string | null	The email, that should be saved. If null, the email will be removed

Returns

void

---

parsedAccessToken

Get Signature

get parsedAccessToken(): ParsedKeycloakToken | null;

Defined in: services/store.service.ts:235

Get decoded Access Token

Author

Simon Kovtyk

Since

1.0.0

Returns

ParsedKeycloakToken | null

The decoded Access Token, or null if not existing

---

parsedRefreshToken

Get Signature

get parsedRefreshToken(): ParsedKeycloakToken | null;

Defined in: services/store.service.ts:256

Get decoded Refresh Token

Author

Simon Kovtyk

Since

1.0.0

Returns

ParsedKeycloakToken | null

The decoded Refresh Token, or null if not existing

---

refreshToken

Get Signature

get refreshToken(): string | undefined;

Defined in: services/store.service.ts:175

Getter for getting the Keycloak Refresh Token

Author

Simon Kovtyk

Since

1.0.0

Returns

string | undefined

Keycloak Refresh Token

---

remainingTTLOfAccessToken

Get Signature

get remainingTTLOfAccessToken(): number;

Defined in: services/store.service.ts:205

Getter for getting the remaining Time-To-Live of Keycloak Access Token by existance

Author

Simon Kovtyk

Since

1.0.0

Returns

number

Seconds of the TTL of Keycloak Access Token

---

remainingTTLOfRefreshToken

Get Signature

get remainingTTLOfRefreshToken(): number;

Defined in: services/store.service.ts:218

Getter for getting the remaining Time-To-Live of Keycloak Access Token by existance

Author

Simon Kovtyk

Since

1.0.0

Returns

number

Seconds of the TTL of Keycloak Access Token

---

tokens

Get Signature

get tokens(): KeycloakTokensResponse | null;

Defined in: services/store.service.ts:149

Getter for getting the Keycloak Tokens from Storage

Author

Simon Kovtyk

Since

1.0.0

Returns

KeycloakTokensResponse | null

The Keycloak Tokens from Storage

Set Signature

set tokens(tokens): void;

Defined in: services/store.service.ts:111

Setter for setting Keycloak Tokens

Author

Simon Kovtyk

Since

1.0.0

Parameters

Parameter	Type	Description
tokens	KeycloakTokensResponse | null	Keycloak Tokens, that should be saved

Returns

void

---

TTLOfAccessToken

Get Signature

get TTLOfAccessToken(): number;

Defined in: services/store.service.ts:186

Getter for getting the Time-To-Live of Keycloak Access Token

Author

Simon Kovtyk

Since

1.0.0

Returns

number

Seconds of the TTL of Keycloak Access Token

Methods

clear()

clear(): void;

Defined in: services/store.service.ts:25

Clears all data in the storage

Returns

void

Author

Simon Kovtyk

Since

1.0.0

---

clearEmail()

clearEmail(): void;

Defined in: services/store.service.ts:51

Clears the email out of Storage

Returns

void

Author

Simon Kovtyk

Since

1.0.0

---

clearTokens()

clearTokens(): void;

Defined in: services/store.service.ts:35

Clears the tokens out of the storage

Returns

void

Author

Simon Kovtyk

Since

1.0.0