chrome.extension

Açıklama

chrome.extension API'sinde, herhangi bir uzantı sayfası tarafından kullanılabilecek yardımcı programlar bulunur. Message Passing (Mesaj Geçirme) bölümünde ayrıntılı olarak açıklandığı gibi, bir uzantı ile içerik komut dosyaları arasında veya uzantılar arasında mesaj alışverişi desteği içerir.

Türler

ViewType

Chrome 44 veya daha yeni bir sürüm

Uzantı görünümünün türü.

Enum

"tab"

"popup"

Özellikler

inIncognitoContext

Gizli sekmelerde çalışan içerik komut dosyaları ve gizli işlemde çalışan uzantı sayfaları için geçerlidir. İkincisi yalnızca "split" incognito_behavior özelliğine sahip uzantılar için geçerlidir.

Tür

boolean

lastError

≤ MV2 Chrome 58'den beri kullanımdan kaldırıldı

Lütfen runtime.lastError kullanın.

Eşzamansız bir uzantı API'si hatayla sonuçlandıysa geri çağırma süresi boyunca ayarlanır. Herhangi bir hata oluşmadıysa lastError undefined olur.

Tür

nesne

Özellikler

  • mesaj

    dize

    Meydana gelen hatanın açıklaması.

Yöntemler

getBackgroundPage()

Yalnızca ön plan 
chrome.extension.getBackgroundPage(): Window | undefined

Geçerli uzantıda çalışan arka plan sayfası için JavaScript "window" nesnesini döndürür. Uzantının arka plan sayfası yoksa null değerini döndürür.

İadeler

  • Window | undefined

getExtensionTabs()

≤ MV2 Yalnızca ön planda Desteği sonlandırıldı
chrome.extension.getExtensionTabs(
  windowId?: number,
): Window[]

Lütfen extension.getViews {type: "tab"} kullanın.

Mevcut uzantıda çalışan her sekme için JavaScript "window" nesnelerinden oluşan bir dizi döndürür. windowId belirtilirse yalnızca belirtilen pencereye eklenmiş sekmelerin "pencere" nesnelerini döndürür.

Parametreler

  • windowId

    number isteğe bağlı

İadeler

  • Window[]

    Global pencere nesneleri dizisi

getURL()

≤ MV2 Chrome 58'den beri kullanımdan kaldırıldı
chrome.extension.getURL(
  path: string,
): string

Lütfen runtime.getURL kullanın.

Bir uzantı yükleme dizinindeki göreli yolu tam nitelikli bir URL'ye dönüştürür.

Parametreler

  • yol

    dize

    Bir uzantı içindeki kaynağın, yükleme dizinine göre ifade edilen yolu.

İadeler

  • dize

    Kaynağın tam nitelikli URL'si.

getViews()

Yalnızca ön plan 
chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

Geçerli uzantıda çalışan sayfaların her biri için JavaScript "window" nesnelerinin dizisini döndürür.

Parametreler

  • fetchProperties

    object isteğe bağlı

    • tabId

      number isteğe bağlı

      Chrome 54 veya daha yeni bir sürüm

      Sekme kimliğine göre görünüm bulma Bu alan çıkarılırsa tüm görünümler döndürülür.

    • tür

      ViewType isteğe bağlı

      Alınacak görünüm türü. Atlanırsa arka plan sayfaları ve sekmeler dahil olmak üzere tüm görünümleri döndürür.

    • windowId

      number isteğe bağlı

      Aramanın kısıtlanacağı pencere. Atlanırsa tüm görünümleri döndürür.

İadeler

  • Window[]

    Genel nesneler dizisi

isAllowedFileSchemeAccess()

Promise 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
): Promise<boolean>

Uzantının "file://" şemasına erişim durumunu alır. Bu, chrome://extensions sayfası üzerinden erişilebilen, kullanıcı tarafından kontrol edilen uzantı başına "Dosya URL'lerine erişime izin ver" ayarına karşılık gelir.

Parametreler

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      boolean

      Uzantı "file://" şemasına erişebiliyorsa doğru, aksi takdirde yanlış.

İadeler

  • Promise<boolean>

    Chrome 99 veya daha yeni bir sürüm

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

isAllowedIncognitoAccess()

Promise 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
): Promise<boolean>

Uzantının gizli moda erişim durumunu alır. Bu, chrome://extensions sayfası üzerinden erişilebilen, kullanıcı tarafından kontrol edilen uzantı başına "Gizli modda izin verilir" ayarına karşılık gelir.

Parametreler

  • callback

    işlev isteğe bağlı

    callback parametresi şu şekilde görünür: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      boolean

      Uzantının Gizli mod'a erişimi varsa doğru, aksi takdirde yanlış.

İadeler

  • Promise<boolean>

    Chrome 99 veya daha yeni bir sürüm

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

sendRequest()

Promise &leq; MV2 Desteği sonlandırıldı
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
): Promise<any>

Lütfen runtime.sendMessage kullanın.

Uzantıdaki diğer dinleyicilere tek bir istek gönderir. runtime.connect özelliğine benzer ancak yalnızca isteğe bağlı yanıt içeren tek bir istek gönderir. extension.onRequest etkinliği, uzantının her sayfasında tetiklenir.

Parametreler

  • extensionId

    dize isteğe bağlı

    Bağlanmak istediğiniz uzantının uzantı kimliği. Atlanırsa varsayılan olarak kendi uzantınız kullanılır.

  • istek

    herhangi

  • callback

    işlev isteğe bağlı

    Chrome 99 veya daha yeni bir sürüm

    callback parametresi şu şekilde görünür: 

    (response: any) => void

    • gönderin

      herhangi

      İsteğin işleyicisi tarafından gönderilen JSON yanıt nesnesi. Uzantıya bağlanırken bir hata oluşursa geri çağırma bağımsız değişken olmadan çağrılır ve runtime.lastError hata mesajına ayarlanır.

İadeler

  • Promise<any>

    Chrome 99 veya daha yeni bir sürüm

    Promises yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformlarda geri çağırmalar kullanılmalıdır.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
): void

Uzantının güncelleme URL'sinde kullanılan ap CGI parametresinin değerini ayarlar. Bu değer, Chrome Uzantı Galerisi'nde barındırılan uzantılar için yoksayılır.

Parametreler

  • aktarma

    dize

Etkinlikler

onRequest

&leq; MV2 Kullanımdan kaldırıldı
chrome.extension.onRequest.addListener(
  callback: function,
)

Lütfen runtime.onMessage kullanın.

Bir uzantı işleminden veya içerik komut dosyasından istek gönderildiğinde tetiklenir.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • istek

      herhangi

    • sendResponse

      işlev

      sendResponse parametresi şu şekilde görünür: 

      () => void

onRequestExternal

&leq; MV2 Kullanımdan kaldırıldı
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

Lütfen runtime.onMessageExternal kullanın.

Başka bir uzantıdan istek gönderildiğinde tetiklenir.

Parametreler

  • callback

    işlev

    callback parametresi şu şekilde görünür: 

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • istek

      herhangi

    • sendResponse

      işlev

      sendResponse parametresi şu şekilde görünür: 

      () => void