Skip to content

Commit b1e22b5

Browse files
rebeccakakrebeccakak
authored
Merge pull request #645 from dynamsoft-docs/preview
Preview
2 parents 25aedb7 + cbf9c99 commit b1e22b5

File tree

9 files changed

+630
-50
lines changed

9 files changed

+630
-50
lines changed

‎info/api/WebTwain_Acquire.md‎

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,18 @@ description: Dynamic Web TWAIN SDK Documentation API Reference Acquire APIs Page
88
permalink: /info/api/WebTwain_Acquire.html
99
---
1010

11+
1112
# {WebTwainObject} Scan
1213

1314
> The properties and methods on this page live in the namespace {WebTwainObject}. {WebTwainObject} denotes the `WebTwain` instance. Learn about [how to create a web twain object]({{site.indepth}}features/initialize.html#creating-the-webtwain-instance).
1415
16+
<div class="multi-panel-switching-prefix"></div>
17+
18+
- [Desktop Service](#desktop)
19+
- [Android Service](#android)
20+
21+
<div class="multi-panel-start"></div>
22+
1523
**1. The following APIs are compatible with TWAIN, ICA, SANE (Windows, macOS and Linux)**
1624

1725
**Methods**
@@ -78,6 +86,28 @@ permalink: /info/api/WebTwain_Acquire.html
7886
| :------------------------------------ |
7987
| [`OnSourceUIClose`](#onsourceuiclose) |
8088

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) |
107+
108+
<div class="multi-panel-end"></div>
109+
110+
81111
---
82112

83113
## AcquireImage
@@ -92,26 +122,11 @@ AcquireImage(
92122
successCallBack?: () => void,
93123
failureCallBack?: (deviceConfiguration?: DeviceConfiguration, errorCode: number, errorString: string) => void
94124
): void;
95-
96-
interface DeviceConfiguration {
97-
IfShowUI?: boolean; //Whether to show the built-in User Interface from the device vendor
98-
PixelType?: Dynamsoft.DWT.EnumDWT_PixelType | number | string; //Whether to scan in color, grey or black & white
99-
Resolution?: number; //Measured by dots per pixel (DPI)
100-
IfFeederEnabled?: boolean; //Whether to use the document feeder or the flatbed of the device
101-
IfDuplexEnabled?: boolean; //Whether to scan one side or both sides
102-
IfDisableSourceAfterAcquire?: boolean; //Whether to close the built-in User Interface after aquisition. Only valid when {IfShowUI} is true.
103-
IfGetImageInfo?: boolean; //Whether to retrieve information about the image after it's transferred.
104-
IfGetExtImageInfo?: boolean; //Whether to retrieve extended information about the image after it's transferred.
105-
extendedImageInfoQueryLevel?: Dynamsoft.DWT.EnumDWT_ExtImageInfo | number; //How much extended information is retrieved. Only valid when {IfGetExtImageInfo} is true.
106-
SelectSourceByIndex?: number; //Specify a source by its index.
107-
IfCloseSourceAfterAcquire?: boolean; //Whether to close the data source after aquisition. Default: false.
108-
PageSize?: Dynamsoft.DWT.EnumDWT_CapSupportedSizes | number; //Specify page size
109-
}
110125
```
111126

112127
**Parameters**
113128

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

116131
`successCallback`: A callback function that is executed if the request succeeds.
117132

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

46814696
**Parameters**
46824697

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

46854700
**Availability**
46864701

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

47234738
**Parameters**
47244739

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

47274742
**Availability**
47284743

@@ -4760,4 +4775,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
47604775
}).catch((e)=>{
47614776
console.error(e)
47624777
})
4763-
```
4778+
```
4779+
4780+
4781+
<div class="multi-panel-switching-end"></div>

‎info/api/WebTwain_Buffer.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ permalink: /info/api/WebTwain_Buffer.html
1212

1313
The properties and methods on this page live in the namespace {WebTwainObject}. {WebTwainObject} denotes the `WebTwain` instance. Learn about [how to create a web twain object]({{site.indepth}}features/initialize.html#creating-the-webtwain-instance).
1414

15+
> All APIs on this page support Android Service from version 18.2.
16+
1517
**Methods**
1618

1719
| |

‎info/api/WebTwain_Edit.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ permalink: /info/api/WebTwain_Edit.html
1212

1313
The properties and methods on this page live in the namespace {WebTwainObject}. {WebTwainObject} denotes the `WebTwain` instance. Learn about [how to create a web twain object]({{site.indepth}}features/initialize.html#creating-the-webtwain-instance).
1414

15+
> All APIs on this page support Android Service from version 18.2.
16+
1517
**Methods**
1618

1719
| |

‎info/api/WebTwain_IO.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ permalink: /info/api/WebTwain_IO.html
1313

1414
The properties and methods on this page live in the namespace {WebTwainObject}. {WebTwainObject} denotes the `WebTwain` instance. Learn about [how to create a web twain object]({{site.indepth}}features/initialize.html#creating-the-webtwain-instance).
1515

16+
<div class="multi-panel-switching-prefix"></div>
17+
18+
- [Desktop Service](#desktop)
19+
- [Android Service](#android)
20+
21+
<div class="multi-panel-start"></div>
22+
1623
**Methods**
1724

1825
**Input Methods**
@@ -60,6 +67,59 @@ The properties and methods on this page live in the namespace {WebTwainObject}.
6067
| :-------------------------------- | :-------------------------- | --------------------------------------------------------------- |
6168
| [`OnGetFilePath`](#ongetfilepath) | [`OnPostLoad`](#onpostload) | [`OnInternetTransferPercentage`](#oninternettransferpercentage) |
6269

70+
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+
63123
---
64124

65125
## LoadImage
@@ -3897,3 +3957,8 @@ TIFF_T4 (3) and TIFF_FAX3 (3) are two names for the same compression type. So ar
38973957
TIFF_RLE (2), TIFF_T4 (3), TIFF_FAX3 (3) and TIFF_PACKBITS (32773) only support compression of 1-bit images. TIFF_JPEG (7) supports compression of 8-bit above color images and 8-bit grey images.
38983958

38993959
When TIFF_JPEG (7) is used, you can use JPEGQuality to further reduce the size of the TIFF file.
3960+
3961+
3962+
3963+
3964+
<div class="multi-panel-switching-end"></div>

‎info/api/WebTwain_Util.md‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ permalink: /info/api/WebTwain_Util.html
1212

1313
The properties and methods on this page live in the namespace {WebTwainObject}. {WebTwainObject} denotes the `WebTwain` instance. Learn about [how to create a web twain object]({{site.indepth}}features/initialize.html#creating-the-webtwain-instance).
1414

15+
<div class="multi-panel-switching-prefix"></div>
16+
17+
- [Desktop Service](#desktop)
18+
- [Android Service](#android)
19+
20+
<div class="multi-panel-start"></div>
21+
1522
**Methods**
1623

1724
| |
@@ -26,6 +33,27 @@ The properties and methods on this page live in the namespace {WebTwainObject}.
2633
| [`ErrorCode`](#errorcode) | [`ErrorString`](#errorstring) | [`LogLevel`](#loglevel) | [`Manufacturer`](#manufacturer) |
2734
| [`ProductFamily`](#productfamily) | [`ProductName`](#productname) | [`VersionInfo`](#versioninfo) |
2835

36+
<div class="multi-panel-end">
37+
38+
</div><div class="multi-panel-start"></div>
39+
40+
>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.
41+
42+
**Methods**
43+
44+
| |
45+
| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
46+
| [`RegisterEvent()`]({{site.info}}api/WebTwain_Util.html#registerevent) | [`UnregisterEvent()`]({{site.info}}api/WebTwain_Util.html#unregisterevent) | [`GenerateURLForUploadData()`]({{site.info}}api/WebTwain_Util.html#generateurlforuploaddata) |
47+
48+
**Properties**
49+
50+
| |
51+
| :------------------------------------ | :---------------------------- | ----------------------------- | ------------------------------- |
52+
| [`ErrorCode`](#errorcode) | [`ErrorString`](#errorstring) | [`LogLevel`](#loglevel) | [`Manufacturer`](#manufacturer) |
53+
| [`ProductFamily`](#productfamily) | [`ProductName`](#productname) | [`VersionInfo`](#versioninfo) |
54+
55+
<div class="multi-panel-end"></div>
56+
2957
---
3058

3159
## isUsingActiveX
@@ -547,4 +575,8 @@ readonly VersionInfo: string;
547575

548576
**Usage notes**
549577

550-
`Manufacturer` , `ProductFamily` , `ProductName` and `VersionInfo` together form the identity string of the Dynamic Web TWAIN library.
578+
`Manufacturer` , `ProductFamily` , `ProductName` and `VersionInfo` together form the identity string of the Dynamic Web TWAIN library.
579+
580+
581+
582+
<div class="multi-panel-switching-end"></div>

‎info/api/WebTwain_Viewer.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ permalink: /info/api/WebTwain_Viewer.html
1212

1313
> {WebTwainObject} denotes the `WebTwain` instance.
1414
15+
> All APIs on this page support Android Service from version 18.2.
16+
1517
**Methods**
1618

1719
| |

0 commit comments

Comments
 (0)