提交 5c168ff5 编写于 作者: R RayShih

调整changelogs目录结构

Signed-off-by: NRayShih <shirui721@huawei.com>
上级 213890ac
# 帐号子系统ChangeLog # 帐号子系统ChangeLog
## cl.account_os_account.1 帐号SystemAPI错误信息返回方式变更 ## cl.account_os_account.1 帐号SystemAPI错误信息返回方式变更
已发布的部分帐号SystemAPI使用业务逻辑返回值表示错误信息,不符合OpenHarmony接口错误码规范。从API9开始作以下变更: 已发布的部分帐号SystemAPI使用业务逻辑返回值表示错误信息,不符合OpenHarmony接口错误码规范。从API9开始作以下变更:
异步接口:通过AsyncCallback或Promise的error对象返回错误信息。 异步接口:通过AsyncCallback或Promise的error对象返回错误信息。
同步接口:通过抛出异常的方式返回错误信息。 同步接口:通过抛出异常的方式返回错误信息。
**变更影响** **变更影响**
基于此前版本开发的应用,需适配变更接口的错误信息返回方式,否则会影响原有业务逻辑。 基于此前版本开发的应用,需适配变更接口的错误信息返回方式,否则会影响原有业务逻辑。
**关键接口/组件变更** **关键接口/组件变更**
变更前: 变更前:
- class UserAuth - class UserAuth
- setProperty(request: SetPropertyRequest, callback: AsyncCallback&lt;number&gt;): void; - setProperty(request: SetPropertyRequest, callback: AsyncCallback&lt;number&gt;): void;
- setProperty(request: SetPropertyRequest): Promise&lt;number&gt;; - setProperty(request: SetPropertyRequest): Promise&lt;number&gt;;
- cancelAuth(contextID: Uint8Array): number; - cancelAuth(contextID: Uint8Array): number;
- class PINAuth - class PINAuth
- registerInputer(inputer: Inputer): boolean; - registerInputer(inputer: Inputer): boolean;
- UserIdentityManager - UserIdentityManager
- cancel(challenge: Uint8Array): number; - cancel(challenge: Uint8Array): number;
变更后: 变更后:
- class UserAuth - class UserAuth
- setProperty(request: SetPropertyRequest, callback: AsyncCallback&lt;void&gt;): void; - setProperty(request: SetPropertyRequest, callback: AsyncCallback&lt;void&gt;): void;
- setProperty(request: SetPropertyRequest): Promise&lt;void&gt;; - setProperty(request: SetPropertyRequest): Promise&lt;void&gt;;
- cancelAuth(contextID: Uint8Array): void; - cancelAuth(contextID: Uint8Array): void;
- class PINAuth - class PINAuth
- registerInputer(inputer: Inputer): void; - registerInputer(inputer: Inputer): void;
- UserIdentityManager - UserIdentityManager
- cancel(challenge: Uint8Array): void; - cancel(challenge: Uint8Array): void;
**适配指导** **适配指导**
异步接口以setProperty为例,示例代码如下: 异步接口以setProperty为例,示例代码如下:
``` ```
import account_osAccount from "@ohos.account.osAccount" import account_osAccount from "@ohos.account.osAccount"
userAuth.setProperty({ userAuth.setProperty({
authType: account_osAccount.AuthType.PIN, authType: account_osAccount.AuthType.PIN,
key: account_osAccount.SetPropertyType.INIT_ALGORITHM, key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
setInfo: new Uint8Array([0]) setInfo: new Uint8Array([0])
}, (err) => { }, (err) => {
if (err) { if (err) {
console.log("setProperty failed, error: " + JSON.stringify(err)); console.log("setProperty failed, error: " + JSON.stringify(err));
} else { } else {
console.log("setProperty successfully"); console.log("setProperty successfully");
} }
}); });
userAuth.setProperty({ userAuth.setProperty({
authType: account_osAccount.AuthType.PIN, authType: account_osAccount.AuthType.PIN,
key: account_osAccount.SetPropertyType.INIT_ALGORITHM, key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
setInfo: new Uint8Array([0]) setInfo: new Uint8Array([0])
}).catch((err) => { }).catch((err) => {
if (err) { if (err) {
console.log("setProperty failed, error: " + JSON.stringify(err)); console.log("setProperty failed, error: " + JSON.stringify(err));
} else { } else {
console.log("setProperty successfully"); console.log("setProperty successfully");
} }
}); });
``` ```
同步接口以registerInputer为例,示例代码如下: 同步接口以registerInputer为例,示例代码如下:
``` ```
import account_osAccount from "@ohos.account.osAccount" import account_osAccount from "@ohos.account.osAccount"
let pinAuth = new account_osAccount.PINAuth() let pinAuth = new account_osAccount.PINAuth()
let inputer = { let inputer = {
onGetData: (authType, passwordRecipient) => { onGetData: (authType, passwordRecipient) => {
let password = new Uint8Array([0]); let password = new Uint8Array([0]);
passwordRecipient.onSetData(authType, password); passwordRecipient.onSetData(authType, password);
} }
} }
try { try {
pinAuth.registerInputer(inputer); pinAuth.registerInputer(inputer);
} catch (err) { } catch (err) {
console.log("registerInputer failed, error: " + JSON.stringify(err)); console.log("registerInputer failed, error: " + JSON.stringify(err));
} }
``` ```
## cl.account_os_account.2 应用帐号鉴权服务ACTION定义变更 ## cl.account_os_account.2 应用帐号鉴权服务ACTION定义变更
**变更影响** **变更影响**
基于此前版本开发的应用,需适配修改应用配置文件(FA模型为config.json或Stage模型为module.json5)中的ACTION才能正常对外提供应用鉴权服务。 基于此前版本开发的应用,需适配修改应用配置文件(FA模型为config.json或Stage模型为module.json5)中的ACTION才能正常对外提供应用鉴权服务。
**关键接口/组件变更** **关键接口/组件变更**
涉及的常量: 涉及的常量:
@ohos.ability.wantConstant.ACTION_APP_ACCOUNT_AUTH @ohos.ability.wantConstant.ACTION_APP_ACCOUNT_AUTH
变更前: 变更前:
ACTION_APP_ACCOUNT_AUTH = "account.appAccount.action.auth" ACTION_APP_ACCOUNT_AUTH = "account.appAccount.action.auth"
变更后: 变更后:
ACTION_APP_ACCOUNT_AUTH = "ohos.appAccount.action.auth" ACTION_APP_ACCOUNT_AUTH = "ohos.appAccount.action.auth"
**适配指导** **适配指导**
提供应用帐号鉴权服务的三方应用,需要在相关ServiceAbility的配置文件(FA模型为config.json或Stage模型为module.json5)中适配变更后的应用帐号认证ACTION,示例如下: 提供应用帐号鉴权服务的三方应用,需要在相关ServiceAbility的配置文件(FA模型为config.json或Stage模型为module.json5)中适配变更后的应用帐号认证ACTION,示例如下:
``` ```
"abilities": [ "abilities": [
{ {
"name": "ServiceAbility", "name": "ServiceAbility",
"srcEntrance": "./ets/ServiceAbility/ServiceAbility.ts", "srcEntrance": "./ets/ServiceAbility/ServiceAbility.ts",
... ...
"visible": true, "visible": true,
"skills": { "skills": {
{ {
"actions": [ "actions": [
"ohos.appAccount.action.auth" "ohos.appAccount.action.auth"
] ]
} }
} }
}] }]
} }
# xxx子系统ChangeLog
相比最近一个发布版本(包括不限于LTS、Release、Beta、monthly版本)发生了影响契约兼容性(契约兼容:也称语义兼容,指版本演进后,开发者原有程序行为不发生变化)的变更(包括不限于接口名、参数、返回值、所需要的权限、调用顺序、枚举值、配置参数、路径等),则需要在ChangeLog中对变更进行阐述。
## cl.subsystemname.x xxx功能变更, 例:DeviceType属性变更、相机权限变更(尽量概括,不要超过15个字)
每个变更标题前需要附加编号:cl.subsystemname.x。cl为ChangeLog首字母缩写,subsystemname请填写子系统英文标准名称,x表示变更序号(从低到高逐位增加,起始为1)。
以功能维度对变更点进行概括描述。例如:xxx功能的xxx、xxx等发生了xxx变化,开发者需要根据以下说明对应用进行适配。
如果有此变更有对应的需求或设计文档,可以在描述中附上对应的设计文档编号。
**变更影响**
是否影响已发布的接口或者接口行为发生变更,影响的是JS接口还是Native接口。
是否影响在此前版本已开发的应用,即应用是否需要进行适配动才可以在新版本SDK环境正常编译通过。
**关键的接口/组件变更**
列举此功能变更涉及的接口/组件变更。
**适配指导(可选,不涉及则可以删除)**
提供指导,帮助开发者针对相关变更进行适配,使应用可以与新版本兼容。
例:
在xxx文件中将xxx参数修改为xxx。
```
sample code
```
# xxx子系统ChangeLog
相比最近一个发布版本(包括不限于LTS、Release、Beta、monthly版本)发生了影响契约兼容性(契约兼容:也称语义兼容,指版本演进后,开发者原有程序行为不发生变化)的变更(包括不限于接口名、参数、返回值、所需要的权限、调用顺序、枚举值、配置参数、路径等),则需要在ChangeLog中对变更进行阐述。
## cl.subsystemname.x xxx功能变更, 例:DeviceType属性变更、相机权限变更(尽量概括,不要超过15个字)
每个变更标题前需要附加编号:cl.subsystemname.x。cl为ChangeLog首字母缩写,subsystemname请填写子系统英文标准名称,x表示变更序号(从低到高逐位增加,起始为1)。
以功能维度对变更点进行概括描述。例如:xxx功能的xxx、xxx等发生了xxx变化,开发者需要根据以下说明对应用进行适配。
如果有此变更有对应的需求或设计文档,可以在描述中附上对应的设计文档编号。
**变更影响**
是否影响已发布的接口或者接口行为发生变更,影响的是JS接口还是Native接口。
是否影响在此前版本已开发的应用,即应用是否需要进行适配动才可以在新版本SDK环境正常编译通过。
**关键的接口/组件变更**
列举此功能变更涉及的接口/组件变更。
**适配指导(可选,不涉及则可以删除)**
提供指导,帮助开发者针对相关变更进行适配,使应用可以与新版本兼容。
例:
在xxx文件中将xxx参数修改为xxx。
```
sample code
```
# xxx子系统ChangeLog
相比最近一个发布版本(包括不限于LTS、Release、Beta、monthly版本)发生了影响契约兼容性(契约兼容:也称语义兼容,指版本演进后,开发者原有程序行为不发生变化)的变更(包括不限于接口名、参数、返回值、所需要的权限、调用顺序、枚举值、配置参数、路径等),则需要在ChangeLog中对变更进行阐述。
## cl.subsystemname.x xxx功能变更, 例:DeviceType属性变更、相机权限变更(尽量概括,不要超过15个字)
每个变更标题前需要附加编号:cl.subsystemname.x。cl为ChangeLog首字母缩写,subsystemname请填写子系统英文标准名称,x表示变更序号(从低到高逐位增加,起始为1)。
以功能维度对变更点进行概括描述。例如:xxx功能的xxx、xxx等发生了xxx变化,开发者需要根据以下说明对应用进行适配。
如果有此变更有对应的需求或设计文档,可以在描述中附上对应的设计文档编号。
**变更影响**
是否影响已发布的接口或者接口行为发生变更,影响的是JS接口还是Native接口。
是否影响在此前版本已开发的应用,即应用是否需要进行适配动才可以在新版本SDK环境正常编译通过。
**关键的接口/组件变更**
列举此功能变更涉及的接口/组件变更。
**适配指导(可选,不涉及则可以删除)**
提供指导,帮助开发者针对相关变更进行适配,使应用可以与新版本兼容。
例:
在xxx文件中将xxx参数修改为xxx。
```
sample code
```
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册