Edit in GitHubLog an issue

Interface: UserApi

Hierarchy#

  • EventEmitter‹UserInfoEvent›

    UserApi

Index#

Properties#

EventEmitter Methods#

Other Methods#

Properties#

logoutUrl#

logoutUrl: string | undefined

Optional. When specified this URL will be invoked upon user logging out. This is useful to reduce the number of lingering sessions for solutions who 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 (object is recommended and powerful), passed to each handler.

Returns: void


off#

off<K>(type: K, handler: function): void

Inherited from void

Remove an event handler for the given type.

Type parameters:

K: keyof UserInfoEvent

Parameters:

type: K

Type of event to unregister handler from.

handler: function

Handler function to remove.

▸ (event?: UserInfoEvent[K]): void

Parameters:

NameType
event?UserInfoEvent[K]

Returns: void


on#

on<K>(type: K, handler: function): void

Inherited from void

Register an event handler for the given type.

Type parameters:

K: keyof UserInfoEvent

Parameters:

type: K

Type of event to listen for.

handler: function

Function to call in response to given event.

▸ (event?: UserInfoEvent[K]): void

Parameters:

NameType
event?UserInfoEvent[K]

Returns: void


Other Methods#

authExpired#

authExpired(): void

API to notify the unified shell that APIs are returning 401 and user needs to be re-authenticated.

Returns: void


get#

get<T>(type: T): Promise‹UserInfo[T]›

Gets the specified type of information about an user.

Type parameters:

T: keyof UserInfo

Parameters:

NameTypeDescription
typeTThe type of information to get.

Returns: Promise‹UserInfo[T]›

  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.