Skip to content

filter apis #644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lunaaaw merged 3 commits into from
May 11, 2023
Merged

filter apis #644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8544f1d
filter apis
lunaaaw May 11, 2023
430a8a0
Update interfaces.md
lunaaaw May 11, 2023
dade862
Merge branch 'preview' into luna-18.2
lunaaaw May 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions info/api/WebTwain_Acquire.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ AcquireImage(

**Parameters**

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

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

Expand Down Expand Up @@ -4695,7 +4695,7 @@ DWObject.GetDevicesAsync().then((deviceList)=>{

**Parameters**

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

**Availability**

Expand Down Expand Up @@ -4737,7 +4737,7 @@ AcquireImageAsync(deviceConfiguration?: DeviceConfiguration): Promise< boolean>;

**Parameters**

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

**Availability**

Expand Down
38 changes: 19 additions & 19 deletions info/api/WebTwain_Util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,26 @@ The properties and methods on this page live in the namespace {WebTwainObject}.
| [`ErrorCode`](#errorcode) | [`ErrorString`](#errorstring) | [`LogLevel`](#loglevel) | [`Manufacturer`](#manufacturer) |
| [`ProductFamily`](#productfamily) | [`ProductName`](#productname) | [`VersionInfo`](#versioninfo) |

<div class="multi-panel-end">

</div><div class="multi-panel-start"></div>

>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.

**Methods**

| |
| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [`RegisterEvent()`]({{site.info}}api/WebTwain_Util.html#registerevent) | [`UnregisterEvent()`]({{site.info}}api/WebTwain_Util.html#unregisterevent) | [`GenerateURLForUploadData()`]({{site.info}}api/WebTwain_Util.html#generateurlforuploaddata) |

**Properties**

| |
| :------------------------------------ | :---------------------------- | ----------------------------- | ------------------------------- |
| [`ErrorCode`](#errorcode) | [`ErrorString`](#errorstring) | [`LogLevel`](#loglevel) | [`Manufacturer`](#manufacturer) |
| [`ProductFamily`](#productfamily) | [`ProductName`](#productname) | [`VersionInfo`](#versioninfo) |

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

---

Expand Down Expand Up @@ -558,25 +577,6 @@ readonly VersionInfo: string;

`Manufacturer` , `ProductFamily` , `ProductName` and `VersionInfo` together form the identity string of the Dynamic Web TWAIN library.

<div class="multi-panel-end">

</div><div class="multi-panel-start"></div>

>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.

**Methods**

| |
| :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [`RegisterEvent()`]({{site.info}}api/WebTwain_Util.html#registerevent) | [`UnregisterEvent()`]({{site.info}}api/WebTwain_Util.html#unregisterevent) | [`GenerateURLForUploadData()`]({{site.info}}api/WebTwain_Util.html#generateurlforuploaddata) |

**Properties**

| |
| :------------------------------------ | :---------------------------- | ----------------------------- | ------------------------------- |
| [`ErrorCode`](#errorcode) | [`ErrorString`](#errorstring) | [`LogLevel`](#loglevel) | [`Manufacturer`](#manufacturer) |
| [`ProductFamily`](#productfamily) | [`ProductName`](#productname) | [`VersionInfo`](#versioninfo) |

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

<div class="multi-panel-switching-end"></div>
6 changes: 3 additions & 3 deletions info/api/interfaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ permalink: /info/api/interfaces.html
# Interfaces

| |
| :----- |
| [`Device`](#device) |
| [`DeviceConfiguration`](#DeviceConfiguration) |
|:-|:-|
| [`Device`](#device) | [`DeviceConfiguration`](#DeviceConfiguration) |


---

Expand Down
8 changes: 4 additions & 4 deletions info/schedule/Stable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,18 @@ permalink: /info/schedule/Stable.html
- 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>.

#### Remote Scan
- 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.
- The Remote Scan solution powered by Dynamic Web TWAIN is now officially available. Using Remote Scan, you can turn any of your traditional document scanners into a network accessible scanner and allow your end users to use it without any client side installs. Read <a href="https://www.dynamsoft.com/remote-scan/docs/introduction/" target="_blank">this documentation</a> to learn how the Remote Scan solution works.


### Improvements

#### Image Viewer
- The Viewer component has been migrated to a dedicated resource file. This will allow for viewerless implementations of Dynamic Web TWAIN to reduce the load by removing the necessity of loading the Viewer resources into memory even when the Viewer is not being used. See the property [Dynamsoft.DWT.UseDefaultViewer]({{site.info}}api/Dynamsoft_WebTwainEnv.html#usedefaultviewer).
- Added the enum [EnumDWT_WorkMode]({{site.info}}api/Dynamsoft_Enum.html#dynamsoftdwtenumdwt_workmode) with a new option for image editor setting, please refer to [createImageEditor]({{site.info}}api/WebTwain_Viewer.html#createimageeditor).
- The Viewer component has been migrated to a dedicated resource file. This will allow for viewerless implementations of Dynamic Web TWAIN, as well as reducing the load on the browser by removing the necessity of loading the Viewer resources into memory when the Viewer is not being used. See the property [Dynamsoft.DWT.UseDefaultViewer]({{site.info}}api/Dynamsoft_WebTwainEnv.html#usedefaultviewer).
- Added the enum [EnumDWT_WorkMode]({{site.info}}api/Dynamsoft_Enum.html#dynamsoftdwtenumdwt_workmode) with a new option for image editor setting. Please refer to [createImageEditor]({{site.info}}api/WebTwain_Viewer.html#createimageeditor).
- Added new method `save()` to the ImageEditor object, please refer to [createImageEditor]({{site.info}}api/WebTwain_Viewer.html#createimageeditor).

#### Optimized error handling during web twain initialization
- Added an [OnWebTwainError]({{site.info}}api/Dynamsoft_WebTwainEnv.html#onwebtwainerror) event for better capturing errors during the web twain object initialization.
- Added the [OnWebTwainError]({{site.info}}api/Dynamsoft_WebTwainEnv.html#onwebtwainerror) event for better capturing errors during the Web Twain object initialization.

#### General Improvements
- Updated the barcode reader library to v9.6.20
Expand Down