chrome.extension

Deskripsi

chrome.extension API memiliki utilitas yang dapat digunakan oleh semua halaman ekstensi. Ini mencakup dukungan untuk bertukar pesan antara ekstensi dan skrip kontennya atau antara ekstensi, seperti yang dijelaskan secara mendetail dalam Penerusan Pesan.

Jenis

ViewType

Chrome 44 dan yang lebih baru

Jenis tampilan ekstensi.

Enum

"tab"

"popup"

Properti

inIncognitoContext

Berlaku untuk skrip konten yang berjalan di dalam tab samaran, dan untuk halaman ekstensi yang berjalan dalam proses samaran. Opsi yang kedua hanya berlaku untuk ekstensi dengan 'split' Samaran_behavior.

Jenis

boolean

lastError

≤ MV2 Tidak digunakan lagi sejak Chrome 58

Harap gunakan runtime.lastError.

Menetapkan masa aktif callback jika API ekstensi anskronos menghasilkan error. Jika tidak ada error yang terjadi, lastError adalah undefined.

Jenis

objek

Properti

  • pesan

    string

    Deskripsi error yang terjadi.

Metode

getBackgroundPage()

Hanya latar depan 
chrome.extension.getBackgroundPage()

Menampilkan 'jendela' JavaScript untuk halaman latar belakang yang berjalan di dalam ekstensi saat ini. Menampilkan null jika ekstensi tidak memiliki halaman latar belakang.

Hasil

  • Jendela | tidak ditentukan

getExtensionTabs()

≤ MV2 Hanya latar depan Tidak digunakan lagi
chrome.extension.getExtensionTabs(
  windowId?: number,
)

Gunakan extension.getViews {type: "tab"}.

Menampilkan array 'window' JavaScript untuk setiap tab yang berjalan di dalam ekstensi saat ini. Jika windowId ditentukan, hanya 'window' yang akan ditampilkan objek tab yang melekat pada jendela tertentu.

Parameter

  • windowId

    angka opsional

Hasil

  • Jendela[]

    Array objek jendela global

getURL()

≤ MV2 Tidak digunakan lagi sejak Chrome 58
chrome.extension.getURL(
  path: string,
)

Harap gunakan runtime.getURL.

Mengonversi jalur relatif dalam direktori penginstalan ekstensi menjadi URL yang sepenuhnya memenuhi syarat.

Parameter

  • jalur

    string

    Jalur ke resource dalam ekstensi yang dinyatakan relatif terhadap direktori penginstalannya.

Hasil

  • string

    URL yang sepenuhnya memenuhi syarat ke resource.

getViews()

Hanya latar depan 
chrome.extension.getViews(
  fetchProperties?: object,
)

Menampilkan array 'window' JavaScript untuk setiap laman yang berjalan di dalam ekstensi saat ini.

Parameter

  • fetchProperties

    objek opsional

    • tabId

      angka opsional

      Chrome 54 dan yang lebih baru

      Menemukan tampilan menurut ID tab. Jika kolom ini dihilangkan, semua tampilan akan ditampilkan.

    • jenis

      ViewType opsional

      Jenis tampilan yang akan didapatkan. Jika dihilangkan, semua tampilan akan ditampilkan (termasuk halaman latar belakang dan tab).

    • windowId

      angka opsional

      Jendela untuk membatasi penelusuran. Jika dihilangkan, menampilkan semua tampilan.

Hasil

  • Jendela[]

    Array objek global

isAllowedFileSchemeAccess()

Janji 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

Mengambil status akses ekstensi ke 'file://' skema baru. Hal ini sesuai dengan 'Izinkan akses ke URL File' per ekstensi yang dikontrol pengguna setelan yang dapat diakses melalui halaman chrome://extensions.

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      boolean

      True jika ekstensi dapat mengakses 'file://' skema, false jika tidak.

Hasil

  • Promise<boolean>

    Chrome 99 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

isAllowedIncognitoAccess()

Janji 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

Mengambil status akses ekstensi ke mode Samaran. Hal ini sesuai dengan per ekstensi yang dikontrol pengguna 'Diizinkan dalam mode Samaran' setelan yang dapat diakses melalui halaman chrome://extensions.

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      boolean

      True jika ekstensi memiliki akses ke mode Samaran, salah (false) jika tidak.

Hasil

  • Promise<boolean>

    Chrome 99 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

sendRequest()

Janji ≤ MV2 Tidak digunakan lagi
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

Harap gunakan runtime.sendMessage.

Mengirim satu permintaan ke pemroses lain dalam ekstensi. Serupa dengan runtime.connect, tetapi hanya mengirim satu permintaan dengan respons opsional. Peristiwa extension.onRequest diaktifkan di setiap halaman ekstensi.

Parameter

  • extensionId

    string opsional

    ID ekstensi yang ingin Anda hubungkan. Jika dihilangkan, defaultnya adalah ekstensi Anda sendiri.

  • minta

    apa pun

  • callback

    fungsi opsional

    Chrome 99 dan yang lebih baru

    Parameter callback terlihat seperti ini: 

    (response: any) => void

    • respons

      apa pun

      Objek respons JSON yang dikirim oleh pengendali permintaan. Jika terjadi error saat menghubungkan ke ekstensi, callback akan dipanggil tanpa argumen dan runtime.lastError akan ditetapkan ke pesan error.

Hasil

  • Janjikan<any>

    Chrome 99 dan yang lebih baru

    Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Tujuan promise yang di-resolve dengan jenis yang sama dengan yang diteruskan ke callback.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

Menetapkan nilai parameter CGI ap yang digunakan di URL update ekstensi. Nilai ini diabaikan untuk ekstensi yang dihosting di Galeri Ekstensi Chrome.

Parameter

  • data

    string

Acara

onRequest

&amp;leq; MV2 Tidak digunakan lagi
chrome.extension.onRequest.addListener(
  callback: function,
)

Harap gunakan runtime.onMessage.

Diaktifkan saat permintaan dikirim dari proses ekstensi atau skrip konten.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

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

    • minta

      apa pun

    • sendResponse

      fungsi

      Parameter sendResponse terlihat seperti ini: 

      () => void

onRequestExternal

&amp;leq; MV2 Tidak digunakan lagi
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

Harap gunakan runtime.onMessageExternal.

Diaktifkan saat permintaan dikirim dari ekstensi lain.

Parameter

  • callback

    fungsi

    Parameter callback terlihat seperti ini: 

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

    • minta

      apa pun

    • sendResponse

      fungsi

      Parameter sendResponse terlihat seperti ini: 

      () => void