@ohos.multimodalAwareness.metadataBinding (Metadata Binding)

The metadataBinding module provides metadata binding–specific functions such as metadata transfer, event subscription, and event unsubscription.

NOTE

The initial APIs of this module are supported since API version 18. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import { metadataBinding } from '@kit.MultimodalAwarenessKit';

metadataBinding.submitMetadata

submitMetadata(metadata: string): void

Transfers the metadata to be encoded to the MSDP. The MSDP determines whether to transfer the metadata to the system application or service that calls the encoding API.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.MultimodalAwareness.MetadataBinding

Parameters

Name	Type	Mandatory	Description
metadata	string	Yes	Metadata to be encoded.

Error codes

For details about the error codes, see Metadata Binding Error Codes.

ID	Error Message
32100001	Internal handling failed. Set Meta data to screenshot app fail.

Example

import { metadataBinding } from '@kit.MultimodalAwarenessKit';
import { BusinessError } from '@kit.BasicServicesKit';

let metadata: string = "";
try {
  metadataBinding.submitMetadata(metadata);
} catch (error) {
  console.error("submit metadata error" + error);
}

metadataBinding.on('operationSubmitMetadata')

on(type: 'operationSubmitMetadata', bundleName: string, callback: Callback<number>): void

Subscribes to a system event to obtain the encoded metadata. The application needs to register a callback to return the encoded metadata when the registered system event occurs.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.MultimodalAwareness.MetadataBinding

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. This parameter has a fixed value of operationSubmitMetadata, indicating the system application's attempt to obtain the encoded metadata.
bundleName	string	Yes	Application bundle name.
callback	Callback<number>	Yes	Callback used to return the encoded metadata.

Error codes

For details about the error codes, see Metadata Binding Error Codes.

ID	Error Message
32100001	Internal handling failed. Service exception.
32100004	Subscribe Failed. Possible causes: 1. Abnormal system capability; 2. IPC communication abnormality; 3. Algorithm loading exception.

Example

import { metadataBinding } from '@kit.MultimodalAwarenessKit';
import { BusinessError } from '@kit.BasicServicesKit';

let bundleName: string = '';
try {
  metadataBinding.on('operationSubmitMetadata', bundleName, (event: number) => {
    if (event == 1) {
      console.info("The screenshot request is intercepted and the app link is obtained");
    }
  });
} catch (error) {
  console.error("register screenshot event error");
}

metadataBinding.off('operationSubmitMetadata')

off(type: 'operationSubmitMetadata', bundleName: string, callback?: Callback<number>): void

Unsubscribes from system events that are used to obtain the encoded metadata. The respective callback will be unregistered.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.MultimodalAwareness.MetadataBinding

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. This parameter has a fixed value of operationSubmitMetadata, indicating the system application's attempt to obtain the encoded metadata.
bundleName	string	Yes	Application bundle name.
callback	Callback<number>	No	Callback used to return the encoded metadata.

Error codes

For details about the error codes, see Metadata Binding Error Codes.

ID	Error Message
32100001	Internal handling failed. Service exception.
32100005	Unsubscribe Failed. Possible causes: 1. Abnormal system capability; 2. IPC communication abnormality.

Example

import { metadataBinding } from '@kit.MultimodalAwarenessKit';
import { BusinessError } from '@kit.BasicServicesKit';

let bundleName: string = '';
try {
  metadataBinding.off('operationSubmitMetadata', bundleName, (event: number) => {
  });
} catch (error) {
  console.error("unsubscript screenshot event" + error);
}