Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
2e05b2d6
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看板
未验证
提交
2e05b2d6
编写于
10月 11, 2022
作者:
O
openharmony_ci
提交者:
Gitee
10月 11, 2022
浏览文件
操作
浏览文件
下载
差异文件
!10403 api异常处理的OS账号和分布式账号docs修改
Merge pull request !10403 from libing23/master
上级
545d1e6e
fec9804c
变更
2
展开全部
隐藏空白更改
内联
并排
Showing
2 changed file
with
1855 addition
and
354 deletion
+1855
-354
zh-cn/application-dev/reference/apis/js-apis-distributed-account.md
...ication-dev/reference/apis/js-apis-distributed-account.md
+147
-10
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
+1708
-344
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-distributed-account.md
浏览文件 @
2e05b2d6
...
...
@@ -36,11 +36,74 @@ getDistributedAccountAbility(): DistributedAccountAbility
提供查询和更新分布式帐号登录状态方法(需要先获取分布式帐号的单实例对象)。
### queryOsAccountDistributedInfo
### getOsAccountDistributedInfo<sup>9+</sup>
getOsAccountDistributedInfo(callback: AsyncCallback
<
DistributedInfo
>
): void
获取分布式帐号信息,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.OsAccount
**需要权限:**
ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS 或 ohos.permission.GET_DISTRIBUTED_ACCOUNTS 或 ohos.permission.DISTRIBUTED_DATASYNC。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
[DistributedInfo](#distributedinfo)
>
| 是 | 获取分布式帐号信息的回调。 |
**示例:**
```
js
const
accountAbility
=
account_distributedAccount
.
getDistributedAccountAbility
();
try
{
accountAbility
.
getOsAccountDistributedInfo
((
err
,
data
)
=>
{
console
.
log
(
"
getOsAccountDistributedInfo err:
"
+
JSON
.
stringify
(
err
));
console
.
log
(
'
Query account info name:
'
+
data
.
name
);
console
.
log
(
'
Query account info id:
'
+
data
.
id
);
});
}
catch
(
e
)
{
console
.
log
(
"
getOsAccountDistributedInfo exception:
"
+
JSON
.
stringify
(
e
));
}
```
### getOsAccountDistributedInfo<sup>9+</sup>
getOsAccountDistributedInfo(): Promise
<
DistributedInfo
>
获取分布式帐号信息,使用Promise方式异步返回结果。
**系统能力:**
SystemCapability.Account.OsAccount
**需要权限:**
ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS 或 ohos.permission.GET_DISTRIBUTED_ACCOUNTS 或 ohos.permission.DISTRIBUTED_DATASYNC。
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[DistributedInfo](#distributedinfo)
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
```
js
const
accountAbility
=
account_distributedAccount
.
getDistributedAccountAbility
();
try
{
accountAbility
.
getOsAccountDistributedInfo
().
then
((
data
)
=>
{
console
.
log
(
'
Query account info name:
'
+
data
.
name
);
console
.
log
(
'
Query account info id:
'
+
data
.
id
);
}).
catch
((
err
)
=>
{
console
.
log
(
"
getOsAccountDistributedInfo err:
"
+
JSON
.
stringify
(
err
));
});
}
catch
(
e
)
{
console
.
log
(
"
getOsAccountDistributedInfo exception:
"
+
JSON
.
stringify
(
e
));
}
```
### queryOsAccountDistributedInfo<sup>(deprecated)</sup>
queryOsAccountDistributedInfo(callback: AsyncCallback
<
DistributedInfo
>
): void
获取分布式帐号信息,使用callback回调异步返回结果。
> **说明:** 从API version 9开始废弃,建议使用[getOsAccountDistributedInfo](#getosaccountdistributedinfo9)
>
> 从 API version 7开始支持。
**系统能力:**
SystemCapability.Account.OsAccount
...
...
@@ -55,18 +118,21 @@ queryOsAccountDistributedInfo(callback: AsyncCallback<DistributedInfo>): v
**示例:**
```
js
const
accountAbility
=
account_distributedAccount
.
getDistributedAccountAbility
();
accountAbility
.
queryOsAccountDistributedInfo
((
err
,
data
)
=>
{
accountAbility
.
queryOsAccountDistributedInfo
((
err
,
data
)
=>
{
console
.
log
(
"
queryOsAccountDistributedInfo err:
"
+
JSON
.
stringify
(
err
));
console
.
log
(
'
Query account info name:
'
+
data
.
name
);
console
.
log
(
'
Query account info id:
'
+
data
.
id
);
});
```
### queryOsAccountDistributedInfo
### queryOsAccountDistributedInfo
<sup>(deprecated)</sup>
queryOsAccountDistributedInfo(): Promise
<
DistributedInfo
>
获取分布式帐号信息,使用Promise方式异步返回结果。
> **说明:** 从API version 9开始废弃,建议使用[getOsAccountDistributedInfo](#getosaccountdistributedinfo9-1)
>
> 从 API version 7开始支持。
**系统能力:**
SystemCapability.Account.OsAccount
...
...
@@ -81,7 +147,7 @@ queryOsAccountDistributedInfo(): Promise<DistributedInfo>
**示例:**
```
js
const
accountAbility
=
account_distributedAccount
.
getDistributedAccountAbility
();
accountAbility
.
queryOsAccountDistributedInfo
().
then
((
data
)
=>
{
accountAbility
.
queryOsAccountDistributedInfo
().
then
((
data
)
=>
{
console
.
log
(
'
Query account info name:
'
+
data
.
name
);
console
.
log
(
'
Query account info id:
'
+
data
.
id
);
}).
catch
((
err
)
=>
{
...
...
@@ -89,11 +155,80 @@ queryOsAccountDistributedInfo(): Promise<DistributedInfo>
});
```
### updateOsAccountDistributedInfo
### setOsAccountDistributedInfo<sup>9+</sup>
setOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallback
<
void
>
): void
更新分布式帐号信息,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.OsAccount
**需要权限:**
ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| accountInfo |
[
DistributedInfo
](
#distributedinfo
)
| 是 | 分布式帐号信息。 |
| callback | AsyncCallback
<
void
>
| 是 | 更新分布式帐号信息的回调。 |
**示例:**
```
js
const
accountAbility
=
account_distributedAccount
.
getDistributedAccountAbility
();
let
accountInfo
=
{
id
:
'
12345
'
,
name
:
'
ZhangSan
'
,
event
:
'
Ohos.account.event.LOGIN
'
};
try
{
accountAbility
.
setOsAccountDistributedInfo
(
accountInfo
,
(
err
)
=>
{
console
.
log
(
"
setOsAccountDistributedInfo err:
"
+
JSON
.
stringify
(
err
));
});
}
catch
(
e
)
{
console
.
log
(
"
setOsAccountDistributedInfo exception:
"
+
JSON
.
stringify
(
e
));
}
```
### setOsAccountDistributedInfo<sup>9+</sup>
setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise
<
void
>
更新分布式帐号信息,使用Promise方式异步返回结果。
**系统能力:**
SystemCapability.Account.OsAccount
**需要权限:**
ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| accountInfo |
[
DistributedInfo
](
#distributedinfo
)
| 是 | 分布式帐户信息。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
```
js
const
accountAbility
=
account_distributedAccount
.
getDistributedAccountAbility
();
let
accountInfo
=
{
id
:
'
12345
'
,
name
:
'
ZhangSan
'
,
event
:
'
Ohos.account.event.LOGIN
'
};
try
{
accountAbility
.
setOsAccountDistributedInfo
(
accountInfo
).
then
(()
=>
{
console
.
log
(
'
setOsAccountDistributedInfo Success
'
);
}).
catch
((
err
)
=>
{
console
.
log
(
"
setOsAccountDistributedInfo err:
"
+
JSON
.
stringify
(
err
));
});
}
catch
(
e
)
{
console
.
log
(
"
setOsAccountDistributedInfo exception:
"
+
JSON
.
stringify
(
e
));
}
```
### updateOsAccountDistributedInfo<sup>(deprecated)</sup>
updateOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallback
<
void
>
): void
更新分布式帐号信息,使用callback回调异步返回结果。
> **说明:** 从API version 9开始废弃,建议使用[setOsAccountDistributedInfo](#setosaccountdistributedinfo9)
>
> 从 API version 7开始支持。
**系统能力:**
SystemCapability.Account.OsAccount
...
...
@@ -110,17 +245,19 @@ updateOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCall
```
js
const
accountAbility
=
account_distributedAccount
.
getDistributedAccountAbility
();
let
accountInfo
=
{
id
:
'
12345
'
,
name
:
'
ZhangSan
'
,
event
:
'
Ohos.account.event.LOGIN
'
};
accountAbility
.
updateOsAccountDistributedInfo
(
accountInfo
,
(
err
)
=>
{
accountAbility
.
updateOsAccountDistributedInfo
(
accountInfo
,
(
err
)
=>
{
console
.
log
(
"
queryOsAccountDistributedInfo err:
"
+
JSON
.
stringify
(
err
));
});
```
### updateOsAccountDistributedInfo
### updateOsAccountDistributedInfo
<sup>(deprecated)</sup>
updateOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise
<
void
>
更新分布式帐号信息,使用Promise方式异步返回结果。
> **说明:** 从API version 9开始废弃,建议使用[setOsAccountDistributedInfo](#setosaccountdistributedinfo9-1)
>
> 从 API version 7开始支持。
**系统能力:**
SystemCapability.Account.OsAccount
**需要权限:**
ohos.permission.MANAGE_LOCAL_ACCOUNTS。
...
...
@@ -147,8 +284,6 @@ updateOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>
console
.
log
(
"
updateOsAccountDistributedInfo err:
"
+
JSON
.
stringify
(
err
));
});
```
## DistributedInfo
提供操作系统帐户的分布式信息。
...
...
@@ -160,4 +295,6 @@ updateOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise<void>
| name | string | 是 | 分布式帐号名称,非空字符串。 |
| id | string | 是 | 分布式帐号UID,非空字符串。 |
| event | string | 是 | 分布式帐号登录状态,包括登录、登出、Token失效和注销,分别对应以下字符串:
<br/>
-
Ohos.account.event.LOGIN
<br/>
-
Ohos.account.event.LOGOUT
<br/>
-
Ohos.account.event.TOKEN_INVALID
<br/>
-
Ohos.account.event.LOGOFF |
| nickname
<sup>
9+
</sup>
| string | 否 | 分布式帐号的昵称,非空字符串。 |
| avatar
<sup>
9+
</sup>
| string | 否 | 分布式帐号的头像,非空字符串。 |
| scalableData | object | 否 | 分布式帐号扩展信息,根据业务所需,以k-v形式传递定制化信息。
<br/>
说明:该参数是预留的可选项,目前查询和更新的方法实现中未使用。 |
zh-cn/application-dev/reference/apis/js-apis-osAccount.md
浏览文件 @
2e05b2d6
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录