Interface UserManagerEvents

interface UserManagerEvents {
    addAccessTokenExpired(cb: AccessTokenCallback): () => void;
    addAccessTokenExpiring(cb: AccessTokenCallback): () => void;
    addSilentRenewError(cb: SilentRenewErrorCallback): () => void;
    addUserLoaded(cb: UserLoadedCallback): () => void;
    addUserSessionChanged(cb: UserSessionChangedCallback): () => void;
    addUserSignedIn(cb: UserSignedInCallback): () => void;
    addUserSignedOut(cb: UserSignedOutCallback): () => void;
    addUserUnloaded(cb: UserUnloadedCallback): () => void;
    load(user: User, raiseEvent?: boolean): Promise<void>;
    removeAccessTokenExpired(cb: AccessTokenCallback): void;
    removeAccessTokenExpiring(cb: AccessTokenCallback): void;
    removeSilentRenewError(cb: SilentRenewErrorCallback): void;
    removeUserLoaded(cb: UserLoadedCallback): void;
    removeUserSessionChanged(cb: UserSessionChangedCallback): void;
    removeUserSignedIn(cb: UserSignedInCallback): void;
    removeUserSignedOut(cb: UserSignedOutCallback): void;
    removeUserUnloaded(cb: UserUnloadedCallback): void;
    unload(): Promise<void>;
}

Hierarchy (View Summary)

AccessTokenEvents
- UserManagerEvents

Index

Methods

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

Methods

addAccessTokenExpired

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

addAccessTokenExpiring

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

addSilentRenewError

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

addUserLoaded

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

addUserSessionChanged

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

addUserSignedIn

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

addUserSignedOut

addUserSignedOut(cb: UserSignedOutCallback): () => 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
See
UserManagerSettings.monitorSession
- Defined in src/UserManagerEvents.ts:132

addUserUnloaded

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

load

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

removeAccessTokenExpired

removeAccessTokenExpired(cb: AccessTokenCallback): 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: AccessTokenCallback): 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: SilentRenewErrorCallback): void
Remove callback: Raised when the automatic silent renew has failed.
Parameters
- cb: SilentRenewErrorCallback
Returns void
- Defined in src/UserManagerEvents.ts:98

removeUserLoaded

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

removeUserSessionChanged

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

removeUserSignedIn

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

removeUserSignedOut

removeUserSignedOut(cb: UserSignedOutCallback): 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:138

removeUserUnloaded

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

unload

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