Merge pull request #318 from dynamsoft-docs/preview

update to internal commit 39cf79eb

Author: Dynamsoft-Jerson

programming/android/api-reference/barcode-scanner/barcode-scanner-config.md

@@ -30,7 +30,7 @@ final class BarcodeScannerConfig
 | [`setTemplateFilePath`](#settemplatefilepath) | Sets the parameters template for the Barcode Reader via a local JSON file path. |
 | [`setBarcodeFormats`](#setbarcodeformats) | Sets the barcode format(s) to read. |
 | [`setScanRegion`](#setscanregion) | Sets a scan region where only the barcodes located in the scan region can be decoded. |
-| [`setTorchButtonVisible`](#settorchbuttonvisible) | Sets whether to display the torch button when scanning or not. Uses can click the torch button to turn on/off the torch. |
+| [`setTorchButtonVisible`](#settorchbuttonvisible) | Sets whether to display the torch button when scanning or not. |
 | [`setBeepEnabled`](#setbeepenabled) | Sets whether to trigger a beep sound when a barcode is detected. |
 | [`setScanLaserVisible`](#setscanlaservisible) | Sets whether to display a scan laser when scanning. |
 | [`setAutoZoomEnabled`](#setautozoomenabled) | Sets whether to enable the auto-zoom feature when scanning. |
@@ -95,7 +95,7 @@ void setScanRegion(DSRect scanRegion);
 
 ### setTorchButtonVisible
 
-Sets whether to display the torch button when scanning. Uses can click the torch button to turn on/off the torch.
+Sets whether to display the torch button when scanning. User can click the torch button to turn on/off the torch.
 
 ```java
 void setTorchButtonVisible(boolean torchButtonVisible);
@@ -191,7 +191,7 @@ A combined value of [`EnumBarcodeFormat`]({{ site.dcvb_enumerations }}barcode-re
 
 ### getScanRegion
 
-Get the scan region.
+Returns the scan region.
 
 ```java
 DSRect getScanRegion();

programming/android/user-guide.md

@@ -108,7 +108,37 @@ The first thing that we are going to do is to create a fresh new project. Here a
 
 Add the SDK to your new project. Please read [Add the SDK](#add-the-sdk) section for more details.
 
-## Step 3: Initialize the License
+## Step 3: Get Prepare for the Layout File
+
+Open your **activity_main.xml** and replace it with the following code. In the layout file, we prepared 2 UI elements:
+
+- A "Start Scanning" button for opening the scanner view.
+- A `TextView` for displaying the barcode decoding result.
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
+   android:layout_width="match_parent"
+   android:layout_height="match_parent"
+   android:gravity="center"
+   android:orientation="vertical">
+
+   <Button
+      android:id="@+id/btn_navigate"
+      android:layout_width="wrap_content"
+      android:layout_height="wrap_content"
+      android:text="Start Scanning" />
+
+   <TextView
+      android:id="@+id/tv_result"
+      android:layout_width="wrap_content"
+      android:layout_height="wrap_content"
+      android:textSize="20sp"
+      android:text=""/>
+</LinearLayout>
+```
+
+## Step 4: Initialize the License
 
 The first step in code configuration is to include a valid license in the `BarcodeScannerConfig` object, which is used when launching the scanner.
 
@@ -173,7 +203,7 @@ class MainActivity : AppCompatActivity() {
 >- You can request a 30-day trial license via the [Request a Trial License](https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=guide&package=ios){:target="_blank"} link.
 >- If you download the <a href="https://www.dynamsoft.com/barcode-reader/downloads/?utm_source=docs#mobile" target="_blank">Installation Package</a>, it comes with a 30-day trial license by default.
 
-## Step 4: Implementing the Barcode Scanner
+## Step 5: Implementing the Barcode Scanner
 
 Now that the Barcode Scanner is configured and the license has been set, it is time to implement the actions (via the `launcher`) to take when a barcode is scanned. Once the launcher is called, the Barcode Scanner opens the camera and begins the decoding process.
 
@@ -234,33 +264,6 @@ class MainActivity : AppCompatActivity() {
 }
 ```
 
-## Step 5: Configure your layout file
-
-Open your **activity_main.xml** and replace it with the following code:
-
-```xml
-<?xml version="1.0" encoding="utf-8"?>
-<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
-   android:layout_width="match_parent"
-   android:layout_height="match_parent"
-   android:gravity="center"
-   android:orientation="vertical">
-
-   <Button
-      android:id="@+id/btn_navigate"
-      android:layout_width="wrap_content"
-      android:layout_height="wrap_content"
-      android:text="Start Scanning" />
-
-   <TextView
-      android:id="@+id/tv_result"
-      android:layout_width="wrap_content"
-      android:layout_height="wrap_content"
-      android:textSize="20sp"
-      android:text=""/>
-</LinearLayout>
-```
-
 ## Step 6: Configure the Barcode Scanner (optional)
 
 This next step, although optional, is highly recommended to help achieve a more smooth-looking and intuitive UI. In this setup we will configure the visibility of the torch button as well as the close button. In addition, a scan region will be defined that will limit the reading region of the Barcode Scanner to the specified dimensions. To do this, we are going back to the `BarcodeScannerConfig` object we used to define the license, and will make use of some of the other parameters available in the `BarcodeScannerConfig` class.
@@ -271,6 +274,7 @@ This next step, although optional, is highly recommended to help achieve a more
 >
 >1. 
 ```java
+import com.dynamsoft.dbr.EnumBarcodeFormat
 public class MainActivity extends AppCompatActivity {
    private ActivityResultLauncher<BarcodeScannerConfig> launcher;
    @Override
@@ -298,6 +302,7 @@ public class MainActivity extends AppCompatActivity {
 ```
 2. 
 ```kotlin
+import com.dynamsoft.dbr.EnumBarcodeFormat
 class MainActivity : AppCompatActivity() {
    private lateinit var launcher: ActivityResultLauncher<BarcodeScannerConfig>
    override fun onCreate(savedInstanceState: Bundle?) {

programming/objectivec-swift/api-reference/barcode-scanner/barcode-scanner-config.md

@@ -29,19 +29,19 @@ breadcrumbText: BarcodeScannerConfig
 class BarcodeScannerConfig : NSObject
 ```
 
-## Methods
-
-| Method | Description |
-| ------ | ----------- |
-| [`license`](#license) | Sets or returns the license key for the Barcode Reader. |
-| [`templateFilePath`](#templatefilepath) | Sets or returns the local JSON file path that will configure the parameters template for the Barcode Reader. |
-| [`barcodeFormats`](#barcodeformats) | Sets or returns the barcode format(s) to read. |
-| [`scanRegion`](#scanregion) | Sets or returns the scan region where only the barcodes located in the scan region can be decoded. |
-| [`isTorchButtonVisible`](#istorchbuttonvisible) | Sets or returns whether or not the torch button is visible. |
-| [`isBeepEnabled`](#isbeepenabled) | Sets or returns whether the beep sound is enabled when a barcode is found. |
-| [`isScanLaserVisible`](#isscanlaservisible) | Sets or returns whether or not the scan laser is visible. |
-| [`isAutoZoomEnabled`](#isautozoomenabled) | Sets or returns whether or not the auto-zoom feature of the Camera Enhancer is enabled. |
-| [`isCloseButtonVisible`](#isclosebuttonvisible) | Sets or returns whether or not the close button is visible. |
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`license`](#license) | *NSString \** | Sets or returns the license key for the Barcode Reader. |
+| [`templateFilePath`](#templatefilepath) | *NSString \** | Sets or returns the local JSON file path that will configure the parameters template for the Barcode Reader. |
+| [`barcodeFormats`](#barcodeformats) | *DSBarcodeFormat* | Sets or returns the barcode format(s) to read. |
+| [`scanRegion`](#scanregion) | *DSRect \** | Sets or returns the scan region where only the barcodes located in the scan region can be decoded. |
+| [`isTorchButtonVisible`](#istorchbuttonvisible) | *BOOL* | Sets or returns whether or not the torch button is visible. |
+| [`isBeepEnabled`](#isbeepenabled) | *BOOL* | Sets or returns whether the beep sound is enabled when a barcode is found. |
+| [`isScanLaserVisible`](#isscanlaservisible) | *BOOL* | Sets or returns whether or not the scan laser is visible. |
+| [`isAutoZoomEnabled`](#isautozoomenabled) | *BOOL* | Sets or returns whether or not the auto-zoom feature of the Camera Enhancer is enabled. |
+| [`isCloseButtonVisible`](#isclosebuttonvisible) | *BOOL* | Sets or returns whether or not the close button is visible. |
 
 ### license
 
@@ -121,7 +121,7 @@ var scanRegion: DSRect { get set }
 
 ### isTorchButtonVisible
 
-Sets or returns a boolean indicating whether or not the torch button is visible.
+Sets or returns a boolean indicating whether or not the torch button is visible. User can click the torch button to turn on/off the torch.
 
 <div class="sample-code-prefix"></div>
 >- Objective-C

programming/objectivec-swift/api-reference/barcode-scanner/barcode-scanner-view-controller.md

@@ -29,6 +29,47 @@ breadcrumbText: BarcodeScannerViewController
 class BarcodeScannerViewController: UIViewController
 ```
 
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`config`](#config) | *DSBarcodeScannerConfig \** | Sets or returns the barcode scanner configurations. |
+| [`onScannedResult`](#onscannedresult) | *void (^)(DSMRZScanResult *)* | A property that holds a Block. The block is a callback that takes a single parameter of type `DSMRZScanResult` and returns no value. |
+
+### config
+
+Sets or returns the barcode scanner configurations of type [`DSMRZScannerConfig`](barcode-scanner-config.md).
+
+<div class="sample-code-prefix"></div>
+>- Objective-C
+>- Swift
+>
+>1. 
+```objc
+@property (nonatomic, strong, readwrite) DSMRZScannerConfig * config
+```
+1. 
+```swift
+var config: BarcodeScannerConfig = .init()
+```
+
+### onScannedResult
+
+A property that holds a Block. The block is a callback that takes a single parameter of type [`DSMRZScanResult`](barcode-scan-result.md) and returns no value.
+
+<div class="sample-code-prefix"></div>
+>- Objective-C
+>- Swift
+>
+>1. 
+```objc
+@property (nonatomic, copy, readwrite) void (^)(DSMRZScanResult *) onScannedResult
+```
+1. 
+```swift
+var onScannedResult: ((BarcodeScanResult) -> Void)?
+```
+
 ## How to Use
 
 <div class="sample-code-prefix"></div>

programming/objectivec-swift/user-guide.md

@@ -172,10 +172,10 @@ The first major step in code configuration is to include a valid license in the
              setup()
       }
       @objc func buttonTapped() {
-              let vc = BarcodeScannerViewController()
-              let config = BarcodeScannerConfig()
-              config.license = "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9"
-              vc.config = config
+             let vc = BarcodeScannerViewController()
+             let config = BarcodeScannerConfig()
+             config.license = "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9"
+             vc.config = config
       }
       func setup() {
              button.backgroundColor = .black
@@ -240,27 +240,27 @@ Each result comes with a `DSResultStatus` that can be one of *finished*, *cancel
    vc.onScannedResult = ^(DSBarcodeScanResult *result) {
           switch (result.resultStatus) {
              case DSResultStatusFinished: {
-                    dispatch_async(dispatch_get_main_queue(), ^{
-                       NSString *format = result.barcodes.firstObject.formatString ?: @"";
-                       NSString *text = result.barcodes.firstObject.text ?: @"";
-                       weakSelf.label.text = [NSString stringWithFormat:@"Result:\nFormat: %@\nText: %@", format, text];
-                    });
-                    break;
+                dispatch_async(dispatch_get_main_queue(), ^{
+                   NSString *format = result.barcodes.firstObject.formatString ?: @"";
+                   NSString *text = result.barcodes.firstObject.text ?: @"";
+                   weakSelf.label.text = [NSString stringWithFormat:@"Result:\nFormat: %@\nText: %@", format, text];
+                });
+                break;
              }
              case DSResultStatusCanceled: {
-                    dispatch_async(dispatch_get_main_queue(), ^{
-                       weakSelf.label.text = @"Scan canceled";
-                    });
-                    break;
+                dispatch_async(dispatch_get_main_queue(), ^{
+                   weakSelf.label.text = @"Scan canceled";
+                });
+                break;
              }
              case DSResultStatusException: {
-                    dispatch_async(dispatch_get_main_queue(), ^{
-                        weakSelf.label.text = result.errorString;
-                    });
-                    break;
+                dispatch_async(dispatch_get_main_queue(), ^{
+                    weakSelf.label.text = result.errorString;
+                });
+                break;
              }
              default:
-                    break;
+                break;
           }
           dispatch_async(dispatch_get_main_queue(), ^{
              [weakSelf.navigationController popViewControllerAnimated:YES];
@@ -287,26 +287,26 @@ class ViewController: UIViewController {
              switch result.resultStatus {
              /* if the result is valid, display it in the label */
              case .finished:
-                    DispatchQueue.main.async {
-                       let format = result.barcodes?.first?.formatString ?? ""
-                       self.label.text = "Result:\nFormat: " + (format) + "\n" + "Text: " + (result.barcodes?.first?.text ?? "")
-                    }
+                DispatchQueue.main.async {
+                   let format = result.barcodes?.first?.formatString ?? ""
+                   self.label.text = "Result:\nFormat: " + (format) + "\n" + "Text: " + (result.barcodes?.first?.text ?? "")
+                }
              /* if the scan operation is canceled by the user */
              case .canceled:
-                    DispatchQueue.main.async {
-                       self.label.text = "Scan canceled"
-                    }
+                DispatchQueue.main.async {
+                   self.label.text = "Scan canceled"
+                }
              /* if an error occurs during capture, display the error string in the label */
              case .exception:
-                    DispatchQueue.main.async {
-                       self.label.text = result.errorString
-                    }
+                DispatchQueue.main.async {
+                   self.label.text = result.errorString
+                }
              @unknown default:
-                    break
+                break
              }
              /* return back to the home page to display the result/cancel message/error string */
              DispatchQueue.main.async {
-                    self.navigationController?.popViewController(animated: true)
+                self.navigationController?.popViewController(animated: true)
              }
           }
           /* when the button is clicked, hide the navigation bar and push the newly created BarcodeScannerViewController to the main view */