Açıklama
Ekli belge tarayıcılardan görüntü keşfetmek ve almak için chrome.documentScan
API'yi kullanın.
İzinler
documentScan
Kullanılabilirlik
Belge Tarama API'sı
Document Scan API'nin amacı, uygulamaların ve uzantıların, ekli bir belge tarayıcıda basılı dokümanların içeriğini görüntülemesine olanak tanımaktır.
Türler
CancelScanResponse
Özellikler
-
iş
dize
cancelScan()
işlevine geçirilen tanıtıcıyı sağlar. -
sonuç
Arka ucun tarama iptali sonucu. Sonuç
OperationResult.SUCCESS
veyaOperationResult.CANCELLED
ise tarama iptal edilmiştir ve tarayıcı yeni bir tarama başlatmaya hazırdır. SonuçOperationResult.DEVICE_BUSY
ise , tarayıcı hâlâ istenen iptal işlemini işliyor demektir. Arayanın kısa bir süre bekleyip isteği yeniden denemesi gerekir. Diğer sonuç değerleri, yeniden denenmemesi gereken kalıcı bir hata olduğunu gösterir.
CloseScannerResponse
Özellikler
-
sonuç
Tarayıcının kapatılmasının sonucu. Bu değer
SUCCESS
olmasa bile herkese açık kullanıcı adı geçersiz olur ve daha fazla işlem için kullanılmamalıdır. -
scannerHandle
dize
closeScanner
ürününe geçirilen tarayıcı tutamacı.
Configurability
Bir seçeneğin nasıl değiştirilebileceği.
Enum
"NOT_CONFIGURABLE"
Bu seçenek salt okunurdur.
"SOFTWARE_CONFIGURABLE"
Bu seçenek yazılımda ayarlanabilir.
"HARDWARE_CONFIGURABLE"
Bu seçenek, kullanıcının tarayıcıdaki bir düğmeyi açıp kapatmasıyla veya düğmeye basmasıyla ayarlanabilir.
ConnectionType
Tarayıcının bilgisayara nasıl bağlandığını gösterir.
Enum
"USB"
Enum
"INT_RANGE"
OptionType.INT
değer aralığındaki kısıtlama. OptionConstraint
öğesinin min
, max
ve quant
özellikleri long
olacak ve list
mülkü kaldırılacak.
"FIXED_RANGE"
OptionType.FIXED
değer aralığındaki sınırlama. OptionConstraint
için min
, max
ve quant
özellikleri double
olacak ve list
özelliği ayarlanacak.
"INT_LIST"
Belirli bir OptionType.INT
değer listesindeki kısıtlama. OptionConstraint.list
özelliği long
değer içerecek, diğer özellikler ise ayarlanacak.
"FIXED_LIST"
Belirli bir OptionType.FIXED
değer listesindeki kısıtlama. OptionConstraint.list
özelliği double
değer içerecek, diğer özellikler ise ayarlanacak.
"STRING_LIST"
Belirli bir OptionType.STRING
değer listesindeki kısıtlama. OptionConstraint.list
özelliği DOMString
değer içerecek, diğer özellikler ise ayarlanacak.
DeviceFilter
Özellikler
-
local
boole isteğe bağlı
Yalnızca doğrudan bilgisayara bağlı olan tarayıcıları iade edin.
-
güvenli
boole isteğe bağlı
Yalnızca USB veya TLS gibi güvenli aktarım kullanan tarayıcıları iade edin.
GetOptionGroupsResponse
Özellikler
-
grup
OptionGroup[] isteğe bağlı
result
değeriSUCCESS
ise tarayıcı sürücüsü tarafından sağlanan sırayla seçenek gruplarının listesini sağlar. -
sonuç
Seçenek gruplarını almanın sonucu. Bunun değeri
SUCCESS
isegroups
özelliği doldurulur. -
scannerHandle
dize
getOptionGroups
ürününe geçirilen tarayıcı tutamacı.
GetScannerListResponse
Özellikler
-
sonuç
Sıralama sonucu. Bu durum bir hata olduğunu belirtse bile kısmi sonuçların döndürülebileceğini unutmayın.
-
Tarayıcılar
Sağlanan
DeviceFilter
ile eşleşen tarayıcıların büyük olasılıkla boş listesi.
OpenScannerResponse
Özellikler
-
seçenekler
isteğe bağlı
result
değeriSUCCESS
ise anahtarın cihaza özel bir seçenek, değerin iseScannerOption
örneği olduğu bir anahtar/değer eşlemesi sağlar. -
sonuç
Tarayıcının açılması. Bunun değeri
SUCCESS
isescannerHandle
veoptions
özellikleri doldurulur. -
scannerHandle
string isteğe bağlı
result
değeriSUCCESS
ise tarayıcı için daha fazla işlemde kullanılabilecek tutma yeri. -
scannerId
dize
Tarayıcı kimliği
openScanner()
cihazına iletildi.
OperationResult
Her işlemin sonucunu gösteren bir numaralandırma.
Enum
"UNKNOWN"
Bilinmeyen veya genel bir hata oluştu.
"SUCCESS"
İşlem başarılı.
"UNSUPPORTED"
İşlem desteklenmiyor.
"CANCELLED"
İşlem iptal edildi.
"DEVICE_BUSY"
Cihaz meşgul.
"INVALID"
Veriler veya yönteme iletilen bir bağımsız değişken geçerli değil.
"WRONG_TYPE"
Sağlanan değer, temel seçenek için yanlış veri türü.
"EOF"
Başka veri yok.
"ADF_JAMMED"
Doküman besleyici sıkıştı.
"ADF_EMPTY"
Doküman besleyici boş.
"COVER_OPEN"
Düz yatak kapağı açık.
"IO_ERROR"
Cihazla iletişim kurulurken bir hata oluştu.
"ACCESS_DENIED"
Cihaz kimlik doğrulaması gerektiriyor.
"NO_MEMORY"
Chromebook'ta işlemi tamamlayacak yeterli bellek yok.
"UNREACHABLE"
Cihaza erişilemiyor.
"MISSING"
Cihazın bağlantısı kesildi.
"INTERNAL_ERROR"
Çağrı yapan uygulamanın dışında bir yerde hata oluştu.
OptionConstraint
Özellikler
-
list
string[] | number[] isteğe bağlı
-
maks.
numara isteğe bağlı
-
dk
numara isteğe bağlı
-
nicelik
numara isteğe bağlı
-
tür
OptionGroup
Özellikler
-
üyeler
dize[]
Sürücü tarafından sağlanan sıraya göre seçenek adları dizisi.
-
title
dize
Yazdırılabilir bir başlık sağlar (örneğin, "Geometri seçenekleri").
OptionSetting
Özellikler
-
ad
dize
Ayarlanacak seçeneğin adını belirtir.
-
tür
Seçeneğin veri türünü belirtir. İstenen veri türü, temel seçeneğin gerçek veri türüyle eşleşmelidir.
-
value
string | number | boole | sayı[] isteğe bağlı
Ayarlanacak değeri gösterir.
autoSettable
öğesinin etkin olduğu seçenekler için otomatik ayar istemek üzere ayarlamadan bırakın.value
için sağlanan veri türütype
ile eşleşmelidir.
OptionType
Bir seçeneğin veri türü.
Enum
"UNKNOWN"
Bu seçeneğin veri türü bilinmiyor. value
özelliği kaldırılacak.
"BOOL"
value
özelliği true
false olacaktır.
"INT"
İmzalı 32 bitlik bir tam sayı. value
özelliği, seçeneğin birden fazla değer alıp almadığına bağlı olarak uzun veya uzun[] olur.
"FIXED"
1/65535 çözünürlüğünde, -32768-32767.9999 aralığında bir çift. value
özelliği, seçeneğin birden fazla değer alıp almadığına bağlı olarak çift veya çift[] olur. Tam olarak gösterilemeyen çift değerler, kullanılabilir aralığa ve kesinliğe yuvarlanır.
"STRING"
NUL ('\0') hariç herhangi bir bayt dizisi. value
özelliği bir DOMString olacaktır.
"BUTTON"
Bu tür bir seçeneğin değeri yok. Bunun yerine, bu tür bir seçeneğin ayarlanması, tarayıcı sürücüsünde seçeneğe özgü bir yan etkiye neden olur. Örneğin, düğmeyle yazılmış bir seçenek tarayıcı sürücüsü tarafından varsayılan değerleri seçmeye veya otomatik bir belge besleyiciye sonraki sayfaya ilerlemesini söyleyen bir yöntem sağlamak için kullanılabilir.
"GROUP"
Gruplandırma seçeneği. Değer yok. Bu, uyumluluk için dahil edilir, ancak normalde ScannerOption
değerlerinde döndürülmez. Üye seçenekleriyle birlikte grup listesini almak için getOptionGroups()
öğesini kullanın.
Enum
"UNITLESS"
Değer, birimsiz bir sayı. Örneğin, bu bir eşik olabilir.
"PİKSEL"
Değer, piksel sayısıdır (ör. tarama boyutları).
"BİT"
Değer, bit sayısıdır (ör. renk derinliği).
"MM"
Değer milimetre cinsinden ölçülür (ör. tarama boyutları).
"DPI"
Değer, inç başına nokta cinsinden ölçülür (ör. çözünürlük).
"PERCENT"
Değer, yüzde değeridir (ör. parlaklık).
"MICROSECOND"
Değer, mikrosaniye cinsinden ölçülür (ör. karşılaşma süresi).
ReadScanDataResponse
Özellikler
-
veri
ArrayBuffer isteğe bağlı
result
değeriSUCCESS
ise taranan resim verilerinin sonraki grubunu içerir.result
değeriEOF
ise taranan görüntü verilerinin son yığınını içerir. -
estimatedCompletion
numara isteğe bağlı
result
değeriSUCCESS
ise toplam tarama verilerinin ne kadarının şu ana kadar yayınlandığına dair bir tahmindir (0-100 aralığında). -
iş
dize
readScanData()
öğesine iletilen iş tanıtıcısını sağlar. -
sonuç
Verileri okuma işleminin sonucu. Değeri
SUCCESS
isedata
, okunmaya hazır sonraki (muhtemelen sıfır uzunlukta) resim verisi parçasını içerir. DeğeriEOF
isedata
, resim verilerinin son parçasını içerir.
ScannerInfo
Özellikler
-
connectionType
Tarayıcının bilgisayara nasıl bağlandığını gösterir.
-
deviceUuid
dize
Aynı fiziksel cihaza işaret eden diğer
ScannerInfo
girişleriyle eşleştirme yapmak için. -
imageFormats
dize[]
Döndürülen taramalar için istenebilecek MIME türleri dizisi.
-
üretici
dize
Tarayıcı üreticisi.
-
model
dize
Varsa tarayıcı modeli veya genel bir açıklama.
-
ad
dize
Tarayıcının, kullanıcı arayüzünde görüntüleyebileceği, kullanıcılar tarafından okunabilir bir ad.
-
protocolType
dize
Tarayıcıya erişmek için kullanılan protokolün veya sürücünün (Mopria, WSD veya epsonds gibi) okunabilir açıklaması. Bu işlev esasen, bir cihaz birden fazla protokolü destekliyorsa kullanıcının protokoller arasında seçim yapabilmesi açısından yararlıdır.
-
scannerId
dize
Belirli bir tarayıcının kimliği.
-
güvenli
boolean
Doğru değerine ayarlanırsa tarayıcı bağlantısının aktarımı, TLS veya USB gibi pasif bir işleyici tarafından engellenemez.
ScannerOption
Özellikler
-
yapılandırılabilirlik
Seçeneğin değiştirilip değiştirilemeyeceğini ve nasıl değiştirilebileceğini belirtir.
-
kısıtlama
OptionConstraint isteğe bağlı
Mevcut tarayıcı seçeneğinde
OptionConstraint
tanımlar. -
açıklama
dize
Seçeneğin daha uzun bir açıklaması.
-
isActive
boolean
Seçeneğin etkin olduğunu ve ayarlanabileceğini veya alınabileceğini belirtir. Yanlış değerine ayarlanırsa
value
özelliği ayarlanmaz. -
isAdvanced
boolean
Kullanıcı arayüzünün varsayılan olarak bu seçeneği görüntülememesi gerektiğini belirtir.
-
isAutoSettable
boolean
Tarayıcı sürücüsü tarafından otomatik olarak ayarlanabilir.
-
isDetectable
boolean
Bu seçeneğin yazılımdan algılanabileceğini belirtir.
-
isEmulated
boolean
Doğruysa tarayıcı sürücüsü tarafından emülasyon yapılır.
-
ad
dize
Küçük ASCII harfleri, sayıları ve tireleri kullanılan seçenek adı. Aksan işaretlerine izin verilmez.
-
title
dize
Yazdırılabilir tek satırlık başlık.
-
tür
value
özelliğinde bulunan ve bu seçeneğin ayarlanması için gerekli olan veri türü. -
birim
Bu seçenek için ölçü birimidir.
-
value
string | number | boole | sayı[] isteğe bağlı
Geçerliyse seçeneğin mevcut değeri. Bu mülkün veri türünün,
type
politikasında belirtilen veri türüyle eşleşmesi gerektiğini unutmayın.
ScanOptions
Özellikler
-
maxImages
numara isteğe bağlı
İzin verilen taranan resim sayısı. Varsayılan değer 1'dir.
-
mimeTypes
string[] isteğe bağlı
Arayan tarafından kabul edilen MIME türleri.
ScanResults
Özellikler
-
dataUrls
dize[]
Bir resim etiketine "src" değeri olarak geçirilebilecek bir formdaki veri görüntüsü URL'leri dizisi.
-
mimeType
dize
dataUrls
öğesinin MIME türü.
SetOptionResult
Özellikler
-
ad
dize
Ayarlanan seçeneğin adını gösterir.
-
sonuç
Seçenek ayarlamanın sonucunu belirtir.
SetOptionsResponse
Özellikler
-
seçenekler
isteğe bağlı
Sağlanan tüm seçenekler ayarlandıktan sonra, yeni yapılandırmayı içeren seçenek adlarından
ScannerOption
değerlerine güncellenmiş anahtar/değer eşlemesi. Bu,OpenScannerResponse
içindekioptions
mülküyle aynı yapıya sahiptir.Bazı seçenekler başarıyla ayarlanmasa bile bu özellik ayarlanır, ancak güncellenen yapılandırmanın alınamaması durumunda (örneğin, taramanın ortasında tarayıcının bağlantısı kesilirse) ayarlanmaz.
-
sonuç
Her
OptionSetting
için iletilen bir sonuç dizisi. -
scannerHandle
dize
setOptions()
öğesine iletilen tarayıcı tanıtıcısını sağlar.
StartScanOptions
Özellikler
-
biçim
dize
Taranan verilerin döndürüleceği MIME türünü belirtir.
-
maxReadSize
numara isteğe bağlı
Sıfır dışında bir değer belirtilirse bu değere tek bir
readScanData
yanıtında döndürülen maksimum taranan bayt sayısını sınırlar. İzin verilen en küçük değer 32768'dir (32 KB). Bu özellik belirtilmezse döndürülen bir parçanın boyutu, taranan görüntünün tamamı kadar büyük olabilir.
StartScanResponse
Özellikler
-
iş
string isteğe bağlı
result
değeriSUCCESS
ise tarama verilerini okumak veya işi iptal etmek için kullanılabilecek bir herkese açık kullanıcı adı sağlar. -
sonuç
Taramanın başlatılmasının sonucu. Bunun değeri
SUCCESS
isejob
özelliği doldurulur. -
scannerHandle
dize
startScan()
öğesine geçirilen tarayıcı tanıtıcısını sağlar.
Yöntemler
cancelScan()
chrome.documentScan.cancelScan(
job: string,
callback?: function,
)
Başlatılmış bir taramayı iptal eder ve CancelScanResponse
nesnesiyle çözümlenen bir Promise döndürür. Bir geri çağırma kullanılırsa, bunun yerine nesne buna iletilir.
Parametreler
-
iş
dize
Daha önce
startScan
çağrısından döndürülen etkin bir tarama işinin herkese açık kullanıcı adı. -
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(response: CancelScanResponse) => void
-
yanıt
-
İlerlemeler
-
Promise<CancelScanResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
closeScanner()
chrome.documentScan.closeScanner(
scannerHandle: string,
callback?: function,
)
Tarayıcıyı, iletilen işleyiciyle kapatır ve CloseScannerResponse
nesnesiyle çözümlenen bir Promise döndürür. Bir geri çağırma kullanılırsa, bunun yerine nesne buna iletilir. Yanıt başarılı olmasa bile, sağlanan herkese açık kullanıcı adı geçersiz hale gelir ve bundan sonraki işlemlerde kullanılmamalıdır.
Parametreler
-
scannerHandle
dize
Daha önce
openScanner
öğesine yapılan bir çağrıdan döndürülen açık bir tarayıcının kullanıcı adını belirtir. -
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(response: CloseScannerResponse) => void
-
yanıt
-
İlerlemeler
-
Promise<CloseScannerResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
getOptionGroups()
chrome.documentScan.getOptionGroups(
scannerHandle: string,
callback?: function,
)
Daha önce openScanner
tarafından açılmış bir tarayıcıdan grup adlarını ve üye seçeneklerini alır. Bu yöntem, GetOptionGroupsResponse
nesnesiyle çözümlenen bir Promise döndürür. Bu işleve bir geri çağırma aktarılırsa döndürülen veriler bu işleve iletilir.
Parametreler
-
scannerHandle
dize
openScanner
çağrısından döndürülen açık tarayıcının kullanıcı adı. -
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(response: GetOptionGroupsResponse) => void
-
yanıt
-
İlerlemeler
-
Promise<GetOptionGroupsResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
getScannerList()
chrome.documentScan.getScannerList(
filter: DeviceFilter,
callback?: function,
)
Kullanılabilir tarayıcıların listesini alır ve GetScannerListResponse
nesnesiyle çözümlenen bir Promise döndürür. Bu işleve bir geri çağırma aktarılırsa döndürülen veriler bu işleve iletilir.
Parametreler
-
filter
Döndürülecek tarayıcı türlerini belirten bir
DeviceFilter
. -
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(response: GetScannerListResponse) => void
-
yanıt
-
İlerlemeler
-
Promise<GetScannerListResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
openScanner()
chrome.documentScan.openScanner(
scannerId: string,
callback?: function,
)
Özel erişim için bir tarayıcı açar ve OpenScannerResponse
nesnesiyle çözümlenen bir Promise döndürür. Bu işleve bir geri çağırma aktarılırsa döndürülen veriler bu işleve iletilir.
Parametreler
-
scannerId
dize
Açılacak tarayıcının kimliği. Bu değer,
getScannerList
için yapılan önceki bir çağrıdan döndürülen bir değerdir. -
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(response: OpenScannerResponse) => void
-
yanıt
-
İlerlemeler
-
Promise<OpenScannerResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
readScanData()
chrome.documentScan.readScanData(
job: string,
callback?: function,
)
Etkin bir iş tanıtıcısından mevcut resim verilerinin sonraki parçasını okur ve ReadScanDataResponse
nesnesiyle çözümlenen bir Promise döndürür. Bir geri çağırma kullanılırsa, bunun yerine nesne buna iletilir.
**Not:**Yanıt sonucunun sıfır uzunlukta data
üyesi olan SUCCESS
olması için geçerlidir. Bu, tarayıcının çalışmaya devam ettiği ancak ek verilerinin henüz hazır olmadığı anlamına gelir. Arayan kişi kısa bir süre bekleyip tekrar denemelidir.
Tarama işi tamamlandığında yanıt EOF
sonucunu verir. Bu yanıtta, değeri sıfır olmayan son bir data
üye bulunabilir.
Parametreler
-
iş
dize
Daha önce
startScan
öğesinden döndürülen etkin iş tanıtıcısı. -
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(response: ReadScanDataResponse) => void
-
yanıt
-
İlerlemeler
-
Promise<ReadScanDataResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
scan()
chrome.documentScan.scan(
options: ScanOptions,
callback?: function,
)
Belge taraması yürütür ve ScanResults
nesnesiyle çözümlenen bir Promise döndürür. Bu işleve bir geri çağırma aktarılırsa döndürülen veriler bu işleve geçirilir.
Parametreler
-
seçenekler
Tarama parametrelerini içeren bir nesne.
-
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(result: ScanResults) => void
-
sonuç
-
İlerlemeler
-
Promise<ScanResults>
Chrome 96 ve sonraki sürümlerVaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
setOptions()
chrome.documentScan.setOptions(
scannerHandle: string,
options: OptionSetting[],
callback?: function,
)
Belirtilen tarayıcıda seçenekleri ayarlar ve her değeri, iletilen OptionSetting
nesnesinin sırasına göre ayarlamaya çalışmanın sonucunu içeren bir SetOptionsResponse
nesnesiyle çözümlenen Promise döndürür. Bir geri çağırma kullanılırsa, bunun yerine nesne buna iletilir.
Parametreler
-
scannerHandle
dize
Seçeneklerin ayarlanacağı tarayıcının tutma yeri. Bu, daha önce
openScanner
için yapılan bir çağrıdan döndürülen değer olmalıdır. -
seçenekler
Tarayıcıya uygulanacak
OptionSetting
nesnelerin listesi. -
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(response: SetOptionsResponse) => void
-
yanıt
-
İlerlemeler
-
Promise<SetOptionsResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.
startScan()
chrome.documentScan.startScan(
scannerHandle: string,
options: StartScanOptions,
callback?: function,
)
Belirtilen tarayıcıda tarama başlatır ve StartScanResponse
ile çözülen bir Promise döndürür. Bir geri çağırma kullanılırsa, bunun yerine nesne buna iletilir. Çağrı başarılı olduysa yanıt, tarama verilerini okumak veya bir taramayı iptal etmek için sonraki çağrılarda kullanılabilecek bir iş işleyici içerir.
Parametreler
-
scannerHandle
dize
Açık bir tarayıcının tutma yeri. Bu, daha önce
openScanner
için yapılan bir çağrıdan döndürülen değer olmalıdır. -
seçenekler
Tarama için kullanılacak seçenekleri belirten bir
StartScanOptions
nesnesi.StartScanOptions.format
özelliği, tarayıcınınScannerInfo
işlevinde döndürülen girişlerden biriyle eşleşmelidir. -
geri çağırma
Functions (isteğe bağlı)
callback
parametresi şu şekilde görünür:(response: StartScanResponse) => void
-
yanıt
-
İlerlemeler
-
Promise<StartScanResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümlerde desteklenir. Diğer platformların geri çağırmaları kullanması gerekir.