Class default`Internal`

Manages a popup window, iframe or redirect.

Hierarchy

default

Index

Constructors

Properties

closeListener loginWindow messageHandlers containers

Methods

close deleteFromCache focus isActive isMessageFromPopup on onClosed onLogin onMessage once runHandlers start start

Constructors

constructor

new default(loginWindow: LoginWindow): default
Parameters
- loginWindow: LoginWindow
Returns default
- Defined in src/login-container.ts:240

Properties

`Private` closeListener

closeListener: Timer

`Readonly` loginWindow

loginWindow: LoginWindow

`Readonly` messageHandlers

messageHandlers: MessageHandlers = ...

`Static` `Readonly` containers

containers: {
[id: string]: default;
} = {}

Type declaration

[id: string]: default

Methods

close

close(): void
closes the login window

Returns

Returns void
- Defined in src/login-container.ts:423

`Private` deleteFromCache

deleteFromCache(): void
Returns
void

Returns void
- Defined in src/login-container.ts:432

focus

focus(): void
focuses the login window

Returns

Returns void
- Defined in src/login-container.ts:414

isActive

isActive(): boolean
Returns
true if the login window is still open

Returns boolean
- Defined in src/login-container.ts:399

isMessageFromPopup

isMessageFromPopup(event: PopupMessage): boolean
Returns
boolean
Parameters
- event: PopupMessage
  
  event
Returns boolean
- Defined in src/login-container.ts:314

on

on<E>(event: E, fn: MessageEventHandler<MessageTypes[E]>, runOnce?: boolean): void
Returns
void
Type Parameters
- E extends keyof MessageTypes
Parameters
- event: E
  
  event
- fn: MessageEventHandler<MessageTypes[E]>
  
  fn
- runOnce: boolean = false
  
  will detach the event handler after execution if set to true
Returns void
- Defined in src/login-container.ts:387

onClosed

onClosed(fn: (() => unknown)): void
Returns
void
Parameters
- fn: (() => unknown)
  
  handler function
  - - (): unknown
    - Returns unknown
Returns void
- Defined in src/login-container.ts:361

onLogin

onLogin(fn: ClientLoginEventHandler): void
Returns
void
Parameters
- fn: ClientLoginEventHandler
  
  handler function
Returns void
- Defined in src/login-container.ts:352

onMessage

onMessage(event: PopupMessage): void
Internal

Returns
void
Parameters
- event: PopupMessage
  
  event
Returns void
- Defined in src/login-container.ts:285

once

once<E>(event: E, fn: MessageEventHandler<MessageTypes[E]>): void
Returns
void
Type Parameters
- E extends keyof MessageTypes
Parameters
- event: E
  
  event
- fn: MessageEventHandler<MessageTypes[E]>
  
  fn
Returns void
- Defined in src/login-container.ts:372

`Private` runHandlers

runHandlers<T>(handlers: (MessageEventHandler<T> & MessageEventHandlerProps)[], msg: T, event?: MessageEvent<any>): Promise<unknown[]>
Runs handlers and removes them.

Returns
Promise<void[]>
Type Parameters
- T extends object
Parameters
- handlers: (MessageEventHandler<T> & MessageEventHandlerProps)[]
  
  handlers
- msg: T
  
  message
- Optional event: MessageEvent<any>
  
  optional event
Returns Promise<unknown[]>
- Defined in src/login-container.ts:332

start

start(): void
Returns
void

Returns void
- Defined in src/login-container.ts:405

`Static` start

start(loginWindow: LoginWindow): default
Returns
new LoginContainer or focuses an active one with the same id
Parameters
- loginWindow: LoginWindow
  
  LoginWindow implementation
Returns default
- Defined in src/login-container.ts:446

Generated using TypeDoc