chrome.events

Açıklama

Kavramlar ve kullanım

Event, ilginç bir şey olduğunda bildirim almanızı sağlayan bir nesnedir. Bir Alarm süresi dolduğunda bildirim almak için chrome.alarms.onAlarm etkinliğini kullanma örneği:

chrome.alarms.onAlarm.addListener((alarm) => {
  appendToLog(`alarms.onAlarm -- name: ${alarm.name}, scheduledTime: ${alarm.scheduledTime}`);
});

Örnekte gösterildiği gibi, bildirime addListener() kullanarak kaydolursunuz. Bağımsız değişken addListener() her zaman etkinliği işlemek için tanımladığınız bir işlevdir ancak işlevi, gerçekleştirdiğiniz etkinliğe bağlıdır. alarms.onAlarm ile ilgili dokümanlar kontrol ediliyor, işlevin tek bir parametreye (ayrıntılar içeren bir alarms.Alarm nesnesi) sahip olduğunu görebilirsiniz geçen alarmla ilgili.

Etkinlikleri kullanan örnek API'ler: alarms, i18n, identity, runtime. Chrome'un çoğu API'lerde çalışır.

Bildirim Temelli Etkinlik İşleyiciler

Bildirim temelli etkinlik işleyiciler, bildirim temelli koşullardan oluşan kuralları tanımlamak için bir yöntem sağlar. ve işlemler. Koşullar, JavaScript motoru yerine tarayıcıda değerlendirilir. Bu da gecikmelere neden oluyor ve son derece yüksek verimlilik sağlıyor.

Bildirim temelli etkinlik işleyiciler, Declarative Content API. Bu sayfada, tüm bildirimli etkinliklerin temel kavramları açıklanmaktadır işleyicileri tarafından desteklenmektedir.

Kurallar

Olası en basit kural, bir veya daha fazla koşuldan ve bir ya da daha fazla işlemden oluşur:

const rule = {
  conditions: [ /* my conditions */ ],
  actions: [ /* my actions */ ]
};

Koşullardan herhangi biri karşılanırsa tüm işlemler yürütülür.

Koşullar ve işlemlere ek olarak, her kurala bir tanımlayıcı verebilirsiniz. Bu tanımlayıcı daha önce kaydedilmiş kuralların kaydını silme ve kurallar arasındaki öncelikleri tanımlamaya öncelik verir. Öncelikler yalnızca, kurallar birbiriyle çakıştığında veya belirli bir sipariş. İşlemler, kurallarının önceliğine göre azalan düzende yürütülür.

const rule = {
  id: "my rule",  // optional, will be generated if not set.
  priority: 100,  // optional, defaults to 100.
  conditions: [ /* my conditions */ ],
  actions: [ /* my actions */ ]
};

Etkinlik nesneleri

Etkinlik nesneleri, kuralları destekleyebilir. Bu etkinlik nesneleri, olaylar gerçekleşir, ancak kayıtlı herhangi bir kuralın en az bir yerine getirilmiş koşul içerip içermediğini test eder ve bu kuralla ilişkili işlemlerdir. Bildirim temelli API'yi destekleyen etkinlik nesnelerinde üç bulunur alakalı yöntemler: events.Event.addRules(), events.Event.removeRules() ve events.Event.getRules().

Kural ekle

Kural eklemek için etkinlik nesnesinin addRules() işlevini çağırın. Bir dizi kural örneği alır işlevini çağırır.

const rule_list = [rule1, rule2, ...];
addRules(rule_list, (details) => {...});

Kurallar başarıyla eklendiyse details parametresi, eklenen kurallardan oluşan bir dizi içerir rule_list isteğe bağlı parametrelerin id ve priority oluşturulan değerlerle dolduruldu. Herhangi bir kural geçersizse (ör. geçersiz bir koşul veya işlem görüyorsanız kurallardan hiçbiri eklenmez ve runtime.lastError değişkeni değeri, geri çağırma işlevi çağrıldığında ayarlanır. rule_list grubundaki her kural benzersiz bir değer içermelidir zaten başka bir kural veya boş tanımlayıcı tarafından kullanılmayan tanımlayıcı.

Kuralları kaldır

Kuralları kaldırmak için removeRules() işlevini çağırın. İsteğe bağlı kural tanımlayıcıları dizisini kabul eder ilk parametresi olarak ve ikinci parametresi olarak bir geri çağırma işlevi kullanılır.

const rule_ids = ["id1", "id2", ...];
removeRules(rule_ids, () => {...});

rule_ids bir tanımlayıcı dizisiyse dizide listelenmiş tanımlayıcılara sahip tüm kurallar emin olun. rule_ids tarafından bilinmeyen bir tanımlayıcı listeleniyorsa bu tanımlayıcı sessizce yoksayılır. Eğer rule_ids undefined. Bu uzantının tüm kayıtlı kuralları kaldırıldı. callback() işlevi, kurallar kaldırıldığında çağrılır.

Kuralları al

Kayıtlı kuralların listesini almak için getRules() işlevini çağırın. Kabul edilen bir removeRules() ile aynı anlama sahip isteğe bağlı kural tanımlayıcıları ve geri çağırma işlevi dizisi.

const rule_ids = ["id1", "id2", ...];
getRules(rule_ids, (details) => {...});

callback() işlevine iletilen details parametresi, şunları içeren bir kural dizisine başvurur: doldurulan isteğe bağlı parametrelerdir.

Performans

En yüksek performansa ulaşmak için aşağıdaki yönergeleri aklınızda bulundurmanız gerekir.

Kuralları toplu olarak kaydedin ve kayıtlarını iptal edin. Her kayıt veya kaydın iptal edilmesinden sonra Chrome'un şunları yapması gerekir: dahili veri yapılarını güncellemektir. Bu güncelleme pahalı bir işlemdir.

const rule1 = {...};
const rule2 = {...};
chrome.declarativeWebRequest.onRequest.addRules([rule1]);
chrome.declarativeWebRequest.onRequest.addRules([rule2]);

const rule1 = {...};
const rule2 = {...};
chrome.declarativeWebRequest.onRequest.addRules([rule1, rule2]);

events.UrlFilter içindeki normal ifadeler yerine alt dize eşleştirmesini tercih edin. Alt dizeye dayalı eşleştirme son derece hızlıdır.

const match = new chrome.declarativeWebRequest.RequestMatcher({
  url: {urlMatches: "example.com/[^?]*foo" }
});

const match = new chrome.declarativeWebRequest.RequestMatcher({
  url: {hostSuffix: "example.com", pathContains: "foo"}
});

Aynı işlemleri paylaşan birçok kural varsa bunları tek bir kuralda birleştirin. Kurallar, tek bir koşul karşılanır edilmez işlemlerini tetikler. Bu da ekip arkadaşlarınızın eşleşmesini sağlar ve yinelenen işlem grupları için bellek tüketimini azaltır.

const condition1 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'example.com' }
});
const condition2 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'foobar.com' }
});
const rule1 = { conditions: [condition1],
                actions: [new chrome.declarativeWebRequest.CancelRequest()]
              };
const rule2 = { conditions: [condition2],
                actions: [new chrome.declarativeWebRequest.CancelRequest()]
              };
chrome.declarativeWebRequest.onRequest.addRules([rule1, rule2]);

const condition1 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'example.com' }
});
const condition2 = new chrome.declarativeWebRequest.RequestMatcher({
  url: { hostSuffix: 'foobar.com' }
});
const rule = { conditions: [condition1, condition2],
              actions: [new chrome.declarativeWebRequest.CancelRequest()]
             };
chrome.declarativeWebRequest.onRequest.addRules([rule]);

Filtrelenen etkinlikler

Filtrelenmiş etkinlikler, dinleyicilerin etkinleştirdikleri etkinliklerin alt kümelerini belirtmesine olanak tanıyan mekanizmadır. emin olabilirsiniz. Filtre kullanan bir işleyici Bu filtre, dinleme kodunu daha bildirimsel ve verimli hale getirir. Service Worker'a yönelik bir ihtiyaç umursamadığı olaylara karşı uyanmadı.

Filtrelenen etkinlikler, manuel filtreleme kodundan geçişe olanak tanımak için tasarlanmıştır.

chrome.webNavigation.onCommitted.addListener((event) => {
  if (hasHostSuffix(event.url, 'google.com') ||
      hasHostSuffix(event.url, 'google.com.au')) {
    // ...
  }
});

chrome.webNavigation.onCommitted.addListener((event) => {
  // ...
}, {url: [{hostSuffix: 'google.com'},
          {hostSuffix: 'google.com.au'}]});

Etkinlikler, söz konusu etkinlik için anlamlı olan belirli filtreleri destekler. Bir etkinliğin düzenlediği filtrelerin "filtreler" sütunundaki bu etkinlikle ilgili dokümanlarda listelenir bölümüne bakın.

Etkinlik filtreleri, URL'leri eşleştirirken (yukarıdaki örnekte olduğu gibi) aynı URL eşleşmesini destekler özellikleri, şema ve bağlantı noktası eşleştirme hariç, events.UrlFilter ile ifade edilebilir.