Class UserManagerEvents

Hierarchy (view full)

AccessTokenEvents
- UserManagerEvents

Index

Constructors

Methods

addAccessTokenExpired addAccessTokenExpiring addSilentRenewError addUserLoaded addUserSessionChanged addUserSignedIn addUserSignedOut addUserUnloaded load removeAccessTokenExpired removeAccessTokenExpiring removeSilentRenewError removeUserLoaded removeUserSessionChanged removeUserSignedIn removeUserSignedOut removeUserUnloaded unload

Constructors

constructor

new UserManagerEvents(settings): UserManagerEvents
Parameters
- settings: UserManagerSettingsStore
Returns UserManagerEvents
Overrides AccessTokenEvents.constructor
- Defined in src/UserManagerEvents.ts:47

Methods

addAccessTokenExpired

addAccessTokenExpired(cb): (() => void)
Add callback: Raised after the access token has expired.
Parameters
- cb: AccessTokenCallback
Returns (() => void)
- - (): void
  - Returns void
Inherited from AccessTokenEvents.addAccessTokenExpired
- Defined in src/AccessTokenEvents.ts:81

addAccessTokenExpiring

addAccessTokenExpiring(cb): (() => void)
Add callback: Raised prior to the access token expiring.
Parameters
- cb: AccessTokenCallback
Returns (() => void)
- - (): void
  - Returns void
Inherited from AccessTokenEvents.addAccessTokenExpiring
- Defined in src/AccessTokenEvents.ts:68

addSilentRenewError

addSilentRenewError(cb): (() => void)
Add callback: Raised when the automatic silent renew has failed.
Parameters
- cb: SilentRenewErrorCallback
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/UserManagerEvents.ts:91

addUserLoaded

addUserLoaded(cb): (() => void)
Add callback: Raised when a user session has been established (or re-established).
Parameters
- cb: UserLoadedCallback
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/UserManagerEvents.ts:65

addUserSessionChanged

addUserSessionChanged(cb): (() => void)
Add callback: Raised when the user session changed (when monitorSession is set).
Parameters
- cb: UserSessionChangedCallback
Returns (() => void)
- - (): void
  - Returns void
See
UserManagerSettings.monitorSession
- Defined in src/UserManagerEvents.ts:151

addUserSignedIn

addUserSignedIn(cb): (() => void)
Add callback: Raised when the user is signed in (when monitorSession is set).
Parameters
- cb: UserSignedInCallback
Returns (() => void)
- - (): void
  - Returns void
See
UserManagerSettings.monitorSession
- Defined in src/UserManagerEvents.ts:111

addUserSignedOut

addUserSignedOut(cb): (() => void)
Add callback: Raised when the user's sign-in status at the OP has changed (when monitorSession is set).
Parameters
- cb: UserSignedOutCallback
Returns (() => void)
- - (): void
  - Returns void
See
UserManagerSettings.monitorSession
- Defined in src/UserManagerEvents.ts:131

addUserUnloaded

addUserUnloaded(cb): (() => void)
Add callback: Raised when a user session has been terminated.
Parameters
- cb: UserUnloadedCallback
Returns (() => void)
- - (): void
  - Returns void
- Defined in src/UserManagerEvents.ts:78

load

load(user, raiseEvent?): Promise<void>
Parameters
- user: User
- raiseEvent: boolean = true
Returns Promise<void>
Overrides AccessTokenEvents.load
- Defined in src/UserManagerEvents.ts:51

removeAccessTokenExpired

removeAccessTokenExpired(cb): void
Remove callback: Raised after the access token has expired.
Parameters
- cb: AccessTokenCallback
Returns void
Inherited from AccessTokenEvents.removeAccessTokenExpired
- Defined in src/AccessTokenEvents.ts:87

removeAccessTokenExpiring

removeAccessTokenExpiring(cb): void
Remove callback: Raised prior to the access token expiring.
Parameters
- cb: AccessTokenCallback
Returns void
Inherited from AccessTokenEvents.removeAccessTokenExpiring
- Defined in src/AccessTokenEvents.ts:74

removeSilentRenewError

removeSilentRenewError(cb): void
Remove callback: Raised when the automatic silent renew has failed.
Parameters
- cb: SilentRenewErrorCallback
Returns void
- Defined in src/UserManagerEvents.ts:97

removeUserLoaded

removeUserLoaded(cb): void
Remove callback: Raised when a user session has been established (or re-established).
Parameters
- cb: UserLoadedCallback
Returns void
- Defined in src/UserManagerEvents.ts:71

removeUserSessionChanged

removeUserSessionChanged(cb): void
Remove callback: Raised when the user session changed (when monitorSession is set).
Parameters
- cb: UserSessionChangedCallback
Returns void
- Defined in src/UserManagerEvents.ts:157

removeUserSignedIn

removeUserSignedIn(cb): void
Remove callback: Raised when the user is signed in (when monitorSession is set).
Parameters
- cb: UserSignedInCallback
Returns void
- Defined in src/UserManagerEvents.ts:117

removeUserSignedOut

removeUserSignedOut(cb): void
Remove callback: Raised when the user's sign-in status at the OP has changed (when monitorSession is set).
Parameters
- cb: UserSignedOutCallback
Returns void
- Defined in src/UserManagerEvents.ts:137

removeUserUnloaded

removeUserUnloaded(cb): void
Remove callback: Raised when a user session has been terminated.
Parameters
- cb: UserUnloadedCallback
Returns void
- Defined in src/UserManagerEvents.ts:84

unload

unload(): Promise<void>
Returns Promise<void>
Overrides AccessTokenEvents.unload
- Defined in src/UserManagerEvents.ts:57