BaseContainer

@authgear/webBaseContainer

Base Container

Type parameters

T: BaseAPIClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

+ new BaseContainer(options: ContainerOptions‹T›): BaseContainer

Parameters:

NameType
optionsContainerOptions‹T›

Returns: BaseContainer

Properties

apiClient

apiClient: T


Optional clientID

clientID? : string

OIDC client ID


Optional delegate

delegate? : ContainerDelegate


Optional isThirdParty

isThirdParty? : boolean

Whether the application is a third-party app.


name

name: string

Unique ID for this container.

defaultvalue "default"


sessionState

sessionState: SessionState

Methods

getAccessToken

getAccessToken(): string | undefined

Returns: string | undefined


refreshAccessToken

refreshAccessToken(): Promise‹void›

Returns: Promise‹void›


shouldRefreshAccessToken

shouldRefreshAccessToken(): boolean

Returns: boolean