Skip to main content

Class: KeycloakConnectorClient

Constructors

constructor

new KeycloakConnectorClient(config): KeycloakConnectorClient

Parameters

NameType
configClientConfig

Returns

KeycloakConnectorClient

Defined in

keycloak-connector-client.ts:50

Methods

abortBackgroundLogins

abortBackgroundLogins(): void

Returns

void

Defined in

keycloak-connector-client.ts:245


addEventListener

addEventListener(...args): void

Parameters

NameType
...args[event: ClientEvent | "*", listener: EventListenerFunction<ClientEvent>]

Returns

void

Defined in

keycloak-connector-client.ts:106


authCheck

authCheck(force?): Promise<void>

Parameters

NameType
force?boolean

Returns

Promise<void>

Defined in

keycloak-connector-client.ts:343


authCheckNoWait

authCheckNoWait(): boolean

Returns

boolean

Defined in

keycloak-connector-client.ts:260


destroy

destroy(): void

Returns

void

Defined in

keycloak-connector-client.ts:251


handleLogin

handleLogin(newWindow?): Promise<void>

Parameters

NameType
newWindow?boolean

Returns

Promise<void>

Defined in

keycloak-connector-client.ts:428


handleLogout

handleLogout(): Promise<void>

Returns

Promise<void>

Defined in

keycloak-connector-client.ts:464


isStarted

isStarted(): boolean

Returns

boolean

Defined in

keycloak-connector-client.ts:104


prepareToHandleNewWindowLogin

prepareToHandleNewWindowLogin(): void

Prepares the client to smoothly handle logins through a new window

Returns

void

Defined in

keycloak-connector-client.ts:426


removeEventListener

removeEventListener(...args): void

Parameters

NameType
...args[event: ClientEvent | "*", listener: EventListenerFunction<ClientEvent>]

Returns

void

Defined in

keycloak-connector-client.ts:107


start

start(): void

Returns

void

Defined in

keycloak-connector-client.ts:91


instance

instance(config): KeycloakConnectorClient

Parameters

NameType
configClientConfig

Returns

KeycloakConnectorClient

Defined in

keycloak-connector-client.ts:547


isTokenCurrent

isTokenCurrent(type): undefined | boolean

Parameters

NameType
typeTokenType

Returns

undefined | boolean

Defined in

keycloak-connector-client.ts:520