Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
8f867b47
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
8f867b47
编写于
8月 01, 2023
作者:
O
openharmony_ci
提交者:
Gitee
8月 01, 2023
浏览文件
操作
浏览文件
下载
差异文件
!21778 新增UIExtension基础接口资料
Merge pull request !21778 from dy/addUIExtensionBaseDoc
上级
598fcd96
5c94e75b
变更
9
隐藏空白更改
内联
并排
Showing
9 changed file
with
594 addition
and
9 deletion
+594
-9
zh-cn/application-dev/application-models/explicit-implicit-want-mappings.md
...dev/application-models/explicit-implicit-want-mappings.md
+2
-2
zh-cn/application-dev/application-models/hop-cross-device-migration.md
...tion-dev/application-models/hop-cross-device-migration.md
+1
-1
zh-cn/application-dev/application-models/js-ui-widget-development.md
...cation-dev/application-models/js-ui-widget-development.md
+1
-1
zh-cn/application-dev/application-models/lifecycleapp-switch.md
...application-dev/application-models/lifecycleapp-switch.md
+2
-2
zh-cn/application-dev/application-models/lifecycleform-switch.md
...pplication-dev/application-models/lifecycleform-switch.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
...ation-dev/reference/apis/js-apis-app-ability-uiAbility.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiExtensionAbility.md
.../reference/apis/js-apis-app-ability-uiExtensionAbility.md
+84
-0
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiExtensionContentSession.md
...nce/apis/js-apis-app-ability-uiExtensionContentSession.md
+211
-0
zh-cn/application-dev/reference/apis/js-apis-inner-application-uiExtensionContext.md
...ence/apis/js-apis-inner-application-uiExtensionContext.md
+290
-0
未找到文件。
zh-cn/application-dev/application-models/explicit-implicit-want-mappings.md
浏览文件 @
8f867b47
...
@@ -18,7 +18,7 @@
...
@@ -18,7 +18,7 @@
| action | string | 否 | 否 | 系统匹配时将忽略该参数,但仍可作为参数传递给目标应用组件。 |
| action | string | 否 | 否 | 系统匹配时将忽略该参数,但仍可作为参数传递给目标应用组件。 |
| entities | Array
<
string
>
| 否 | 否 | 系统匹配时将忽略该参数,但仍可作为参数传递给目标应用组件。 |
| entities | Array
<
string
>
| 否 | 否 | 系统匹配时将忽略该参数,但仍可作为参数传递给目标应用组件。 |
| flags | number | 否 | 否 | 不参与匹配,直接传递给系统处理,一般用来设置运行态信息,例如URI数据授权等。 |
| flags | number | 否 | 否 | 不参与匹配,直接传递给系统处理,一般用来设置运行态信息,例如URI数据授权等。 |
| parameters | {[key:
string]:
any
} | 否 | 否 | 不参与匹配,应用自定义数据将直接传递给目标应用组件。 |
| parameters | {[key:
string]:
Object
} | 否 | 否 | 不参与匹配,应用自定义数据将直接传递给目标应用组件。 |
## 隐式Want匹配原理
## 隐式Want匹配原理
...
@@ -35,7 +35,7 @@
...
@@ -35,7 +35,7 @@
| action | string | 是 | 否 | |
| action | string | 是 | 否 | |
| entities | Array
<
string
>
| 是 | 否 | |
| entities | Array
<
string
>
| 是 | 否 | |
| flags | number | 否 | 否 | 不参与匹配,直接传递给系统处理,一般用来设置运行态信息,例如URI数据授权等。 |
| flags | number | 否 | 否 | 不参与匹配,直接传递给系统处理,一般用来设置运行态信息,例如URI数据授权等。 |
| parameters | {[key:
string]:
any
} | 否 | 否 | 不参与匹配,应用自定义数据将直接传递给目标应用组件。 |
| parameters | {[key:
string]:
Object
} | 否 | 否 | 不参与匹配,应用自定义数据将直接传递给目标应用组件。 |
从隐式Want的定义,可得知:
从隐式Want的定义,可得知:
...
...
zh-cn/application-dev/application-models/hop-cross-device-migration.md
浏览文件 @
8f867b47
...
@@ -46,7 +46,7 @@
...
@@ -46,7 +46,7 @@
|
**接口名**
|
**描述**
|
|
**接口名**
|
**描述**
|
| -------- | -------- |
| -------- | -------- |
| onContinue(wantParam
:
{[key:
string]:
any
}):
OnContinueResult | 迁移发起端在该回调中保存迁移所需要的数据,同时返回是否同意迁移:
<br/>
-
AGREE:表示同意。
<br/>
-
REJECT:表示拒绝:如应用在onContinue中异常可以直接REJECT。
<br/>
-
MISMATCH:表示版本不匹配:迁移发起端应用可以在onContinue中获取到迁移接收端应用的版本号,进行协商后,如果版本不匹配导致无法迁移,可以返回该错误。 |
| onContinue(wantParam
:
{[key:
string]:
Object
}):
OnContinueResult | 迁移发起端在该回调中保存迁移所需要的数据,同时返回是否同意迁移:
<br/>
-
AGREE:表示同意。
<br/>
-
REJECT:表示拒绝:如应用在onContinue中异常可以直接REJECT。
<br/>
-
MISMATCH:表示版本不匹配:迁移发起端应用可以在onContinue中获取到迁移接收端应用的版本号,进行协商后,如果版本不匹配导致无法迁移,可以返回该错误。 |
| onCreate(want:
Want,
param:
AbilityConstant.LaunchParam):
void; | 应用迁移接收端为冷启动或多实例应用热启动时,在该回调中完成数据恢复,并触发页面恢复。详见
[
应用组件启动模式
](
uiability-launch-type.md
)
|
| onCreate(want:
Want,
param:
AbilityConstant.LaunchParam):
void; | 应用迁移接收端为冷启动或多实例应用热启动时,在该回调中完成数据恢复,并触发页面恢复。详见
[
应用组件启动模式
](
uiability-launch-type.md
)
|
| onNewWant(want:
Want,
launchParams:
AbilityConstant.LaunchParam):
void; | 迁移接收端为单实例应用热启动时,在该回调中完成数据恢复,并触发页面恢复。详见
[
应用组件启动模式
](
uiability-launch-type.md
)
|
| onNewWant(want:
Want,
launchParams:
AbilityConstant.LaunchParam):
void; | 迁移接收端为单实例应用热启动时,在该回调中完成数据恢复,并触发页面恢复。详见
[
应用组件启动模式
](
uiability-launch-type.md
)
|
...
...
zh-cn/application-dev/application-models/js-ui-widget-development.md
浏览文件 @
8f867b47
...
@@ -55,7 +55,7 @@ FormExtensionAbility类拥有如下API接口,具体的API介绍详见[接口
...
@@ -55,7 +55,7 @@ FormExtensionAbility类拥有如下API接口,具体的API介绍详见[接口
| onFormEvent(formId:
string,
message:
string):
void | 卡片提供方接收处理卡片事件的通知接口。 |
| onFormEvent(formId:
string,
message:
string):
void | 卡片提供方接收处理卡片事件的通知接口。 |
| onRemoveForm(formId:
string):
void | 卡片提供方接收销毁卡片的通知接口。 |
| onRemoveForm(formId:
string):
void | 卡片提供方接收销毁卡片的通知接口。 |
| onConfigurationUpdate(config:
Configuration):
void | 当系统配置更新时调用。 |
| onConfigurationUpdate(config:
Configuration):
void | 当系统配置更新时调用。 |
| onShareForm?(formId:
string):
{
[key:
string]:
any
} | 卡片提供方接收卡片分享的通知接口。 |
| onShareForm?(formId:
string):
{
[key:
string]:
Object
} | 卡片提供方接收卡片分享的通知接口。 |
formProvider类有如下API接口,具体的API介绍详见
[
接口文档
](
../reference/apis/js-apis-app-form-formProvider.md
)
。
formProvider类有如下API接口,具体的API介绍详见
[
接口文档
](
../reference/apis/js-apis-app-form-formProvider.md
)
。
...
...
zh-cn/application-dev/application-models/lifecycleapp-switch.md
浏览文件 @
8f867b47
...
@@ -9,11 +9,11 @@
...
@@ -9,11 +9,11 @@
| onCreate?():
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncreate
)
|
| onCreate?():
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncreate
)
|
| onWindowDisplayModeChanged?(isShownInMultiWindow:
boolean,
newConfig:
resourceManager.Configuration):
void; | Stage模型无对应接口 | 暂时未提供对应接口 |
| onWindowDisplayModeChanged?(isShownInMultiWindow:
boolean,
newConfig:
resourceManager.Configuration):
void; | Stage模型无对应接口 | 暂时未提供对应接口 |
| onStartContinuation?():
boolean; | Stage模型无对应接口 | Stage模型上,应用无需感知迁移是否成功(由应用发起迁移请求时感知),onStartContinuation废弃 |
| onStartContinuation?():
boolean; | Stage模型无对应接口 | Stage模型上,应用无需感知迁移是否成功(由应用发起迁移请求时感知),onStartContinuation废弃 |
| onSaveData?(data:
Object):
boolean; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onContinue(wantParam : {[key: string]:
any
}): AbilityConstant.OnContinueResult;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncontinue
)
|
| onSaveData?(data:
Object):
boolean; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onContinue(wantParam : {[key: string]:
Object
}): AbilityConstant.OnContinueResult;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncontinue
)
|
| onCompleteContinuation?(result:
number):
void; | application
\C
ontinueCallback.d.ts |
[
onContinueDone(result: number): void;
](
../reference/apis/js-apis-distributedMissionManager.md#continuecallback
)
|
| onCompleteContinuation?(result:
number):
void; | application
\C
ontinueCallback.d.ts |
[
onContinueDone(result: number): void;
](
../reference/apis/js-apis-distributedMissionManager.md#continuecallback
)
|
| onRestoreData?(data:
Object):
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncreate
)
<br/>
[
onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityonnewwant
)
<br/>
多实例模式Ability迁移目标端在onCreate回调中完成数据恢复,单实例模式应用迁移目标端在onCreate回调中完成数据恢复,回调中通过判断launchParam.launchReason可获取迁移启动的场景,从而可以从Want中获取迁移前保存的数据 |
| onRestoreData?(data:
Object):
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncreate
)
<br/>
[
onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityonnewwant
)
<br/>
多实例模式Ability迁移目标端在onCreate回调中完成数据恢复,单实例模式应用迁移目标端在onCreate回调中完成数据恢复,回调中通过判断launchParam.launchReason可获取迁移启动的场景,从而可以从Want中获取迁移前保存的数据 |
| onRemoteTerminated?():
void; | application
\C
ontinueCallback.d.ts |
[
onContinueDone(result: number): void;
](
../reference/apis/js-apis-distributedMissionManager.md#continuecallback
)
|
| onRemoteTerminated?():
void; | application
\C
ontinueCallback.d.ts |
[
onContinueDone(result: number): void;
](
../reference/apis/js-apis-distributedMissionManager.md#continuecallback
)
|
| onSaveAbilityState?(outState:
PacMap):
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]:
any
}): AbilityConstant.OnSaveResult;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityonsavestate
)
|
| onSaveAbilityState?(outState:
PacMap):
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]:
Object
}): AbilityConstant.OnSaveResult;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityonsavestate
)
|
| onRestoreAbilityState?(inState:
PacMap):
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncreate
)
<br/>
应用重启后会触发Ability的onCreate方法,通过判断launchParam.launchReason可获取自恢复的场景,从而可以从Want中获取重启前保存的数据 |
| onRestoreAbilityState?(inState:
PacMap):
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityoncreate
)
<br/>
应用重启后会触发Ability的onCreate方法,通过判断launchParam.launchReason可获取自恢复的场景,从而可以从Want中获取重启前保存的数据 |
| onInactive?():
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onBackground(): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityonbackground
)
|
| onInactive?():
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onBackground(): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityonbackground
)
|
| onActive?():
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onForeground(): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityonforeground
)
|
| onActive?():
void; |
\@
ohos.app.ability.UIAbility.d.ts |
[
onForeground(): void;
](
../reference/apis/js-apis-app-ability-uiAbility.md#abilityonforeground
)
|
...
...
zh-cn/application-dev/application-models/lifecycleform-switch.md
浏览文件 @
8f867b47
...
@@ -10,4 +10,4 @@
...
@@ -10,4 +10,4 @@
| onEvent?(formId:
string,
message:
string):
void; |
\@
ohos.app.form.FormExtensionAbility.d.ts |
[
onFormEvent(formId: string, message: string): void;
](
../reference/apis/js-apis-app-form-formExtensionAbility.md#onformevent
)
|
| onEvent?(formId:
string,
message:
string):
void; |
\@
ohos.app.form.FormExtensionAbility.d.ts |
[
onFormEvent(formId: string, message: string): void;
](
../reference/apis/js-apis-app-form-formExtensionAbility.md#onformevent
)
|
| onDestroy?(formId:
string):
void; |
\@
ohos.app.form.FormExtensionAbility.d.ts |
[
onRemoveForm(formId: string): void;
](
../reference/apis/js-apis-app-form-formExtensionAbility.md#onremoveform
)
|
| onDestroy?(formId:
string):
void; |
\@
ohos.app.form.FormExtensionAbility.d.ts |
[
onRemoveForm(formId: string): void;
](
../reference/apis/js-apis-app-form-formExtensionAbility.md#onremoveform
)
|
| onAcquireFormState?(want:
Want):
formInfo.FormState; |
\@
ohos.app.form.FormExtensionAbility.d.ts |
[
onAcquireFormState?(want: Want): formInfo.FormState;
](
../reference/apis/js-apis-app-form-formExtensionAbility.md#onacquireformstate
)
|
| onAcquireFormState?(want:
Want):
formInfo.FormState; |
\@
ohos.app.form.FormExtensionAbility.d.ts |
[
onAcquireFormState?(want: Want): formInfo.FormState;
](
../reference/apis/js-apis-app-form-formExtensionAbility.md#onacquireformstate
)
|
| onShare?(formId:
string):
{[key:
string]:
any}; |
\@
ohos.app.form.FormExtensionAbility.d.ts |
[
onShareForm?(formId: string): { [key: string]: any
};
](
../reference/apis/js-apis-app-form-formExtensionAbility.md#onshareform
)
|
| onShare?(formId:
string):
{[key:
string]:
Object}; |
\@
ohos.app.form.FormExtensionAbility.d.ts |
[
onShareForm?(formId: string): { [key: string]: Object
};
](
../reference/apis/js-apis-app-form-formExtensionAbility.md#onshareform
)
|
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
浏览文件 @
8f867b47
...
@@ -202,7 +202,7 @@ onContinue(wantParam: { [key: string]: Object }): AbilityConstant.OnContinueResu
...
@@ -202,7 +202,7 @@ onContinue(wantParam: { [key: string]: Object }): AbilityConstant.OnContinueResu
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| wantParam | {[key:
string]:
any
} | 是 | want相关参数。 |
| wantParam | {[key:
string]:
Object
} | 是 | want相关参数。 |
**返回值:**
**返回值:**
...
@@ -289,7 +289,7 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: Objec
...
@@ -289,7 +289,7 @@ onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: Objec
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| reason |
[
AbilityConstant.StateType
](
js-apis-app-ability-abilityConstant.md#abilityconstantstatetype
)
| 是 | 回调保存状态的原因。 |
| reason |
[
AbilityConstant.StateType
](
js-apis-app-ability-abilityConstant.md#abilityconstantstatetype
)
| 是 | 回调保存状态的原因。 |
| wantParam | {[key:
string]:
any
} | 是 | want相关参数。 |
| wantParam | {[key:
string]:
Object
} | 是 | want相关参数。 |
**返回值:**
**返回值:**
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiExtensionAbility.md
0 → 100644
浏览文件 @
8f867b47
# @ohos.app.ability.UIExtensionAbility (带界面扩展能力基类)
UIExtensionAbility是特定场景下带界面扩展能力的基类,继承自
[
ExtensionAbility
](
js-apis-app-ability-extensionAbility.md
)
,新增带界面扩展能力相关的属性和方法。不支持开发者直接继承该基类。
> **说明:**
>
> 本模块首批接口从API version 10 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```
ts
import
UIExtensionAbility
from
'
@ohos.app.ability.UIExtensionAbility
'
;
```
## 属性
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context |
[
UIExtensionContext
](
js-apis-inner-application-uiExtensionContext.md
)
| 是 | 否 | 上下文。 |
## UIExtensionAbility.onCreate
onCreate(): void
UIExtensionAbility创建时回调,执行初始化业务逻辑操作。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
## UIExtensionAbility.onSessionCreate
onSessionCreate(want: Want, session: UIExtensionContentSession): void
当UIExtensionAbility界面内容对象创建后调用。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-app-ability-want.md
)
| 是 | 当前UIExtensionAbility的Want类型信息,包括ability名称、bundle名称等。 |
| session |
[
UIExtensionContentSession
](
js-apis-app-ability-uiExtensionContentSession.md
)
| 是 | UIExtensionAbility界面内容相关信息。 |
## UIExtensionAbility.onSessionDestroy
onSessionDestroy(session: UIExtensionContentSession): void
当UIExtensionAbility界面内容对象销毁后调用。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| session |
[
UIExtensionContentSession
](
js-apis-app-ability-uiExtensionContentSession.md
)
| 是 | UIExtensionAbility界面内容相关信息。 |
## UIExtensionAbility.onForeground
onForeground(): void;
UIExtensionAbility生命周期回调,当UIExtensionAbility从后台转到前台时触发。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
## UIExtensionAbility.onBackground
onBackground(): void;
UIExtensionAbility生命周期回调,当UIExtensionAbility从前台转到后台时触发。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
## UIExtensionAbility.onDestroy
onDestroy(): void | Promise
<
void
>
;
UIExtensionAbility生命周期回调,在销毁时回调,执行资源清理等操作。
在执行完onDestroy生命周期回调后,应用可能会退出,从而可能导致onDestroy中的异步函数未能正确执行,比如异步写入数据库。可以使用异步生命周期,以确保异步onDestroy完成后再继续后续的生命周期。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiExtensionContentSession.md
0 → 100644
浏览文件 @
8f867b47
# @ohos.app.ability.UIExtensionContentSession (带界面扩展能力界面操作类)
UIExtensionContentSession是
[
UIExtensionAbility
](
js-apis-app-ability-uiExtensionAbility.md
)
加载界面内容时创建的实例对象,当UIExtensionComponent控件拉起指定的UIExtensionAbility时,UIExtensionAbility会创建UIExtensionContentSession对象,并通过
[
onSessionCreate
](
js-apis-app-ability-uiExtensionAbility.md#uiextensionabilityonsessioncreate
)
回调传递给开发者。一个UIExtensionComponent控件对应一个UIExtensionContentSession对象,提供界面加载,结果通知等方法。每个UIExtensionAbility的UIExtensionContentSession之间互不影响,可以各自进行操作。
> **说明:**
>
> 本模块首批接口从API version 10 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```
ts
import
UIExtensionContentSession
from
'
@ohos.app.ability.UIExtensionContentSession
'
;
```
## UIExtensionContentSession.sendData
sendData(data: { [key: string]: Object }): void
发送数据给UIExtensionComponent控件。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**系统API**
:此接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| data | {[key:
string]:
Object} | 是 | 发送给UIExtensionComponent控件的数据参数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000050 | Internal error. |
错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
## UIExtensionContentSession.setReceiveDataCallback
setReceiveDataCallback(callback: (data: { [key: string]: Object }) => void): void
设置从UIExtensionComponent控件接收数据的回调方法。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**系统API**
:此接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | (data: { [key: string]: Object }) => void | 是 | 接收数据的回调方法。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000050 | Internal error. |
错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
## UIExtensionContentSession.loadContent
loadContent(path: string, storage?: LocalStorage): Promise
<
void
>
为当前UIExtensionComponent控件对应的窗口加载与LocalStorage相关联的具体页面内容。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------------------- | ---- | ------------------------------------------------------------ |
| path | string | 是 | 设置加载页面的路径。 |
| storage |
[
LocalStorage
](
../../quick-start/arkts-localstorage.md
)
| 否 | 存储单元,为应用程序范围内的可变状态属性和非可变状态属性提供存储。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000050 | Internal error. |
错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
## UIExtensionContentSession.terminateSelf
terminateSelf(callback: AsyncCallback
<
void
>
): void;
停止UIExtensionContentSession对应的窗口界面对象(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 停止UIExtensionContentSession对应的窗口界面对象的回调函数。 |
## UIExtensionContentSession.terminateSelf
terminateSelf(): Promise
<
void
>
;
停止UIExtensionContentSession对应的窗口界面对象(promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 停止UIExtensionContentSession对应的窗口界面对象的回调函数。 |
## UIExtensionContentSession.terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback
<
void
>
): void;
停止UIExtensionContentSession对应的窗口界面对象,并将结果返回给UIExtensionComponent控件(callback形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter |
[
AbilityResult
](
js-apis-inner-ability-abilityResult.md
)
| 是 | 返回给UIExtensionComponent控件的信息。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回停止结果。 |
## UIExtensionContentSession.terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult): Promise
<
void
>
;
停止UIExtensionContentSession对应的窗口界面对象,并将结果返回给UIExtensionComponent控件(promise形式)。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter |
[
AbilityResult
](
js-apis-inner-ability-abilityResult.md
)
| 是 | 返回给UIExtensionComponent控件的信息。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| promise形式返回停止结果。 |
## UIExtensionContentSession.setWindowBackgroundColor
setWindowBackgroundColor(color: string): void
设置UIExtensionAbility加载界面的背景色。该接口需要在
[
loadContent()
](
#uiextensioncontentsessionloadcontent
)
调用生效后使用。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**系统API**
:此接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| color | string | 是 | 需要设置的背景色,为十六进制RGB或ARGB颜色,不区分大小写,例如
`#00FF00`
或
`#FF00FF00`
。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000050 | Internal error. |
错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
## UIExtensionContentSession.setWindowPrivacyMode
setWindowPrivacyMode(isPrivacyMode: boolean): Promise
<
void
>
设置窗口是否为隐私模式,使用Promise异步回调。设置为隐私模式的窗口,窗口内容将无法被截屏或录屏。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.AbilityCore
**需要权限:**
ohos.permission.PRIVACY_WINDOW
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------- | -- | ----------------------------------------------------- |
| isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。true表示模式开启;false表示模式关闭。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | ------------------------ |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
## UIExtensionContentSession.setWindowPrivacyMode
setWindowPrivacyMode(isPrivacyMode: boolean, callback: AsyncCallback
<
void
>
): void
设置窗口是否为隐私模式,使用callback异步回调。设置为隐私模式的窗口,窗口内容将无法被截屏或录屏。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.AbilityCore
**需要权限:**
ohos.permission.PRIVACY_WINDOW
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------- | ------------------------- | -- | ------------------------------------------------------ |
| isPrivacyMode | boolean | 是 | 窗口是否为隐私模式。true表示模式开启;false表示模式关闭。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数。 |
zh-cn/application-dev/reference/apis/js-apis-inner-application-uiExtensionContext.md
0 → 100644
浏览文件 @
8f867b47
# UIExtensionContext
UIExtensionContext是
[
UIExtensionAbility
](
js-apis-app-ability-uiExtensionAbility.md
)
的上下文环境,继承自
[
ExtensionContext
](
js-apis-inner-application-extensionContext.md
)
,提供UIExtensionAbility的相关配置信息以及操作UIAbility的方法,如启动UIAbility等。
> **说明:**
>
> - 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本模块接口仅可在Stage模型下使用。
## 导入模块
```
ts
import
common
from
'
@ohos.app.ability.common
'
;
```
## UIExtensionContext.startAbility
startAbility(want: Want, callback: AsyncCallback
<
void
>
): void;
启动Ability(callback形式)。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
跨应用场景下,目标Ability的exported属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000012 | The application is controlled. |
| 16000013 | The application is controlled by EDM. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
## UIExtensionContext.startAbility
startAbility(want: Want, options: StartOptions, callback: AsyncCallback
<
void
>
): void;
启动Ability(callback形式)。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
跨应用场景下,目标Ability的exported属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000012 | The application is controlled. |
| 16000013 | The application is controlled by EDM. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
## UIExtensionContext.startAbility
startAbility(want: Want, options?: StartOptions): Promise
<
void
>
;
启动Ability(promise形式)。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
跨应用场景下,目标Ability的exported属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动Ability所携带的参数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| Promise形式返回启动结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000012 | The application is controlled. |
| 16000013 | The application is controlled by EDM. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
## UIExtensionContext.startAbilityForResult
startAbilityForResult(want: Want, callback: AsyncCallback
<
AbilityResult
>
): void;
启动一个Ability。Ability被启动后,有如下情况(callback形式):
-
正常情况下可通过调用
[
terminateSelfWithResult
](
js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用方。
-
异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
-
如果被启动的Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability,当这个Ability调用
[
terminateSelfWithResult
](
js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateselfwithresult
)
接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
跨应用场景下,目标Ability的exported属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| callback | AsyncCallback
<
[AbilityResult](js-apis-inner-ability-abilityResult.md)
>
| 是 | 执行结果回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000012 | The application is controlled. |
| 16000013 | The application is controlled by EDM. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
## UIExtensionContext.startAbilityForResult
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
<
AbilityResult
>
): void;
启动一个Ability。Ability被启动后,有如下情况(callback形式):
-
正常情况下可通过调用
[
terminateSelfWithResult
](
js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用方。
-
异常情况下比如杀死Ability会返回异常信息给调用方,异常信息中resultCode为-1。
-
如果被启动的Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability,当这个Ability调用
[
terminateSelfWithResult
](
js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateselfwithresult
)
接口使之终止时,只将正常结果返回给最后一个调用方,其它调用方返回异常信息, 异常信息中resultCode为-1。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
跨应用场景下,目标Ability的exported属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback
<
[AbilityResult](js-apis-inner-ability-abilityResult.md)
>
| 是 | 执行结果回调函数。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000012 | The application is controlled. |
| 16000013 | The application is controlled by EDM. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
## UIExtensionContext.startAbilityForResult
startAbilityForResult(want: Want, options?: StartOptions): Promise
<
AbilityResult
>
;
启动一个Ability。Ability被启动后,有如下情况(promise形式):
-
正常情况下可通过调用
[
terminateSelfWithResult
](
js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateselfwithresult
)
接口使之终止并且返回结果给调用方。
-
异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
-
如果被启动的Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability,当这个Ability调用
[
terminateSelfWithResult
](
js-apis-inner-application-uiAbilityContext.md#uiabilitycontextterminateselfwithresult
)
接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
使用规则:
-
调用方应用位于后台时,使用该接口启动Ability需申请
`ohos.permission.START_ABILITIES_FROM_BACKGROUND`
权限
-
跨应用场景下,目标Ability的exported属性若配置为false,调用方应用需申请
`ohos.permission.START_INVISIBLE_ABILITY`
权限
-
组件启动规则详见:
[
组件启动规则(Stage模型)
](
../../application-models/component-startup-rules.md
)
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 启动Ability的want信息。 |
| options |
[
StartOptions
](
js-apis-app-ability-startOptions.md
)
| 否 | 启动Ability所携带的参数。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[AbilityResult](js-apis-inner-ability-abilityResult.md)
>
| Promise形式返回执行结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000012 | The application is controlled. |
| 16000013 | The application is controlled by EDM. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录