Skip to content

Commit 24e1fc3

Browse files
update to internal commit 74972fb9
1 parent e0ee365 commit 24e1fc3

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,14 @@ final class MRZScannerConfig
3030
| [`setTemplateFile`](#settemplatefile) | Sets the template with a file path or a JSON string. |
3131
| [`setTorchButtonVisible`](#settorchbuttonvisible) | Sets whether to display the torch button when scanning. |
3232
| [`setBeepEnabled`](#setbeepenabled) | Sets whether the beep sound is triggered or not when a MRZ is scanned. |
33+
| [`setVibrateEnabled`](#setvibrateenabled) | Sets whether the vibration is triggered or not when a MRZ is scanned. |
3334
| [`setCloseButtonVisible`](#setclosebuttonvisible) | Sets the visibility status of the close button for users to close the scanner page. |
3435
| [`setDocumentType`](#setdocumenttype) | Sets the type of document to scan, such as ID cards or passports. |
3536
| [`getLicense`](#getlicense) | Returns the license string. |
3637
| [`getTemplateFile`](#gettemplatefile) | Returns the template with a file path or a JSON string. |
3738
| [`isTorchButtonVisible`](#istorchbuttonvisible) | Returns the visibility status of the torch button. |
3839
| [`isBeepEnabled`](#isbeepenabled) | Returns the play status of the beep sound when a MRZ is scanned. |
40+
| [`isVibrateEnabled`](#isvibrateenabled) | Returns the play status of the vibration when a MRZ is scanned. |
3941
| [`isCloseButtonVisible`](#isclosebuttonvisible) | Returns the visibility status of the close button. |
4042
| [`getDocumentType`](#getdocumenttype) | Returns the type of document to scan, such as ID cards or passports. |
4143
| [`isGuideFrameVisible`](#isguideframevisible) | Returns the visibility status of the guide frame on the display. |
@@ -96,6 +98,18 @@ void setBeepEnabled(boolean beepEnabled);
9698

9799
`beepEnabled`: A boolean value that determines whether to enable the beep sound.
98100

101+
### setVibrateEnabled
102+
103+
Sets whether the vibration is triggered or not when a MRZ is scanned.
104+
105+
```java
106+
void setVibrateEnabled(boolean vibrateEnabled);
107+
```
108+
109+
**Parameter(s)**
110+
111+
`vibrateEnabled`: A boolean value that determines whether to enable the vibration.
112+
99113
### setCloseButtonVisible
100114

101115
Sets the visibility status of the close button for users to close the scanner page.
@@ -168,6 +182,18 @@ boolean isBeepEnabled();
168182

169183
A boolean value that determines whether the beep sound is enabled.
170184

185+
### isVibrateEnabled
186+
187+
Returns whether the vibration is enabled.
188+
189+
```java
190+
boolean isVibrateEnabled();
191+
```
192+
193+
**Return Value**
194+
195+
A boolean value that determines whether the vibration is enabled.
196+
171197
### isCloseButtonVisible
172198

173199
Returns whether the close button is visible.

programming/ios/api-reference/mrz-scanner-config.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ class MRZScannerConfig : NSObject
3838
| [`documentType`](#documenttype) | *NSString* | Sets/Returns the document type to scan, such as ID cards or passports. |
3939
| [`isTorchButtonVisible`](#istorchbuttonvisible) | *BOOL* | Sets/Returns the visibility of the torch button. |
4040
| [`isBeepEnabled`](#isbeepenabled) | *BOOL* | Sets/Returns whether the beep sound is enabled when a MRZ is scanned. |
41+
| [`isVibrateEnabled`](#isvibrateenabled) | *BOOL* | Sets/Returns whether the vibration is enabled when a MRZ is scanned. |
4142
| [`isCloseButtonVisible`](#isclosebuttonvisible) | *BOOL* | Sets/Returns the visibility of the close button. |
4243
| [`isGuideFrameVisible`](#isguideframevisible) | *BOOL* | Sets/Returns the visibility of the guide frame on the display. |
4344

@@ -132,6 +133,23 @@ Sets or returns whether the beep sound is enabled when a MRZ is scanned.
132133
var isBeepEnabled: Bool { get set }
133134
```
134135

136+
### isVibrateEnabled
137+
138+
Sets or returns whether the vibration is enabled when a MRZ is scanned.
139+
140+
<div class="sample-code-prefix"></div>
141+
>- Objective-C
142+
>- Swift
143+
>
144+
>1.
145+
```objc
146+
@property(nonatomic, assign) BOOL isVibrateEnabled;
147+
```
148+
2.
149+
```swift
150+
var isVibrateEnabled: Bool { get set }
151+
```
152+
135153
### isCloseButtonVisible
136154

137155
Sets or returns the visibility of the close button.

0 commit comments

Comments
 (0)