Merge pull request #627 from dynamsoft-docs/preview

v18.2

Author: rebeccakak

_data/full_tree.yml

@@ -60,8 +60,8 @@ tree_list:
         path: /info/api/Dynamsoft_Enum.html
       - name: Interfaces
         path: /info/api/Interfaces.html
-      - name: Device
-        path: /info/api/Device.html
+      #- name: Device
+      #  path: /info/api/Device.html
       - name: WebTwain_Scanner
         path: /info/api/WebTwain_Acquire.html
       - name: WebTwain_Buffer

_includes/version-list.html

@@ -1,6 +1,7 @@
 <span class="fullVersionHistory">
   <ul class="fullVersionInfo">
-    <li onclick="changeVersion(this)">Latest Version (18.1)</li>
+    <li onclick="changeVersion(this)">Latest Version (18.2)</li>
+    <li onclick="changeVersion(this)">Version 18.1</li>
     <li onclick="changeVersion(this)">Version 18.0</li>
     <li onclick="changeVersion(this)">Version 17.3</li>
     <li onclick="changeVersion(this)">Version 17.2.1</li>

faq/general-troubleshooting-steps.md

@@ -25,8 +25,8 @@ permalink: /faq/general-troubleshooting-steps.html
   - Linux, `/opt/dynamsoft/DynamsoftService/log`
 
 2. Set the log level
-  - For only one client machine, go to the application with Dynamic Web TWAIN integrated, press F12 to open the development tools, switch to "console" tab and enter the command "DWObject.LogLevel = 1" to enable the debugger mode.
-  - For all client machines, set [ `LogLevel` ]({{site.info}}api/WebTwain_Util.html#loglevel) to 1 in your code. This property should be set as soon as the `WebTwain` instance is created. For example, in the event `Dynamsoft_OnReady`
+  Option A - Single client machine troubleshooting - go to the application with Dynamic Web TWAIN integrated, press F12 to open the development tools, switch to "console" tab and enter the command "DWObject.LogLevel = 1" to enable the debugger mode.
+  Option B - For all client machines (application wide) - set [ `LogLevel` ]({{site.info}}api/WebTwain_Util.html#loglevel) to 1 in your code. This property should be set as soon as the `WebTwain` instance is created. For example, in the event `Dynamsoft_OnReady`
     ```javascript
     function Dynamsoft_OnReady() {
       DWObject = Dynamsoft.DWT.GetWebTwain("dwtcontrolContainer");
@@ -41,4 +41,4 @@ permalink: /faq/general-troubleshooting-steps.html
   - On macOS, the log files are in `Go > Applications > Dynamsoft > DynamsoftServicex64_17 > {installed version No.} > log`
   - On Linux, the log files are in `/opt/dynamsoft/DynamsoftServicex64_17/log`
 
-5. Set log level back to the default value (0) to disable the debugger mode, otherwise the operation speed will be affected.
+5. Set log level back to the default value (0) to disable the debugger mode, otherwise the operation speed will be affected.

info/api/Dynamsoft_Enum.md

@@ -876,17 +876,26 @@ Note: IT_MULTIPAGE_PDF & IT_MULTIPAGE_TIF are only applicable to the ImageType o
 | Label | Value|
 |:-|:-|
 | TWAINSCANNER | 0x10 |
-| WIATWAINSCANNER | 0x20 |
+| WIASCANNER | 0x20 |
 | TWAINX64SCANNER | 0x40 |
 | ICASCANNER | 0x80 |
 | SANESCANNER | 0x100 |
 | ESCLSCANNER | 0x200 |
 | WIFIDIRECTSCANNER | 0x400 |
+| WIATWAINSCANNER | 0x800 |
+
 
 ## `Dynamsoft.DWT.EnumDWT_ExtImageInfo`
 
-| Label | Value|
+| Label | Value |
 |:-|:-|
 | default | 0 |
 | standard | 1 |
-| supported | 2 |
+| supported | 2 |
+
+## `Dynamsoft.DWT.EnumDWT_WorkMode`
+
+| Label | Value | Description |
+|:-|:-|:-|
+| Normal | 0 | Original mode, the image data is processed in the buffer |
+| Balance | 1 | The image data is processed in the browser canvas |

info/api/Dynamsoft_WebTwainEnv.md

@@ -61,12 +61,8 @@ interface Dynamsoft.DWT {
     GetWebTwainEx(WebTwainId: string): WebTwain;
     Load(): void;
     Unload(): void;
-    RemoveAllAuthorizations: function () {};    
-    OnWebTwainNotFound: function () {};
     OnWebTwainPostExecute: function () {};
     OnWebTwainPreExecute: function () {};
-    OnWebTwainReady: function () {};
-    OnWebTwainWillInit: function () {};
 }
 
 /**
@@ -226,20 +222,16 @@ interface DWTInitialConfig {
   Initiates the library. If there are predefined `Containers` , one `WebTwain` instance will be created for each `Container` .
 
 ### `RegisterEvent()`
-
+  [We removed OnWebTWainReady...]: # 
   Registers an environmental event. Typically the event is `OnWebTwainReady` which is triggered when the initialization completes.
 
 ### `Unload()`
 
   Destroys all `WebTwain` instances and cuts off the connection to the Dynamsoft Service.
 
-### `RemoveAllAuthorizations()`
-
-Removes the specific authorizations made by end users on a client machine. Only effective when the security feature is enabled for local files, scanners or cameras.
-
 ### `UseDefaultViewer`
 
-Whether to use the built-in viewer. If it is set to `false` , the file `dynamsoft.viewer.js` is not loaded at all and there is no way to add it back later. Therefore, only set it to `false` when you absolutely won't need the viewer or will be building your own viewer.
+Whether to use the built-in viewer. If it is set to `false` , the file `dynamsoft.webtwain.viewer.js` is not loaded at all and there is no way to add it back later. Therefore, only set it to `false` when you absolutely won't need the viewer or will be building your own viewer.
 
 ### `CustomizableDisplayInfo`
 
@@ -272,3 +264,31 @@ Specify the source of the loader bar image. Check out more on [HTMLImageElement.
 #### `loaderBarClassName`
 
 Specify the class name of the DIV element that contains the loader bar. With this class, you can customize the loader bar even further with CSS.
+
+#### `OnWebTwainReady`
+
+A built-in callback triggered when the Web TWAIN resources have completed loading
+
+**Example**
+```javascript
+Dynamsoft.DWT.RegisterEvent('OnWebTwainReady', 
+  Dynamsoft_OnReady //The typical function for initalizing the environment once the resources have loaded
+); 
+```
+
+#### `OnWebTwainError`
+
+A built-in callback triggered when an error is detected when laoding the Web TWAIN environment
+
+**Example**
+```javascript
+Dynamsoft.DWT.RegisterEvent('OnWebTwainError', 
+  Dynamsoft_OnError 
+); 
+
+ 
+function Dynamsoft_OnError(error){
+  // error handling
+  console.error(error.message);
+} 
+```

info/api/WebTwain_Acquire.md

@@ -377,6 +377,7 @@ CloseSourceAsync(): Promise<boolean>;
 <td align="center">H5(macOS/TWAIN)</td>
 <td align="center">H5(macOS/ICA)</td>
 <td align="center">H5(Linux)</td>
+<td align="center">Android Service</td>
 </tr>
 
 <tr>
@@ -385,6 +386,7 @@ CloseSourceAsync(): Promise<boolean>;
 <td align="center">v16.1+</td>
 <td align="center">v16.1+</td>
 <td align="center">v16.1+</td>
+<td align="center">v18.2+</td>
 </tr>
 
 </table>
@@ -831,6 +833,7 @@ SelectSourceAsync(deviceType?: Dynamsoft.DWT.EnumDWT_DeviceType | number): Promi
 <td align="center">H5(macOS/TWAIN)</td>
 <td align="center">H5(macOS/ICA)</td>
 <td align="center">H5(Linux)</td>
+<td align="center">Android Service</td>
 </tr>
 
 <tr>
@@ -839,6 +842,7 @@ SelectSourceAsync(deviceType?: Dynamsoft.DWT.EnumDWT_DeviceType | number): Promi
 <td align="center">v16.1+</td>
 <td align="center">v16.1+</td>
 <td align="center">v16.1+</td>
+<td align="center">v18.2+</td>
 </tr>
 
 </table>
@@ -4159,6 +4163,7 @@ RegisterEvent("OnPostTransferAsync", function (outputInfo: OutputInfo) {});
 <td align="center">H5(macOS/TWAIN)</td>
 <td align="center">H5(macOS/ICA)</td>
 <td align="center">H5(Linux)</td>
+<td align="center">Android Service</td>
 </tr>
 
 <tr>
@@ -4167,6 +4172,7 @@ RegisterEvent("OnPostTransferAsync", function (outputInfo: OutputInfo) {});
 <td align="center">v15.1+</td>
 <td align="center">v15.1+</td>
 <td align="center">v15.1+</td>
+<td align="center">v18.2+</td>
 </tr>
 
 </table>
@@ -4427,6 +4433,7 @@ interface ValueAndLabel {
 <td align="center">H5(macOS/TWAIN)</td>
 <td align="center">H5(macOS/ICA)</td>
 <td align="center">H5(Linux)</td>
+<td align="center">Android Service</td>
 </tr>
 
 <tr>
@@ -4435,6 +4442,7 @@ interface ValueAndLabel {
 <td align="center">v16.0+</td>
 <td align="center">v16.0+</td>
 <td align="center">v16.0+</td>
+<td align="center">v18.2+</td>
 </tr>
 
 </table>
@@ -4494,7 +4502,7 @@ interface CapabilitySetup {
 
 **Parameters**
 
-`capabilities`: A object that describes how to set capabilities.
+`capabilities`: An object that describes how to set capabilities.
 
 `successCallback`: A callback function that is executed if the request succeeds.
 
@@ -4512,6 +4520,7 @@ interface CapabilitySetup {
 <td align="center">H5(macOS/TWAIN)</td>
 <td align="center">H5(macOS/ICA)</td>
 <td align="center">H5(Linux)</td>
+<td align="center">Android Service</td>
 </tr>
 
 <tr>
@@ -4520,6 +4529,7 @@ interface CapabilitySetup {
 <td align="center">v16.0+</td>
 <td align="center">v16.0+</td>
 <td align="center">v16.0+</td>
+<td align="center">v18.2+</td>
 </tr>
 
 </table>
@@ -4616,6 +4626,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
 <td align="center">H5(macOS/TWAIN)</td>
 <td align="center">H5(macOS/ICA)</td>
 <td align="center">H5(Linux)</td>
+<td align="center">Android Service</td>
 </tr>
 
 <tr>
@@ -4624,14 +4635,15 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
 <td align="center">v18.0+</td>
 <td align="center">v18.0+</td>
 <td align="center">v18.0+</td>
+<td align="center">v18.2+</td>
 </tr>
 
 </table>
 </div>
 
 **Remark**
 
-[Device APIs]({{site.info}}api/Device.html)
+Interface [Device]({{site.info}}api/Interfaces.html#device)
 
 ---
 
@@ -4672,6 +4684,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
 <td align="center">H5(macOS/TWAIN)</td>
 <td align="center">H5(macOS/ICA)</td>
 <td align="center">H5(Linux)</td>
+<td align="center">Android Service</td>
 </tr>
 
 <tr>
@@ -4680,6 +4693,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{
 <td align="center">v18.0+</td>
 <td align="center">v18.0+</td>
 <td align="center">v18.0+</td>
+<td align="center">v18.2+</td>
 </tr>
 
 </table>
@@ -4712,6 +4726,7 @@ AcquireImageAsync(deviceConfiguration?: DeviceConfiguration): Promise< boolean>;
 <td align="center">H5(macOS/TWAIN)</td>
 <td align="center">H5(macOS/ICA)</td>
 <td align="center">H5(Linux)</td>
+<td align="center">Android Service</td>
 </tr>
 
 <tr>
@@ -4720,6 +4735,7 @@ AcquireImageAsync(deviceConfiguration?: DeviceConfiguration): Promise< boolean>;
 <td align="center">v18.0+</td>
 <td align="center">v18.0+</td>
 <td align="center">v18.0+</td>
+<td align="center">v18.2+</td>
 </tr>
 
 </table>