Class: KeycloakConnectorClient
Constructors
constructor
• new KeycloakConnectorClient(config): KeycloakConnectorClient
Parameters
| Name | Type |
|---|---|
config | ClientConfig |
Returns
Defined in
keycloak-connector-client.ts:56
Methods
abortBackgroundLogins
▸ abortBackgroundLogins(): void
Returns
void
Defined in
keycloak-connector-client.ts:287
addEventListener
▸ addEventListener(...args): void
Parameters
| Name | Type |
|---|---|
...args | [event: ClientEvent | "*", listener: EventListenerFunction<ClientEvent>] |
Returns
void
Defined in
keycloak-connector-client.ts:115
authCheck
▸ authCheck(force?): Promise<void>
Parameters
| Name | Type |
|---|---|
force? | boolean |
Returns
Promise<void>
Defined in
keycloak-connector-client.ts:392
authCheckNoWait
▸ authCheckNoWait(): boolean
Returns
boolean
Defined in
keycloak-connector-client.ts:306
destroy
▸ destroy(): void
Returns
void
Defined in
keycloak-connector-client.ts:293
handleLogin
▸ handleLogin(newWindow?): Promise<void>
Parameters
| Name | Type |
|---|---|
newWindow? | boolean |
Returns
Promise<void>
Defined in
keycloak-connector-client.ts:527
handleLogout
▸ handleLogout(args?): Promise<void>
Parameters
| Name | Type |
|---|---|
args | Object |
args.redirectUri? | string |
Returns
Promise<void>
Defined in
keycloak-connector-client.ts:563
isStarted
▸ isStarted(): boolean
Returns
boolean
Defined in
keycloak-connector-client.ts:113
prepareToHandleNewWindowLogin
▸ prepareToHandleNewWindowLogin(): void
Prepares the client to smoothly handle logins through a new window
Returns
void
Defined in
keycloak-connector-client.ts:525
removeEventListener
▸ removeEventListener(...args): void
Parameters
| Name | Type |
|---|---|
...args | [event: ClientEvent | "*", listener: EventListenerFunction<ClientEvent>] |
Returns
void
Defined in
keycloak-connector-client.ts:116
start
▸ start(): void
Returns
void
Defined in
keycloak-connector-client.ts:100
instance
▸ instance(config): KeycloakConnectorClient
Parameters
| Name | Type |
|---|---|
config | ClientConfig |
Returns
Defined in
keycloak-connector-client.ts:646
isTokenCurrent
▸ isTokenCurrent(type): undefined | boolean
Parameters
| Name | Type |
|---|---|
type | TokenType |
Returns
undefined | boolean