addGlobalNotification (Tài liệu tham khảo về API máy khách)

Hiển thị lỗi, thông tin, cảnh báo hoặc thông báo thành công cho một ứng dụng và cho phép bạn chỉ định các hành động để thực hiện dựa trên thông báo.

Cú pháp

Xrm.App.addGlobalNotification(notification).then(successCallback, errorCallback);

Tham số

Tên Kiểu Bắt buộc Sự miêu tả
notification Đối tượng Thông báo cần thêm. Xem thông số thông báo
successCallback Hàm Không Một chức năng để gọi khi thông báo được hiển thị. Một giá trị GUID được truyền để nhận dạng duy nhất thông báo. Bạn có thể sử dụng giá trị GUID để đóng hoặc bỏ thông báo bằng phương pháp clearGlobalNotification.
errorCallback Hàm Không Một hàm để gọi khi hoạt động không thành công.

thuộc tính thông báo

Đối tượng chứa các thuộc tính sau:

Tài sản Kiểu Bắt buộc Sự miêu tả
action Đối tượng Không Một đối tượng với các thuộc tính sau:
- actionLabel(Tùy chọn) Xâu. Nhãn cho hành động trong thư.
- eventHandler: (Tùy chọn) Tham chiếu hàm. Hàm để thực hiện khi bấm vào nhãn hành động.
level Số Xác định mức độ thông báo. Giá trị hợp lệ là:
1: Thành công
2: Lỗi
3: Cảnh báo
4: Thông tin
message String Thông báo sẽ hiển thị trong thông báo.
showCloseButton Bool Không Cho biết người dùng có thể đóng hoặc bỏ thông báo hay không. Nếu bạn không chỉ định tham số này, người dùng không thể đóng hoặc bỏ qua thông báo theo mặc định.
type Số Xác định loại thông báo. Hiện tại, chỉ hỗ trợ giá trị 2, hiển thị thanh thông báo ở đầu ứng dụng.

Trả về giá trị

Khi thành công, trả về một đối tượng promise chứa một giá trị GUID để xác định duy nhất thông báo như được mô tả ở phần trước trong mô tả của tham số successCallback .

Ví dụ

Hiển thị thông báo lỗi mà người dùng không thể đóng hoặc bỏ qua

// define notification object
var notification = 
{
  type: 2,
  level: 2, //error
  message: "Test error notification"
}

Xrm.App.addGlobalNotification(notification).then(
    function success(result) {
        console.log("Notification created with ID: " + result);
        // perform other operations as required on notification display
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Đây là cách thông báo lỗi sẽ xuất hiện trong ứng dụng:

Ví dụ về thông báo lỗi.

Hiển thị thông báo cảnh báo mà người dùng có thể đóng hoặc bỏ qua

// define notification object
var notification = 
{
  type: 2,
  level: 3, //warning
  message: "Test warning notification",
  showCloseButton: true
}

Xrm.App.addGlobalNotification(notification).then(
    function success(result) {
        console.log("Notification created with ID: " + result);
        // perform other operations as required on notification display
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Đây là cách thông báo cảnh báo sẽ xuất hiện trong ứng dụng:

Ví dụ về thông báo cảnh báo.

// define action object
var myAction =
{
  actionLabel: "Learn more", 
  eventHandler: function () {
        Xrm.Navigation.openUrl("https://learn.microsoft.com/powerapps/");
        // perform other operations as required on clicking
    }
}

// define notification object
var notification = 
{
  type: 2,
  level: 4, // information
  message: "Test information notification",  
  action: myAction
}

Xrm.App.addGlobalNotification(notification).then(
    function success(result) {
        console.log("Notification created with ID: " + result);
        // perform other operations as required on notification display
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

Đây là cách thông báo thông tin sẽ xuất hiện trong ứng dụng:

Thông báo thông tin ví dụ.

clearGlobalNotification