Skip to content

Commit 4cf5736

Browse files
lunaaawlunaaaw
committed
filter apis
1 parent ab6b3ba commit 4cf5736

File tree

3 files changed

+76
-89
lines changed

3 files changed

+76
-89
lines changed

‎info/api/WebTwain_Acquire.md‎

Lines changed: 22 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,26 @@ permalink: /info/api/WebTwain_Acquire.html
8686
| :------------------------------------ |
8787
| [`OnSourceUIClose`](#onsourceuiclose) |
8888

89+
<div class="multi-panel-end">
90+
91+
</div><div class="multi-panel-start"></div>
92+
93+
>The Android Service Edition only supports a subset of the APIs available in the Desktop Service Edition. For the APIs that are compatible with both editions, the usage remains the same. To learn how to use the APIs, please refer to the documentation for the Desktop Service Edition.
94+
95+
**Methods**
96+
97+
| |
98+
| :-------------------------------------------------- | :---------------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------------- |
99+
| [`SelectSourceAsync()`](#selectsourceasync) | [`CloseSourceAsync()`](#closesourceasync) | [`GetDevicesAsync()`](#getdevicesasync) | [`SelectDeviceAsync()`](#selectdeviceasync) |
100+
| [`AcquireImageAsync()`](#acquireimageasync) |[`getCapabilities()`](#getcapabilities) | [`setCapabilities()`](#setcapabilities) |
101+
102+
**Events**
103+
104+
| |
105+
| :------------------------------------ |
106+
| [`OnPostTransferAsync`](#onposttransferasync) |
89107

108+
<div class="multi-panel-end"></div>
90109

91110

92111
---
@@ -103,26 +122,11 @@ AcquireImage(
103122
successCallBack?: () => void,
104123
failureCallBack?: (deviceConfiguration?: DeviceConfiguration, errorCode: number, errorString: string) => void
105124
): void;
106-
107-
interface DeviceConfiguration {
108-
IfShowUI?: boolean; //Whether to show the built-in User Interface from the device vendor
109-
PixelType?: Dynamsoft.DWT.EnumDWT_PixelType | number | string; //Whether to scan in color, grey or black & white
110-
Resolution?: number; //Measured by dots per pixel (DPI)
111-
IfFeederEnabled?: boolean; //Whether to use the document feeder or the flatbed of the device
112-
IfDuplexEnabled?: boolean; //Whether to scan one side or both sides
113-
IfDisableSourceAfterAcquire?: boolean; //Whether to close the built-in User Interface after aquisition. Only valid when {IfShowUI} is true.
114-
IfGetImageInfo?: boolean; //Whether to retrieve information about the image after it's transferred.
115-
IfGetExtImageInfo?: boolean; //Whether to retrieve extended information about the image after it's transferred.
116-
extendedImageInfoQueryLevel?: Dynamsoft.DWT.EnumDWT_ExtImageInfo | number; //How much extended information is retrieved. Only valid when {IfGetExtImageInfo} is true.
117-
SelectSourceByIndex?: number; //Specify a source by its index.
118-
IfCloseSourceAfterAcquire?: boolean; //Whether to close the data source after aquisition. Default: false.
119-
PageSize?: Dynamsoft.DWT.EnumDWT_CapSupportedSizes | number; //Specify page size
120-
}
121125
```
122126

123127
**Parameters**
124128

125-
`deviceConfiguration`: Configuration for the acquisition.
129+
`deviceConfiguration`: Configuration for the acquisition. Please refer to [Interface]({{site.info}}api/Interfaces.html#DeviceConfiguration).
126130

127131
`successCallback`: A callback function that is executed if the request succeeds.
128132

@@ -4691,7 +4695,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
46914695

46924696
**Parameters**
46934697

4694-
`device`: the device object. Please refer to [Device]({{site.info}}api/Interfaces.html#device)
4698+
`device`: the device object. Please refer to [Interface]({{site.info}}api/Interfaces.html#device).
46954699

46964700
**Availability**
46974701

@@ -4733,7 +4737,7 @@ AcquireImageAsync(deviceConfiguration?: DeviceConfiguration): Promise< boolean>;
47334737

47344738
**Parameters**
47354739

4736-
`deviceConfiguration`: The device configuration
4740+
`deviceConfiguration`: The device configuration. Please refer to [Interface]({{site.info}}api/Interfaces.html#DeviceConfiguration).
47374741

47384742
**Availability**
47394743

@@ -4772,25 +4776,6 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
47724776
console.error(e)
47734777
})
47744778
```
4775-
<div class="multi-panel-end">
4776-
4777-
</div><div class="multi-panel-start"></div>
4778-
4779-
>The Android Service Edition only supports a subset of the APIs available in the Desktop Service Edition. For the APIs that are compatible with both editions, the usage remains the same. To learn how to use the APIs, please refer to the documentation for the Desktop Service Edition.
4780-
4781-
**Methods**
4782-
4783-
| |
4784-
| :-------------------------------------------------- | :---------------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------------- |
4785-
| [`SelectSourceAsync()`](#selectsourceasync) | [`CloseSourceAsync()`](#closesourceasync) | [`GetDevicesAsync()`](#getdevicesasync) | [`SelectDeviceAsync()`](#selectdeviceasync) |
4786-
| [`AcquireImageAsync()`](#acquireimageasync) |[`getCapabilities()`](#getcapabilities) | [`setCapabilities()`](#setcapabilities) |
4787-
4788-
**Events**
47894779

4790-
| |
4791-
| :------------------------------------ |
4792-
| [`OnPostTransferAsync`](#onposttransferasync) |
4793-
4794-
<div class="multi-panel-end"></div>
47954780

47964781
<div class="multi-panel-switching-end"></div>

‎info/api/WebTwain_IO.md‎

Lines changed: 52 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,58 @@ The properties and methods on this page live in the namespace {WebTwainObject}.
6868
| [`OnGetFilePath`](#ongetfilepath) | [`OnPostLoad`](#onpostload) | [`OnInternetTransferPercentage`](#oninternettransferpercentage) |
6969

7070

71+
<div class="multi-panel-end">
72+
73+
</div><div class="multi-panel-start"></div>
74+
75+
>The Android Service Edition only supports a subset of the APIs available in the Desktop Service Edition. For the APIs that are compatible with both editions, the usage remains the same. To learn how to use the APIs, please refer to the documentation for the Desktop Service Edition.
76+
77+
**Methods**
78+
79+
**Input Methods**
80+
81+
| |
82+
| :------------------------------------------------ | :------------------------------------------------------ | ----------------------------------------------------------- | ----------------------------------------------- |
83+
| [`LoadImageEx()`](#loadimageex) | [`LoadImageFromBase64Binary()`](#loadimagefrombase64binary) | [`LoadImageFromBinary()`](#loadimagefrombinary) |[`LoadDibFromClipboard()`](#loaddibfromclipboard) |
84+
| [`HTTPDownload()`](#httpdownload) |[`HTTPDownloadEx()`](#httpdownloadex) | [`HTTPDownloadThroughPost()`](#httpdownloadthroughpost) |
85+
86+
**Output Methods**
87+
88+
| |
89+
| :----------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
90+
| [`ConvertToBase64()`](#converttobase64) | [`ConvertToBlob()`](#converttoblob) | [`HTTPUpload()`](#httpupload) |
91+
| [`HTTPUploadThroughPutEx()`](#httpuploadthroughputex) | [`HTTPUploadThroughPost()`](#httpuploadthroughpost) | [`HTTPUploadThroughPostEx()`](#httpuploadthroughpostex) |
92+
| [`HTTPUploadAllThroughPostAsMultiPageTIFF()`](#httpuploadallthroughpostasmultipagetiff) | [`HTTPUploadAllThroughPostAsPDF()`](#httpuploadallthroughpostaspdf) | [`HTTPUploadThroughPostAsMultiPagePDF()`](#httpuploadthroughpostasmultipagepdf) |
93+
|[`HTTPUploadThroughPostAsMultiPageTIFF()`](#httpuploadthroughpostasmultipagetiff) | [`SaveAsBMP()`](#saveasbmp) | [`SaveAsJPEG()`](#saveasjpeg) |
94+
|[`SaveAsPDF()`](#saveaspdf) | [`SaveAsPNG()`](#saveaspng) |
95+
[`SaveAsTIFF()`](#saveastiff) |
96+
|[`SaveSelectedImagesAsMultiPagePDF()`](#saveselectedimagesasmultipagepdf) | [`SaveSelectedImagesAsMultiPageTIFF()`](#saveselectedimagesasmultipagetiff)
97+
| [`SaveAllAsMultiPageTIFF()`](#saveallasmultipagetiff) |
98+
|[`SaveAllAsPDF()`](#saveallaspdf) |[`ShareImages()`](#shareimages) |
99+
100+
**Other Methods**
101+
102+
| |
103+
| :-------------------------------------------- | :---------------------------------------- | --------------------------------------------------- | ----------------------------------------- |
104+
| [`ClearTiffCustomTag()`](#cleartiffcustomtag) | [`SetTiffCustomTag()`](#settiffcustomtag) | [`ClearAllHTTPFormField()`](#clearallhttpformfield) | [`SetHTTPFormField()`](#sethttpformfield) |
105+
| [`SetHTTPHeader()`](#sethttpheader) | [`SetUploadSegment()`](#setuploadsegment) | [`Print()`](#print) |[`PrintEx()`](#printex) |
106+
107+
**Properties**
108+
109+
| |
110+
| :-------------------------------------------------------------- | :---------------------------------------------------------------------------- | ------------------------------------------- | --------------------------------------------------- |
111+
| [`HttpFieldNameOfUploadedImage`](#httpfieldnameofuploadedimage) | [`HTTPPort`](#httpport) | [`IfSSL`](#ifssl) | [`HTTPPostResponseString`](#httppostresponsestring) |
112+
|[`IfShowCancelDialogWhenImageTransfer`](#ifshowcanceldialogwhenimagetransfer) | [`IfShowProgressBar`](#ifshowprogressbar) | [`JPEGQuality`](#jpegquality) | [`IfTiffMultiPage`](#iftiffmultipage) |
113+
| [`TIFFCompressionType`](#tiffcompressiontype) | [`MaxUploadImageSize`](#maxuploadimagesize) |
114+
115+
**Events**
116+
117+
| |
118+
| :-------------------------------- | :-------------------------- | --------------------------------------------------------------- |
119+
| [`OnPostLoad`](#onpostload) | [`OnInternetTransferPercentage`](#oninternettransferpercentage) |
120+
121+
<div class="multi-panel-end"></div>
122+
71123
---
72124

73125
## LoadImage
@@ -3907,56 +3959,6 @@ TIFF_RLE (2), TIFF_T4 (3), TIFF_FAX3 (3) and TIFF_PACKBITS (32773) only support
39073959
When TIFF_JPEG (7) is used, you can use JPEGQuality to further reduce the size of the TIFF file.
39083960

39093961

3910-
<div class="multi-panel-end">
3911-
3912-
</div><div class="multi-panel-start"></div>
3913-
3914-
>The Android Service Edition only supports a subset of the APIs available in the Desktop Service Edition. For the APIs that are compatible with both editions, the usage remains the same. To learn how to use the APIs, please refer to the documentation for the Desktop Service Edition.
3915-
3916-
**Methods**
3917-
3918-
**Input Methods**
3919-
3920-
| |
3921-
| :------------------------------------------------ | :------------------------------------------------------ | ----------------------------------------------------------- | ----------------------------------------------- |
3922-
| [`LoadImageEx()`](#loadimageex) | [`LoadImageFromBase64Binary()`](#loadimagefrombase64binary) | [`LoadImageFromBinary()`](#loadimagefrombinary) |[`LoadDibFromClipboard()`](#loaddibfromclipboard) |
3923-
| [`HTTPDownload()`](#httpdownload) |[`HTTPDownloadEx()`](#httpdownloadex) | [`HTTPDownloadThroughPost()`](#httpdownloadthroughpost) |
3924-
3925-
**Output Methods**
39263962

3927-
| |
3928-
| :----------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
3929-
| [`ConvertToBase64()`](#converttobase64) | [`ConvertToBlob()`](#converttoblob) | [`HTTPUpload()`](#httpupload) |
3930-
| [`HTTPUploadThroughPutEx()`](#httpuploadthroughputex) | [`HTTPUploadThroughPost()`](#httpuploadthroughpost) | [`HTTPUploadThroughPostEx()`](#httpuploadthroughpostex) |
3931-
| [`HTTPUploadAllThroughPostAsMultiPageTIFF()`](#httpuploadallthroughpostasmultipagetiff) | [`HTTPUploadAllThroughPostAsPDF()`](#httpuploadallthroughpostaspdf) | [`HTTPUploadThroughPostAsMultiPagePDF()`](#httpuploadthroughpostasmultipagepdf) |
3932-
|[`HTTPUploadThroughPostAsMultiPageTIFF()`](#httpuploadthroughpostasmultipagetiff) | [`SaveAsBMP()`](#saveasbmp) | [`SaveAsJPEG()`](#saveasjpeg) |
3933-
|[`SaveAsPDF()`](#saveaspdf) | [`SaveAsPNG()`](#saveaspng) |
3934-
[`SaveAsTIFF()`](#saveastiff) |
3935-
|[`SaveSelectedImagesAsMultiPagePDF()`](#saveselectedimagesasmultipagepdf) | [`SaveSelectedImagesAsMultiPageTIFF()`](#saveselectedimagesasmultipagetiff)
3936-
| [`SaveAllAsMultiPageTIFF()`](#saveallasmultipagetiff) |
3937-
|[`SaveAllAsPDF()`](#saveallaspdf) |[`ShareImages()`](#shareimages) |
3938-
3939-
**Other Methods**
3940-
3941-
| |
3942-
| :-------------------------------------------- | :---------------------------------------- | --------------------------------------------------- | ----------------------------------------- |
3943-
| [`ClearTiffCustomTag()`](#cleartiffcustomtag) | [`SetTiffCustomTag()`](#settiffcustomtag) | [`ClearAllHTTPFormField()`](#clearallhttpformfield) | [`SetHTTPFormField()`](#sethttpformfield) |
3944-
| [`SetHTTPHeader()`](#sethttpheader) | [`SetUploadSegment()`](#setuploadsegment) | [`Print()`](#print) |[`PrintEx()`](#printex) |
3945-
3946-
**Properties**
3947-
3948-
| |
3949-
| :-------------------------------------------------------------- | :---------------------------------------------------------------------------- | ------------------------------------------- | --------------------------------------------------- |
3950-
| [`HttpFieldNameOfUploadedImage`](#httpfieldnameofuploadedimage) | [`HTTPPort`](#httpport) | [`IfSSL`](#ifssl) | [`HTTPPostResponseString`](#httppostresponsestring) |
3951-
|[`IfShowCancelDialogWhenImageTransfer`](#ifshowcanceldialogwhenimagetransfer) | [`IfShowProgressBar`](#ifshowprogressbar) | [`JPEGQuality`](#jpegquality) | [`IfTiffMultiPage`](#iftiffmultipage) |
3952-
| [`TIFFCompressionType`](#tiffcompressiontype) | [`MaxUploadImageSize`](#maxuploadimagesize) |
3953-
3954-
**Events**
3955-
3956-
| |
3957-
| :-------------------------------- | :-------------------------- | --------------------------------------------------------------- |
3958-
| [`OnPostLoad`](#onpostload) | [`OnInternetTransferPercentage`](#oninternettransferpercentage) |
3959-
3960-
<div class="multi-panel-end"></div>
39613963

39623964
<div class="multi-panel-switching-end"></div>

‎info/schedule/Stable.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ permalink: /info/schedule/Stable.html
2121

2222

2323
#### Optimized Android Service for document scanning from Android devices
24-
- The <a href="https://demo.dynamsoft.com/DWT/Resources/dist/DynamsoftServiceSetup.apk" target="_blank">Android service</a> is available now. <!--Google Play Store.-->
25-
- Expanded the capabilities of the Android platform. <!--See the APIs supported on Android service. -->
24+
- The Android service is available on <a href="https://play.google.com/store/apps/details?id=com.dynamsoft.mobilescan" target="_blank">Google Play Store</a>.
25+
- Expanded the capabilities of the Android platform. See <a href="https://www.dynamsoft.com/web-twain/docs/info/api/#android" target="_blank">the APIs supported on Android service</a>.
2626

2727
#### Remote Scan
2828
- The remote scan solution powered by Dynamic Web TWAIN is now officially available. With it, you can turn any of your tranditional document scanners into a network-able scanner and allow your end users to use it without installing anything on the client device. Read <a href="https://www.dynamsoft.com/remote-scan/docs/introduction/" target="_blank">this documentation</a> to learn how the Remote Scan solution works.

0 commit comments

Comments
 (0)