• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.multimodalAwareness.metadataBinding (回旋镖)
2
3本模块提供回旋镖能力调用，包括编码内容传递、订阅事件和取消订阅事件。
4
5> **说明：**
6>
7> 本模块首批接口从API version 18开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8
9
10## 导入模块
11```ts
12import { metadataBinding } from '@ohos.multimodalAwareness';
13```
14
15## submitMetadata(string)
16function submitMetadata(metadata: string): void;
17第三方应用将需要编码的内容传递给MSDP，MSDP决定适时将内容传递给调用编码接口的系统应用或服务。
18**系统能力**：SystemCapability.MultimodalAwarness.metadataBinding
19
20**参数**：
21
22| 参数名   | 类型                             | 必填 | 说明                                                         |
23| -------- | -------------------------------- | ---- | ------------------------------------------------------------ |
24| metadata     | string                           | 是   | 要嵌入图片中的信息。 |
25
26**错误码**：
27
28以下错误码的详细介绍请参见[回旋镖错误码](errorcode-metadataBinding.md)和[通用错误码](../errorcode-universal.md)。
29
30| 错误码ID | 错误信息                                                     |
31| -------- | ------------------------------------------------------------ |
32|32100001|Internal handling failed. Set Meta data to screenshot app fail.|
33
34**示例**：
35
36```ts
37import { metadataBinding } from '@ohos.multimodalAwareness';
38import { BusinessError } from '@kit.BasicServicesKit';
39
40let metadata: string = "";
41try {
42  metadataBinding.submitMetadata(metadata);
43} catch (error) {
44  console.error("submit metadata error" + error);
45}
46```
47
48## metadataBinding.on('operationSubmitMetadata', string,  Callback\<number\>)
49metadataBinding.on(type: 'operationSubmitMetadata', bundleName: string, callback: Callback\<number\>): void;
50
51订阅系统事件以获取编码内容，应用注册回调，事件发生时回传编码内容。
52**系统能力**：SystemCapability.MultimodalAwarness.metadataBinding
53**参数**：
54
55| 参数名   | 类型                             | 必填 | 说明                                                         |
56| -------- | -------------------------------- | ---- | ------------------------------------------------------------ |
57|type| string|是|事件类型，type为‘operationSubmitMetadata’，表示系统应用获取编码内容。|
58|bundlename|string|是|应用包名，标识注册应用的包名。|
59|callback|Callback\<number\>|是|回调函数，用于返回编码内容。|
60
61**错误码**：
62
63以下错误码的详细介绍请参见[回旋镖错误码](errorcode-metadataBinding.md)和[通用错误码](../errorcode-universal.md)。
64
65| 错误码ID | 错误信息                                                     |
66| -------- | ------------------------------------------------------------ |
67|32100001|Internal handling failed. Service exception.|
68|32100004|Subscribe Failed.|
69
70**示例：**
71```ts
72import { metadataBinding } from '@ohos.multimodalAwareness';
73import { BusinessError } from '@kit.BasicServicesKit';
74
75let bundleName: string = '';
76try {
77  metadataBinding.on('operationSubmitMetadata', bundleName, (event: number) =>{
78    if (event == 1) {
79      console.info("The screenshot request is intercepted and the app link is obtained");
80    }
81  });
82} catch (error) {
83  console.info("register screenshot event error");
84}
85```
86
87
88## metadataBinding.off('operationSubmitMetadata', string,  Callback\<number\>)
89metadataBinding.off(type: 'operationSubmitMetadata', bundleName: string, callback?: Callback\<number>): void;
90取消订阅系统获取编码内容的事件。取消注册回调接口。
91**系统能力**：SystemCapability.MultimodalAwarness.metadataBinding
92**参数**：
93
94| 参数名   | 类型                             | 必填 | 说明                                                         |
95| -------- | -------------------------------- | ---- | ------------------------------------------------------------ |
96|type|string|是|事件类型，type为“operationSubmitMetadata”，表示系统应用获取编码内容。|
97|bundlename|string|是|应用包名，标识注册应用的包名。|
98|callback|Callback\<number\>|是|回调函数，返回编码内容。|
99
100**错误码**：
101
102以下错误码的详细介绍请参见[回旋镖错误码](errorcode-metadataBinding.md)和[通用错误码](../errorcode-universal.md)。
103
104| 错误码ID | 错误信息                                                     |
105| -------- | ------------------------------------------------------------ |
106|32100001|Internal handling failed. Service exception.|
107|32100005|Unsubscribe Failed.|
108
109**示例**：
110
111```ts
112import { metadataBinding } from '@ohos.multimodalAwareness';
113import { BusinessError } from '@kit.BasicServicesKit';
114
115let bundleName: string = '';
116try {
117  metadataBinding.off('operationSubmitMetadata', bundleName, (evnet: number)=>{});
118} catch (error) {
119  console.error("unsubscript screenshot event" + error);
120}
121```