addGlobalNotification (Referensi API Klien)

Menampilkan pemberitahuan kesalahan, informasi, peringatan, atau keberhasilan untuk aplikasi, dan memungkinkan Anda menentukan tindakan yang akan dijalankan berdasarkan pemberitahuan.

Syntax

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

Parameter-parameternya

Nama Tipe Diperlukan Description
notification Objek Yes Pemberitahuan yang akan ditambahkan. Lihat parameter pemberitahuan
successCallback Function Tidak. Fungsi yang akan dipanggil saat pemberitahuan ditampilkan. Nilai GUID diteruskan untuk mengidentifikasi pemberitahuan secara unik. Anda dapat menggunakan nilai GUID untuk menutup atau menutup pemberitahuan menggunakan metode clearGlobalNotification.
errorCallback Function Tidak. Fungsi untuk memanggil saat operasi gagal.

properti pemberitahuan

Objek berisi properti berikut:

Harta benda Tipe Diperlukan Description
action Objek Tidak. Objek dengan properti berikut:
- actionLabel(Opsional) Tali. Label untuk tindakan dalam pesan.
- eventHandler: (Opsional) Referensi fungsi. Fungsi yang akan dijalankan saat label tindakan diklik.
level Number Yes Menentukan tingkat pemberitahuan. Nilai yang valid adalah:
1: Berhasil
2: Kesalahan
3: Peringatan
4: Informasi
message String Yes Pesan yang akan ditampilkan dalam pemberitahuan.
showCloseButton Bool Tidak. Menunjukkan apakah pengguna dapat menutup atau menutup pemberitahuan atau tidak. Jika Anda tidak menentukan parameter ini, pengguna tidak dapat menutup atau menutup pemberitahuan secara default.
type Number Yes Menentukan jenis pemberitahuan. Saat ini, hanya nilai 2 yang didukung, yang menampilkan bilah pesan di bagian atas aplikasi.

Mengembalikan Nilai

Setelah berhasil, mengembalikan objek janji yang berisi nilai GUID untuk mengidentifikasi pemberitahuan secara unik seperti yang dijelaskan sebelumnya dalam deskripsi parameter successCallback .

Examples

Menampilkan pemberitahuan kesalahan yang tidak dapat ditutup atau ditutup oleh pengguna

// 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
    }
);

Ini adalah bagaimana pemberitahuan kesalahan akan muncul di aplikasi:

Contoh pemberitahuan kesalahan.

Menampilkan pemberitahuan peringatan yang dapat ditutup atau ditutup oleh pengguna

// 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
    }
);

Ini adalah bagaimana pemberitahuan peringatan akan muncul di aplikasi:

Contoh pemberitahuan peringatan.

// 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
    }
);

Ini adalah bagaimana pemberitahuan informasi akan muncul di aplikasi:

Contoh pemberitahuan informasi.

clearGlobalNotification