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

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 the 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]›

Next steps

Explore details of the Index, Page, TopBar, and User external modules.

Explore the attributes and behavior of Adobe Experience Cloud Interfaces:

Modules

Runtime

Return to the Guides Index.