Açıklama
Ekli belge tarayıcılardan resim keşfetmek ve almak için chrome.documentScan
API'yi kullanın.
İzinler
documentScan
Kullanılabilirlik
Belge Tarama API'sı
Document Scan API, uygulamaların ve uzantıların ekli belge tarayıcıda kağıt doküman içeriği.
Türler
CancelScanResponse
Özellikler
-
iş
dize
cancelScan()
adlı iş ortağına geçirilen işin aynısını 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ı , istenen iptal işlemini hâlâ gerçekleştiriyordur; arayanın kısa bir süre beklemesi ve isteği tekrar denemesi gerekir. Diğer sonuç değerleri, yeniden denenmemesi gereken kalıcı bir hatayı 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 başka işlemler için kullanılmamalıdır. -
scannerHandle
dize
closeScanner
içine geçirilen tarayıcı tutma yeri aynı.
Configurability
Seçeneklerin nasıl değiştirilebileceği
Enum
"NOT_CONFIGURABLE"
Bu seçenek salt okunurdur.
"SOFTWARE_CONFIGURABLE"
Bu seçenek, yazılımın içinden ayarlanabilir.
"HARDWARE_CONFIGURABLE"
Bu seçenek, kullanıcının tarayıcıdaki bir düğmeyi açıp kapatarak veya düğmeye basarak ayarlanabilir.
ConnectionType
Tarayıcının bilgisayara nasıl bağlandığını gösterir.
Enum
"BELİRTİLMEMİŞ"
"USB"
"AĞ"
ConstraintType
OptionConstraint
ile temsil edilen kısıtlama veri türü.
Enum
"INT_RANGE"
OptionType.INT
değer aralığındaki kısıtlama. OptionConstraint
öğesinin min
, max
ve quant
özellikleri long
olacak ve list
özelliği kaldırılacak.
"FIXED_RANGE"
OptionType.FIXED
değer aralığındaki bir kısıtlama. OptionConstraint
öğesinin min
, max
ve quant
özellikleri double
olacak, list
özelliği ayarlanacak.
"INT_LIST"
Belirli bir OptionType.INT
değeri listesindeki kısıtlama. OptionConstraint.list
özelliği long
değerleri içerir, diğer özellikler ise ayarlanmamış olur.
"FIXED_LIST"
Belirli bir OptionType.FIXED
değeri listesindeki kısıtlama. OptionConstraint.list
özelliği double
değerleri içerir, diğer özellikler ise ayarlanmamış olur.
"STRING_LIST"
Belirli bir OptionType.STRING
değeri listesindeki kısıtlama. OptionConstraint.list
özelliği DOMString
değerleri içerir, diğer özellikler ise ayarlanmamış olur.
DeviceFilter
Özellikler
-
local
boole isteğe bağlı
Yalnızca bilgisayara doğrudan bağlı olan tarayıcıları iade edin.
-
güvenli
boole isteğe bağlı
Yalnızca USB veya TLS gibi güvenli bir aktarım kullanan tarayıcıları döndürün.
GetOptionGroupsResponse
Özellikler
-
groups
OptionGroup[] isteğe bağlı
result
değeriSUCCESS
ise tarayıcı sürücüsü tarafından belirtilen sırada bir seçenek gruplarının listesini sağlar. -
sonuç
Seçenek gruplarının alınmasının sonucu. Bunun değeri
SUCCESS
isegroups
özelliği doldurulur. -
scannerHandle
dize
getOptionGroups
içine geçirilen tarayıcı tutma yeri aynı.
GetScannerListResponse
Özellikler
-
sonuç
Numaralandırma sonucu. Bu 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 listesi boş olabilir.
OpenScannerResponse
Özellikler
-
seçenekler
nesne isteğe bağlı
result
değeriSUCCESS
ise anahtarın cihaza özel bir seçenek olduğu ve değerinScannerOption
örneği olduğu bir anahtar/değer eşlemesi sağlar. -
sonuç
Tarayıcının açılma sonucu. Bunun değeri
SUCCESS
isescannerHandle
veoptions
özellikleri doldurulur. -
scannerHandle
dize isteğe bağlı
result
değeriSUCCESS
ise tarayıcının gelecekteki işlemler için kullanılabilecek bir herkese açık kullanıcı adı. -
scannerId
dize
openScanner()
adlı cihaza iletilen tarayıcı kimliği.
OperationResult
Her işlemin sonucunu gösteren bir sıralama.
Enum
"UNKNOWN"
Bilinmeyen veya genel bir hata oluştu.
"BAŞARILI"
İşlem başarılı oldu.
"UNSUPPORTED"
İşlem desteklenmiyor.
"İPTAL EDİLDİ"
İşlem iptal edildi.
"DEVICE_BUSY"
Cihaz meşgul.
"GEÇERSİZ"
Yönteme iletilen veriler veya 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ışmış.
"ADF_EMPTY"
Belge 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ğrulama gerektiriyor.
"NO_MEMORY"
Chromebook'ta işlemi tamamlamak için yeterli bellek yok.
"UNREACHABLE"
Cihaza erişilemiyor.
"MISSING"
Cihazın bağlantısı kesildi.
"INTERNAL_ERROR"
Çağrı yapan uygulamanın dışında bir hata oluştu.
OptionConstraint
Özellikler
-
list
string[] | sayı[] isteğe bağlı
-
maks.
sayı isteğe bağlı
-
dk
sayı isteğe bağlı
-
miktar
sayı isteğe bağlı
-
tür
OptionGroup
Özellikler
-
üyeler
dize[]
Sürücü tarafından sağlanan sırada bir seçenek adları dizisi.
-
title
dize
"Geometri seçenekleri" gibi yazdırılabilir bir başlık sağlar.
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 | sayı | boolean | sayı[] isteğe bağlı
Ayarlanacak değeri gösterir.
autoSettable
öğesinin etkin olduğu seçenekler için otomatik ayar yapılmasını istemek için 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"
Seçeneğin veri türü bilinmiyor. value
özelliği ayarlanmaz.
"BOOL"
value
özelliği, true
false değerlerinden biri olacaktır.
"INT"
İmzalı 32 bitlik bir tam sayı. value
özelliği, seçeneğin birden fazla değer almasına bağlı olarak uzun veya uzun olur[].
"SABİTLENMİŞ"
-32768-32767,9999 aralığında 1/65535 çözünürlüğe sahip bir çift. value
özelliği, seçeneğin birden fazla değer almasına bağlı olarak çift veya çift[] olur. Tam olarak temsil edilemeyen çift değerler, kullanılabilir aralığa ve hassasiyete yuvarlanır.
"STRING"
NUL ('\0') hariç herhangi bir bayt dizisi. value
özelliği bir DOMString olur.
"Button"
Bu tür bir seçeneğin değer yoktur. 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, bir tarayıcı sürücüsü tarafından varsayılan değerleri seçmeye yönelik bir yöntem sağlamak veya otomatik belge besleyiciye sonraki kağıda ilerlemesini söylemek için düğmeyle yazılan bir seçenek kullanılabilir.
"GROUP"
Gruplandırma seçeneği. Değer yok. Bu dize uyumluluk için dahil edilir ancak normalde ScannerOption
değerlerinde döndürülmez. Grup listesini üye seçenekleriyle birlikte almak için getOptionGroups()
öğesini kullanın.
OptionUnit
ScannerOption.unit
için veri türünü belirtir.
Enum
"UNITLESS"
Değer, birimsiz bir sayıdır. Örneğin, bu bir eşik olabilir.
"PIXEL"
Değer, piksel sayısıdır (ör. tarama boyutları).
"BIT"
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üzdedir (ör. parlaklık).
"MİKRO İKİNCİ"
Değer, mikrosaniye cinsinden ölçülür (ör. pozlama süresi).
ReadScanDataResponse
Özellikler
-
veri
ArrayBuffer isteğe bağlı
result
değeriSUCCESS
ise taranan resim verilerinin sonraki parçasını içerir.result
değeriEOF
ise taranan resim verilerinin son parçasını içerir. -
estimatedCompletion
sayı isteğe bağlı
result
değeriSUCCESS
ise 0 ile 100 aralığında şu ana kadar toplam tarama verilerinin ne kadarının teslim edildiğine dair bir tahmin. -
iş
dize
readScanData()
işlevine iletilen iş herkese açık kullanıcı adını sağlar. -
sonuç
Veri okuma işleminin sonucu. Değeri
SUCCESS
isedata
, okunmaya hazır sonraki (muhtemelen sıfır uzunlukta) resim veri parçasını içerir. DeğeriEOF
isedata
, resim verisinin 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 kullanılır. -
imageFormats
dize[]
Döndürülen taramalar için istenebilecek bir MIME türü 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ülemek üzere kullanıcılar tarafından okunabilen ad.
-
protocolType
dize
Tarayıcıya erişmek için kullanılan protokolün veya sürücünün (ör. Mopria, WSD veya epsonds) kullanıcılar tarafından okunabilen açıklaması. Bu, cihaz birden fazla protokolü destekliyorsa kullanıcının protokoller arasında seçim yapmasına izin vermek için öncelikli olarak kullanışlı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ına TLS veya USB gibi pasif bir dinleyici tarafından müdahale edilemez.
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ı
Geçerli 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 bu seçeneği varsayılan olarak 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üle edilir.
-
ad
dize
Küçük ASCII harfleri, sayılar ve kısa çizgiler kullanan seçenek adı. Aksan işaretlerine izin verilmiyor.
-
title
dize
Yazdırılabilir tek satırlık başlık.
-
tür
value
özelliğinde yer alan ve bu seçeneğin ayarlanması için gerekli olan veri türü. -
birim
Bu seçeneğin ölçü birimi.
-
value
string | sayı | boolean | sayı[] isteğe bağlı
Gerekiyorsa seçeneğin mevcut değeri. Bu mülkün veri türünün,
type
özelliğinde belirtilen veri türüyle eşleşmesi gerektiğini unutmayın.
ScanOptions
Özellikler
-
maxImages
sayı isteğe bağlı
İzin verilen taranmış 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[]
"src" olarak iletilebilecek bir formdaki veri görüntüsü URL'leri dizisi bir resim etiketine eklemeniz gerekir.
-
mimeType
dize
dataUrls
öğesinin MIME türü.
SetOptionResult
Özellikler
-
ad
dize
Ayarlanan seçeneğin adını belirtir.
-
sonuç
Seçeneği ayarlamanın sonucunu gösterir.
SetOptionsResponse
Özellikler
-
seçenekler
nesne isteğe bağlı
Sağlanan tüm seçenekleri ayarlamaya çalıştıktan sonra seçenek adlarından yeni yapılandırmayı içeren
ScannerOption
değerlerine yönelik anahtar/değer eşlemesi güncellendi. Bu,OpenScannerResponse
içindekioptions
mülküyle aynı yapıya sahiptir.Bu özellik, bazı seçenekler başarıyla ayarlanmamış olsa bile ayarlanır, ancak güncellenen yapılandırmanın alınması başarısız olursa (örneğin, tarama sırasında tarayıcının bağlantısı kesilirse) ayarlanmaz.
-
sonuç
Geçilen her
OptionSetting
için bir sonuç dizisi. -
scannerHandle
dize
setOptions()
işlevine geçirilen tarayıcı tutma yerini sağlar.
StartScanOptions
Özellikler
-
format
dize
Taranan verilerin döndürüleceği MIME türünü belirtir.
-
maxReadSize
sayı isteğe bağlı
Sıfır olmayan bir değer belirtilirse tek bir
readScanData
yanıtında bu değere döndürülen maksimum taranan bayt sayısı sınırlanır. İzin verilen en küçük değer 32768'dir (32 KB). Bu özellik belirtilmezse döndürülen parçanın boyutu, taranan resmin tamamı kadar büyük olabilir.
StartScanResponse
Özellikler
-
iş
dize 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ç
Tarama işleminin sonucu. Bunun değeri
SUCCESS
isejob
özelliği doldurulur. -
scannerHandle
dize
startScan()
içine geçirilen tarayıcı tutma yerini sağlar.
Yöntemler
cancelScan()
chrome.documentScan.cancelScan(
job: string,
callback?: function,
)
Başlatılan bir taramayı iptal eder ve CancelScanResponse
nesnesiyle çözülen bir Vaat döndürür. Geri çağırma kullanılırsa bunun yerine nesne ona iletilir.
Parametreler
-
iş
dize
Daha önce
startScan
için yapılan bir çağrıdan döndürülen etkin bir tarama işinin herkese açık kullanıcı adı. -
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(response: CancelScanResponse) => void
-
yanıt
-
İadeler
-
Promise<CancelScanResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.
closeScanner()
chrome.documentScan.closeScanner(
scannerHandle: string,
callback?: function,
)
İletilen herkese açık kullanıcı adıyla tarayıcıyı kapatır ve CloseScannerResponse
nesnesiyle çözümlenen bir Vaat döndürür. Geri çağırma kullanılırsa bunun yerine nesne ona iletilir. Yanıt başarılı olmasa bile, sağlanan herkese açık kullanıcı adı geçersiz hale gelir ve bundan sonraki işlemler için kullanılmamalıdır.
Parametreler
-
scannerHandle
dize
Daha önce
openScanner
için yapılan bir çağrıdan döndürülen açık bir tarayıcının herkese açık kullanıcı adını belirtir. -
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(response: CloseScannerResponse) => void
-
yanıt
-
İadeler
-
Promise<CloseScannerResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması 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 iletilirse döndürülen veriler bunun yerine ona iletilir.
Parametreler
-
scannerHandle
dize
openScanner
'e yapılan bir aramadan döndürülen açık tarayıcının herkese açık kullanıcı adı. -
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(response: GetOptionGroupsResponse) => void
-
yanıt
-
İadeler
-
Promise<GetOptionGroupsResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması 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 iletilirse döndürülen veriler bunun yerine ona iletilir.
Parametreler
-
filtrele
Hangi tarayıcı türlerinin döndürülmesi gerektiğini gösteren bir
DeviceFilter
. -
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(response: GetScannerListResponse) => void
-
yanıt
-
İadeler
-
Promise<GetScannerListResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.
openScanner()
chrome.documentScan.openScanner(
scannerId: string,
callback?: function,
)
Özel erişim için bir tarayıcı açar ve OpenScannerResponse
nesnesiyle çözülen bir Vaat döndürür. Bu işleve bir geri çağırma iletilirse döndürülen veriler bunun yerine ona iletilir.
Parametreler
-
scannerId
dize
Açılacak tarayıcının kimliği. Bu değer,
getScannerList
'e yapılan önceki bir çağrıdan döndürülen değerdir. -
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(response: OpenScannerResponse) => void
-
yanıt
-
İadeler
-
Promise<OpenScannerResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.
readScanData()
chrome.documentScan.readScanData(
job: string,
callback?: function,
)
Etkin bir iş işleyiciden bir sonraki kullanılabilir görüntü verisi parçasını okur ve ReadScanDataResponse
nesnesiyle çözümlenen bir Vaat döndürür. Geri çağırma kullanılırsa bunun yerine nesne ona iletilir.
**Not:**Sıfır uzunluklu data
üyesine sahip bir yanıt sonucunun SUCCESS
olması için geçerlidir. Bu, tarayıcının hâlâ çalıştığı ancak henüz ek verilerin hazır olmadığı anlamına gelir. Arayanın kısa bir süre bekleyip tekrar denemesi gerekir.
Tarama işi tamamlandığında yanıtın sonuç değeri EOF
olur. Bu yanıt, değeri sıfır olmayan nihai bir data
üye içerebilir.
Parametreler
-
iş
dize
Daha önce
startScan
kaynağından döndürülen etkin iş herkese açık kullanıcı adı. -
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(response: ReadScanDataResponse) => void
-
yanıt
-
İadeler
-
Promise<ReadScanDataResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.
scan()
chrome.documentScan.scan(
options: ScanOptions,
callback?: function,
)
Bir doküman taraması gerçekleştirir ve ScanResults
nesnesiyle çözümlenen bir Promise (Vaat) döndürür. Bu işleve bir geri çağırma iletilirse döndürülen veriler bunun yerine ona iletilir.
Parametreler
-
seçenekler
Tarama parametreleri içeren bir nesne.
-
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(result: ScanResults) => void
-
sonuç
-
İadeler
-
Promise<ScanResults>
Chrome 96 ve sonraki sürümler 'nı inceleyin.Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.
setOptions()
chrome.documentScan.setOptions(
scannerHandle: string,
options: OptionSetting[],
callback?: function,
)
Belirtilen tarayıcıdaki seçenekleri ayarlar ve her değeri iletilen OptionSetting
nesnesinin sırasına göre ayarlamaya çalışmanın sonucunu içeren SetOptionsResponse
nesnesiyle çözümlenen bir Promise (Vadet) döndürür. Geri çağırma kullanılırsa bunun yerine nesne ona iletilir.
Parametreler
-
scannerHandle
dize
Seçenekleri ayarlamak için tarayıcının tutma yeri. Bu, daha önce
openScanner
için yapılan bir çağrıdan döndürülen bir değer olmalıdır. -
seçenekler
Tarayıcıya uygulanacak
OptionSetting
nesne listesi. -
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(response: SetOptionsResponse) => void
-
yanıt
-
İadeler
-
Promise<SetOptionsResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.
startScan()
chrome.documentScan.startScan(
scannerHandle: string,
options: StartScanOptions,
callback?: function,
)
Belirtilen tarayıcıda bir tarama başlatır ve StartScanResponse
ile çözülen bir Vaat döndürür. Geri çağırma kullanılırsa bunun yerine nesne ona iletilir. Çağrı başarılı olduysa yanıtta, tarama verilerini okumak veya bir taramayı iptal etmek için sonraki çağrılarda kullanılabilecek bir iş tanıtıcısı bulunur.
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 bir değer olmalıdır. -
seçenekler
Tarama için kullanılacak seçenekleri gösteren
StartScanOptions
nesnesi.StartScanOptions.format
özelliği, tarayıcınınScannerInfo
öğesinde döndürülen girişlerden biriyle eşleşmelidir. -
geri çağırma
işlev isteğe bağlı
callback
parametresi şu şekilde görünür:(response: StartScanResponse) => void
-
yanıt
-
İadeler
-
Promise<StartScanResponse>
Vaatler yalnızca Manifest V3 ve sonraki sürümler için desteklenir. Diğer platformların geri çağırma yapması gerekir.