addNotification (客户端 API 参考)

显示控件的错误或建议通知,并允许你根据通知指定要执行的作。 指定错误类型的通知时,控件旁边会显示一个红色的“X”图标。 指定通知的建议类型时,控件旁边会显示一个“i”图标。 在 Dynamics 365 移动客户端上,点击图标将显示消息,并通过单击 “应用 ”按钮或关闭消息来执行配置的作。

支持的控件类型

全部

Syntax

formContext.getControl(arg).addNotification(notification);

参数

Name 类型 必选 Description
notification 物体 是的 要添加的通知。 请参阅 notification 参数

notification 参数

该 notification 参数接受具有以下属性的对象

Name 类型 必选 Description
actions 对象数组 否 See actions 属性
messages 字符串数组 是的 通知中显示的消息。 在当前版本中,仅显示此数组中指定的第一条消息。 此处指定的字符串在通知中显示为粗体文本,通常用于通知的标题或主题。 应将消息限制为 50 个字符,以获得最佳的用户体验。
notificationLevel String 是的 定义通知的类型。 有效值为 ERROR 或 RECOMMENDATION。
uniqueId String 是的 使用 clearNotification 方法时用于清除此通知的 ID。

actions 属性

该 actions 属性包含具有以下属性的对象数组:

Name 类型 必选 Description
message String 否 要向用户显示的通知的正文消息。 将消息限制为 100 个字符,以获得最佳的用户体验。
actions 函数数组 否 消息的相应作。

返回值

类型:布尔值

说明:指示方法是否成功。

注解

在 Web 客户端中, addNotification 方法显示一个通知,其中包含指定的消息和两个标准按钮: 应用 和 消除。 单击 “应用” 将执行定义的作;单击 “关闭 ”关闭通知消息。

在统一接口中:

  • 没有 “关闭 ”按钮。
  • 仅当通知级别设置为“建议”而不是“错误”时,才会显示“应用”按钮。

Example

以下示例代码在帐户窗体的“帐户名称”列中显示一条通知,用于设置“帐户名称”列(如果“帐户名称”列包含“Microsoft”),并且刻度符号尚未设置为“MSFT”。 单击通知中的 “应用 ”会将 刻度符号 列设置为“MSFT”。

function addTickerSymbolRecommendation(executionContext) {
    var formContext = executionContext.getFormContext();
    var myControl = formContext.getControl('name');
    var accountName = formContext.data.entity.attributes.get('name');
    var tickerSymbol = formContext.data.entity.attributes.get('tickersymbol');

    if (accountName.getValue() == 'Microsoft' && tickerSymbol.getValue() != 'MSFT') {
        var actionCollection = {
            message: 'Set the Ticker Symbol to MSFT?',
            actions: null
        };

        actionCollection.actions = [function () {
            tickerSymbol.setValue('MSFT');
            myControl.clearNotification('my_unique_id');
        }];

        myControl.addNotification({
            messages: ['Set Ticker Symbol'],
            notificationLevel: 'RECOMMENDATION',
            uniqueId: 'my_unique_id',
            actions: [actionCollection]
        });
    }
    else
        console.log("Notification not set");
}

通知在模型驱动应用中的显示方式:

示例添加通知。

clearNotification
setNotification