Interface: UserAPI

Hierarchy

  • EventEmitter‹UserInfoEvent›

    UserAPI

Properties

logoutUrl

logoutUrl: string | undefined

Optional. When specified, this URL will be invoked when the user logs out. This is useful to reduce the number of lingering sessions for solutions that have their own sessions server in addition to IMS.

EventEmitter Methods

emit

emit <K>(type: K, event?: UserInfoEvent[K]): void

Inherited from void

Invoke all handlers for the given type.

Type parameters:

K: keyof UserInfoEvent

Parameters:

NameTypeDescription
typeKThe event type to invoke.
event?UserInfoEvent[K]Any value passed to each handler - object is recommended, and powerful.

Returns: void