feat(anyline): add setDefaultScanStartPlatformOptions and note legacy API deprecation

2026-08-04 00:00:08 +08:00 · 2026-07-27 22:19:55 +02:00
1 changed files with 17 additions and 0 deletions
@@ -9,6 +9,10 @@ export interface AnylineConfig {
 * @name Anyline
 * @description
 * Anyline provides an easy-to-use SDK for applications to enable Optical Character Recognition (OCR) on mobile devices.
+ *
+ * @deprecated since v56.0.0. This legacy `AnylineSDK` API remains functional but upstream recommends migrating to the
+ * new `AnylineInfinityPlugin` API (exposed natively as `window.AnylineInfinity`), which is not covered by this wrapper.
+ * See https://documentation.anyline.com/cordova-plugin-component/latest/infinity-plugins/upgrade-guide.html
 * @usage
 * ```typescript
 * import { Anyline } from '@awesome-cordova-plugins/anyline/ngx';
@@ -59,4 +63,17 @@ export class Anyline extends AwesomeCordovaNativePlugin {
  scan(config: AnylineConfig): Promise<any> {
    return;
  }
+
+  /**
+   * Sets platform-specific scanning options, such as selecting the camera API on Android
+   * (CameraX vs Camera1) or managing camera permission handling. Must be called before `scan`.
+   *
+   * @param scanStartPlatformOptionsString {string} A JSON-stringified object of platform-specific attributes,
+   * e.g. `JSON.stringify({ androidScanViewAttributes: { useCameraX: false } })`
+   * @returns {Promise<any>} Returns a promise that resolves when the options have been set
+   */
+  @Cordova()
+  setDefaultScanStartPlatformOptions(scanStartPlatformOptionsString: string): Promise<any> {
+    return;
+  }
 }