Deskripsi
chrome.extension
API memiliki utilitas yang dapat digunakan oleh halaman ekstensi mana pun. Fitur ini mencakup dukungan untuk bertukar pesan antara ekstensi dan skrip kontennya atau antar-ekstensi, seperti yang dijelaskan secara mendetail dalam Penerusan Pesan.
Jenis
ViewType
Jenis tampilan ekstensi.
Enum
"tab"
"popup"
Properti
inIncognitoContext
Berlaku untuk skrip konten yang berjalan dalam tab samaran, dan untuk halaman ekstensi yang berjalan dalam proses samaran. Yang kedua hanya berlaku untuk ekstensi dengan samaran_behavior 'split'.
Jenis
boolean
lastError
Gunakan runtime.lastError
.
Ditetapkan untuk masa aktif callback jika API ekstensi ansychronous menghasilkan error. Jika tidak ada error yang terjadi, lastError akan undefined
.
Jenis
objek
Properti
-
pesan
string
Deskripsi error yang telah terjadi.
Metode
getBackgroundPage()
chrome.extension.getBackgroundPage()
Menampilkan objek 'window' 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()
chrome.extension.getExtensionTabs(
windowId?: number,
)
Gunakan extension.getViews
{type: "tab"}
.
Menampilkan array objek 'window' JavaScript untuk setiap tab yang berjalan di dalam ekstensi saat ini. Jika windowId
ditentukan, hanya menampilkan objek 'window' tab yang terpasang ke jendela yang ditentukan.
Parameter
-
windowId
nomor opsional
Hasil
-
Jendela[]
Array objek jendela global
getURL()
chrome.extension.getURL(
path: string,
)
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 untuk resource.
getViews()
chrome.extension.getViews(
fetchProperties?: object,
)
Menampilkan array objek 'window' JavaScript untuk setiap halaman yang berjalan di dalam ekstensi saat ini.
Parameter
-
fetchProperties
objek opsional
-
tabId
nomor opsional
Chrome 54+Menemukan tampilan menurut ID tab. Jika kolom ini dihilangkan, akan menampilkan semua tampilan.
-
tipe
ViewType opsional
Jenis tampilan yang akan didapatkan. Jika dihilangkan, akan mengembalikan semua tampilan (termasuk halaman latar belakang dan tab).
-
windowId
nomor opsional
Jendela untuk membatasi penelusuran. Jika dihilangkan, akan menampilkan semua tampilan.
-
Hasil
-
Jendela[]
Array objek global
isAllowedFileSchemeAccess()
chrome.extension.isAllowedFileSchemeAccess(
callback?: function,
)
Mengambil status akses ekstensi ke skema 'file://'. Hal ini sesuai dengan setelan 'Izinkan akses ke URL File' per ekstensi yang dikontrol pengguna yang dapat diakses melalui halaman chrome://extensions.
Parameter
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(isAllowedAccess: boolean) => void
-
isAllowedAccess
boolean
True jika ekstensi dapat mengakses skema 'file://', false jika tidak.
-
Hasil
-
Promise<boolean>
Chrome 99 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
isAllowedIncognitoAccess()
chrome.extension.isAllowedIncognitoAccess(
callback?: function,
)
Mengambil status akses ekstensi ke mode Samaran. Hal ini sesuai dengan setelan 'Diizinkan dalam mode Samaran' per ekstensi yang dikontrol pengguna yang dapat diakses melalui halaman chrome://extensions.
Parameter
-
callback
fungsi opsional
Parameter
callback
terlihat seperti:(isAllowedAccess: boolean) => void
-
isAllowedAccess
boolean
True jika ekstensi memiliki akses ke mode Samaran, false jika tidak.
-
Hasil
-
Promise<boolean>
Chrome 99 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
sendRequest()
chrome.extension.sendRequest(
extensionId?: string,
request: any,
callback?: function,
)
Gunakan runtime.sendMessage
.
Mengirim satu permintaan ke pemroses lain dalam ekstensi. Serupa dengan runtime.connect
, tetapi hanya mengirimkan satu permintaan dengan respons opsional. Peristiwa extension.onRequest
diaktifkan di setiap halaman ekstensi.
Parameter
-
extensionId
string opsional
ID ekstensi dari ekstensi yang ingin Anda hubungkan. Jika dihilangkan, ekstensi default adalah ekstensi Anda sendiri.
-
minta
apa pun
-
callback
fungsi opsional
Chrome 99 dan yang lebih baruParameter
callback
terlihat seperti:(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 disetel ke pesan error.
-
Hasil
-
Janji<apa pun>
Chrome 99 dan yang lebih baruPromise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.
setUpdateUrlData()
chrome.extension.setUpdateUrlData(
data: string,
)
Menetapkan nilai parameter ap CGI yang digunakan dalam URL update ekstensi. Nilai ini diabaikan untuk ekstensi yang dihosting di Galeri Ekstensi Chrome.
Parameter
-
data
string
Acara
onRequest
chrome.extension.onRequest.addListener(
callback: function,
)
Gunakan runtime.onMessage
.
Diaktifkan jika permintaan dikirim dari proses ekstensi atau skrip konten.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(request: any, sender: runtime.MessageSender, sendResponse: function) => void
-
minta
apa pun
-
pengirim
-
sendResponse
fungsi
Parameter
sendResponse
terlihat seperti:() => void
-
onRequestExternal
chrome.extension.onRequestExternal.addListener(
callback: function,
)
Gunakan runtime.onMessageExternal
.
Diaktifkan saat permintaan dikirim dari ekstensi lain.
Parameter
-
callback
fungsi
Parameter
callback
terlihat seperti:(request: any, sender: runtime.MessageSender, sendResponse: function) => void
-
minta
apa pun
-
pengirim
-
sendResponse
fungsi
Parameter
sendResponse
terlihat seperti:() => void
-