chrome.extension

Açıklama

chrome.extension API, herhangi bir uzantı sayfası tarafından kullanılabilecek yardımcı programlar içerir. İleti Aktarma bölümünde ayrıntılı olarak açıklandığı gibi, bir uzantı ile içeriğin komut dosyaları veya uzantılar arasında mesaj alışverişi desteği içerir.

Türler

ViewType

Chrome 44 ve sonraki sürümler

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

Enum

"popup"

Özellikler

inIncognitoContext

Gizli sekmeler içinde çalışan içerik komut dosyaları ve gizli bir işlem içinde çalışan uzantı sayfaları için doğru değerini alır. İkinci kural yalnızca "bölünmüş" Secret_behavior davranışına sahip uzantılar için geçerlidir.

Tür

boolean

lastError

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

Lütfen runtime.lastError hesabını kullanın.

Ansychronous uzantı api bir hatayla sonuçlandıysa geri çağırma işleminin kullanım ömrü için ayarlayın. Herhangi bir hata oluşmadıysa lastError değeri undefined olacaktır.

Tür

nesne

Özellikler

  • mesaj

    dize

    Oluşan hatanın açıklaması.

Yöntemler

getBackgroundPage()

Yalnızca ön plan
chrome.extension.getBackgroundPage()

Geçerli uzantının içinde çalışan arka plan sayfası için JavaScript "window" nesnesini döndürür. Uzantının arka plan sayfası yoksa boş sonucunu döndürür.

İlerlemeler

  • Pencere|tanımsız

getExtensionTabs()

≤ MV2 Yalnızca ön plan Kullanımdan kaldırıldı
chrome.extension.getExtensionTabs(
  windowId?: number,
)

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

Geçerli uzantının içinde çalışan sekmelerin her biri için JavaScript "window" nesnelerinden oluşan bir dizi döndürür. windowId belirtilirse yalnızca belirtilen pencereye ekli sekmelerin "window" nesnelerini döndürür.

Parametreler

  • windowId

    numara isteğe bağlı

İlerlemeler

  • Pencere[]

    Global pencere nesneleri dizisi

getURL()

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

Lütfen runtime.getURL hesabını kullanın.

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

Parametreler

  • yol

    dize

    Uzantı içindeki bir kaynağın yükleme dizinine göre ifade edilen yolu.

İlerlemeler

  • dize

    Kaynağın tam nitelikli URL'si.

getViews()

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

Geçerli uzantının içinde çalışan sayfaların her biri için JavaScript "window" nesnelerinden oluşan bir dizi döndürür.

Parametreler

  • fetchProperties

    isteğe bağlı

    • tabId

      numara isteğe bağlı

      Chrome 54 ve sonraki sürümler

      Sekme kimliğine göre bir görünüm bulun. Bu alan atlanırsa tüm görünümleri döndürür.

    • tür

      ViewType isteğe bağlı

      Elde edilecek görüntüleme türüdür. Atlanırsa tüm görünümleri (arka plan sayfaları ve sekmeler dahil) döndürür.

    • windowId

      numara isteğe bağlı

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

İlerlemeler

  • Pencere[]

    Küresel nesneler dizisi

isAllowedFileSchemeAccess()

Söz
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

Uzantının "file://" şemasına erişim durumunu alır. Bu, chrome://extensions sayfasından erişilebilen, her uzantı için kullanıcı tarafından denetlenen "Dosya URL'lerine erişime izin ver" ayarına karşılık gelir.

Parametreler

  • geri çağırma

    Functions (isteğe bağlı)

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

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      Uzantı "file://" şemasına erişebiliyorsa True, aksi takdirde false değerini alır.

İlerlemeler

  • Promise<boolean>

    Chrome 99 ve sonraki sürümler

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

isAllowedIncognitoAccess()

Söz
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

Uzantının Gizli moda erişim durumunu alır. Bu, chrome://extensions sayfasından erişilebilen, her uzantı için kullanıcı tarafından denetlenen "Gizli modda izin verildi" ayarına karşılık gelir.

Parametreler

  • geri çağırma

    Functions (isteğe bağlı)

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

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      Uzantının Gizli moda erişimi varsa doğru, gizli moddaysa yanlış değerini alır.

İlerlemeler

  • Promise<boolean>

    Chrome 99 ve sonraki sürümler

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

sendRequest()

Söz &leq; MV2 Kullanımdan kaldırıldı
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

Lütfen runtime.sendMessage hesabını kullanın.

Uzantı içindeki diğer işleyicilere tek bir istek gönderir. runtime.connect ile benzerdir, ancak yalnızca isteğe bağlı bir yanıtla tek bir istek gönderir. extension.onRequest etkinliği, uzantının her sayfasında tetiklenir.

Parametreler

  • extensionId

    string isteğe bağlı

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

  • istek

    Tümü

  • geri çağırma

    Functions (isteğe bağlı)

    Chrome 99 ve sonraki sürümler

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

    (response: any)=>void

    • yanıt

      Tümü

      İ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 hata mesajı runtime.lastError olarak ayarlanır.

İlerlemeler

  • Söz<herhangi>

    Chrome 99 ve sonraki sürümler

    Vaatler, Manifest V3 ve sonraki sürümlerde desteklenir ancak geriye dönük uyumluluk için geri çağırmalar sağlanır. Aynı işlev çağrısında ikisini birden kullanamazsınız. Vaat, geri çağırmaya iletilen aynı türle çözümlenir.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

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

  • veri

    dize

Etkinlikler

onRequest

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

Lütfen runtime.onMessage hesabını kullanın.

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

Parametreler

  • geri çağırma

    işlev

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

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

    • istek

      Tümü

    • 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 hesabını kullanın.

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

Parametreler

  • geri çağırma

    işlev

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

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

    • istek

      Tümü

    • sendResponse

      işlev

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

      ()=>void