提交 8d8ebbdb 编写于 作者: X xieqiongyang

add interface doc

Signed-off-by: Nxieqiongyang <xieqiongyang@huawei.com>
Change-Id: I305605948015b1bcbecaab21f36d0aeabe170c71
上级 526e63d0
......@@ -39,6 +39,7 @@ Ability初次启动原因,该类型为枚举,可配合[Ability](js-apis-app-
| CALL | 2 | 通过[startAbilityByCall](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartabilitybycall)接口启动ability。 |
| CONTINUATION | 3 | 跨端设备迁移启动ability。 |
| APP_RECOVERY | 4 | 设置应用恢复后,应用故障时自动恢复启动ability。 |
| SHARE<sup>10+</sup> | 5 | 通过[acquireShareData](js-apis-app-ability-abilityManager.md#acquiresharedata)接口启动ability。 |
**示例:**
......
......@@ -382,4 +382,76 @@ abilityManager.getTopAbility().then((data) => {
}).catch((err) => {
console.error('getTopAbility fail, err: ${JSON.stringify(err)}');
});
```
## acquireShareData<sup>10+</sup>
acquireShareData(missionId: number, callback: AsyncCallback<{[key: string]: Object}>): void;
获取目标设备的分享数据(callback形式)。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------------- |
| missionId | number | 是 | 目标设备的missionId,最大为2<sup>31</sup>-1。 |
| callback | AsyncCallback<{[key: string]: Object}> | 是 | 以回调方式返回接口运行结果及分享得到的数据,可进行错误处理或其他自定义处理。 |
**错误码**
| 错误码ID | 错误信息 |
| ------- | -------- |
| 16000050 | Internal error. |
以上错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)
**示例**
```ts
import abilityManager from '@ohos.app.ability.abilityManager';
abilityManager.acquireShareData(1, (err, wantParam) => {
if (err && err.code !== 0) {
console.error('acquireShareData fail, err: ${JSON.stringify(err)}');
} else {
console.log('acquireShareData success, data: ${JSON.stringify(data)}');
}
});
```
## acquireShareData<sup>10+</sup>
acquireShareData(missionId: number): Promise<{[key: string]: Object}>;
获取目标设备的分享数据(Promise形式)。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------- |
| Promise<{[key: string]: Object}>| 以Promise方式返回接口运行结果及分享数据,可进行错误处理或其他自定义处理。 |
**错误码**
| 错误码ID | 错误信息 |
| ------- | -------- |
| 16000050 | Internal error. |
以上错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)
**示例**
```ts
import abilityManager from '@ohos.app.ability.abilityManager';
abilityManager.acquireShareData(1).then((wantParam) => {
console.log('acquireShareData success, data: ${JSON.stringify(data)}');
}).catch((err) => {
console.error('acquireShareData fail, err: ${JSON.stringify(err)}');
});
```
\ No newline at end of file
......@@ -300,6 +300,33 @@ class MyUIAbility extends UIAbility {
}
```
## UIAbility.onShare<sup>10+</sup>
onShare(wantParam:{ [key: string]: Object }): void;
ability分享数据。
**系统能力**:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wantParam | {[key:&nbsp;string]:&nbsp;Object} | 是 | want相关参数。 |
**示例:**
```ts
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
class MyUIAbility extends UIAbility {
onShare(wantParams) {
console.log('onShare');
wantParams['ohos.extra.param.key.contentTitle'] = {title: "W3"};
wantParams['ohos.extra.param.key.shareAbstract'] = {abstract: "communication for huawei employee"};
wantParams['ohos.extra.param.key.shareUrl'] = {url: "w3.huawei.com"};
}
}
```
## Caller
......
......@@ -16,13 +16,16 @@ import wantConstant from '@ohos.app.ability.wantConstant';
want的Params操作的常量。
| 名称 | 值 | 说明 |
| ----------------------- | --------------------------- | ------------------------------------------------------------ |
| DLP_PARAMS_SANDBOX | ohos.dlp.params.sandbox | 指示沙盒标志的参数的操作。<br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| DLP_PARAMS_BUNDLE_NAME | ohos.dlp.params.bundleName | 指示DLP Bundle名称的参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| DLP_PARAMS_MODULE_NAME | ohos.dlp.params.moduleName | 指示DLP模块名称的参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| DLP_PARAMS_ABILITY_NAME | ohos.dlp.params.abilityName | 指示DLP能力名称的参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| DLP_PARAMS_INDEX | ohos.dlp.params.index | 指示DLP索引参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| 名称 | 值 | 说明 |
| ----------------------- | ---------------------------------- | ------------------------------------------------------------------------------ |
| DLP_PARAMS_SANDBOX | ohos.dlp.params.sandbox | 指示沙盒标志的参数的操作。<br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| DLP_PARAMS_BUNDLE_NAME | ohos.dlp.params.bundleName | 指示DLP Bundle名称的参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| DLP_PARAMS_MODULE_NAME | ohos.dlp.params.moduleName | 指示DLP模块名称的参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| DLP_PARAMS_ABILITY_NAME | ohos.dlp.params.abilityName | 指示DLP能力名称的参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| DLP_PARAMS_INDEX | ohos.dlp.params.index | 指示DLP索引参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| CONTENT_TITLE_KEY | ohos.extra.param.key.contentTitle | 指示原子化服务支持分享标题的参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| SHARE_ABSTRACT_KEY | ohos.extra.param.key.shareAbstract | 指示原子化服务支持分享内容的参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
| SHARE_URL_KEY | ohos.extra.param.key.shareUrl | 指示原子化服务支持分享链接的参数的操作。 <br>**系统API**:该接口为系统接口,三方应用不支持调用。 |
## wantConstant.Flags
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册