Aracılığıyla paylaş


addGlobalNotification (İstemci API başvurusu)

Bir uygulama için hata, bilgi, uyarı veya başarı bildirimi görüntüler ve bildirime göre yürütülecek eylemleri belirtmenize olanak tanır.

Sözdizimi

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

Parametreler

İsim Türü Gerekli Description
notification Nesne Yes Eklenecek bildirim. Bkz . bildirim parametresi
successCallback İşlev Hayı Bildirim görüntülendiğinde çağrılacak bir işlev. Bildirimi benzersiz olarak tanımlamak için bir GUID değeri geçirilir. clearGlobalNotification yöntemini kullanarak bildirimi kapatmak veya kapatmak için GUID değerini kullanabilirsiniz.
errorCallback İşlev Hayı İşlem başarısız olduğunda çağrılacak bir işlev.

notification özelliği

nesnesi aşağıdaki özellikleri içerir:

Mülkiyet Türü Gerekli Description
action Nesne Hayı Aşağıdaki özelliklere sahip bir nesne:
- actionLabel(İsteğe bağlı) Dizgi. İletideki eylemin etiketi.
- eventHandler: (İsteğe bağlı) İşlev başvurusu. Eylem etiketine tıklandığında yürütülecek işlev.
level Sayı Yes Bildirim düzeyini tanımlar. Geçerli değerler şunlardır:
1: Başarı
2: Hata
3: Uyarı
4: Bilgi
message String Yes Bildirimde görüntülenecek ileti.
showCloseButton Boole Hayı Kullanıcının bildirimi kapatıp kapatamayacağını gösterir. Bu parametreyi belirtmezseniz, kullanıcılar bildirimi varsayılan olarak kapatamaz veya kapatamaz.
type Sayı Yes Bildirim türünü tanımlar. Şu anda yalnızca 2 değeri desteklenmektedir ve bu değer uygulamanın üst kısmında bir ileti çubuğu görüntüler.

Dönüş Değeri

Başarılı olduğunda, daha önce successCallback parametresinin açıklamasında açıklandığı gibi bildirimi benzersiz olarak tanımlamak için GUID değeri içeren bir promise nesnesi döndürür.

Örnekler

Kullanıcı tarafından kapatılabilen veya kapatılabilen bir hata bildirimi görüntüleme

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

Hata bildirimi uygulamada şu şekilde görünür:

Örnek hata bildirimi.

Kullanıcı tarafından kapatılabilen veya kapatılabilen bir uyarı bildirimi görüntüleme

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

Uyarı bildirimi uygulamada şu şekilde görünür:

Örnek uyarı bildirimi.

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

Bilgi bildirimi uygulamada şu şekilde görünür:

Örnek bilgi bildirimi.

clearGlobalNotification