Skip to main content

Global context.ShowUserNotification

ShowUserNotification

Syntax

ShowUserNotification(<Text>, <ActionOnClick>, <Explanation>, <Picture>, <UserNotificationStatus>, <UniquenessKey>)

Parameters

<Text> (optional)

Type: String. Notification text.

<ActionOnClick> (optional)

Type: String, CallbackDescription. If the String type, it contains a link to navigate when clicking the alert window. After the navigation the alert window will be closed. If CallbackDescription type, contains a description of the procedure that is called after clicking the alert window with the parameters:

  • <AdditionalParameters> - value specified when the CallbackDescription object was created.

After the procedure is called, the alert window will be closed. When using this parameter, it is recommended to set the text specifying the need for user’s reaction to the alert.

<Explanation> (optional)

Type: String. Notification description.

<Picture> (optional)

Type: Picture. Picture that will be displayed in the notification.

<UserNotificationStatus> (optional)

Type: UserNotificationStatus. The user notification importance. The status depends on the importance of the information provided in the notification. In interface modes Version8_2 or Version8_2EnableTaxi this parameter is ignored. Default value: Information.

<UniquenessKey> (optional)

Type: String. A notification key. If the key is specified and there is an open notification with the same key, the notification is replaced with the new one. If this parameter is not specified or it is set to Undefined, the notification is considered unique. In interface modes Version8_2 or Version8_2EnableTaxi this parameter is ignored. Default value: Undefined.

Description

Shows a pop-up notification window that can display a text notification and a picture. For notifications with Important status, the window disappears in 10 seconds. Multiple notifications can be displayed at once. Clicking a notification window either calls a procedure specified in the notification description or opens the URL target. For notifications with Information status, the window fades slowly and then disappears. One notification is displayed at a time. The window can contain a URL; clicking the URL either calls a procedure specified in the notification description or opens the URL target.

Availability

Thin client, web-client, mobile client, thick client, mobile application (client).

See also

URLPresentation, property URL Global context, method GetURL

Translation

Русская версия: Глобальный контекст.ПоказатьОповещениеПользователя (Global context.ShowUserNotification)