Interface: UserAPI

• EventEmitter‹UserInfoEvent›

  ↳ UserAPI

• 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.

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

Inherited from void

Invoke all handlers for the given type.

Type parameters:

▪ K: keyof UserInfoEvent

Parameters:

Returns: void

▸ 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:

Returns: void

▸ 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:

Returns: void

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

Gets the specified type of information about an user.

Type parameters:

▪ T: keyof UserInfo

Parameters:

Returns: Promise‹UserInfo[T]›

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.