Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
93e72b77
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看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
93e72b77
编写于
6月 07, 2022
作者:
O
openharmony_ci
提交者:
Gitee
6月 07, 2022
浏览文件
操作
浏览文件
下载
差异文件
!5039 【轻量级 PR】:update zh-cn/application-dev/reference/apis/js-apis-appAccount.md.
Merge pull request !5039 from 葛亚芳/N/A
上级
330175e4
23b3c1cc
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
369 addition
and
365 deletion
+369
-365
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
+369
-365
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
浏览文件 @
93e72b77
# 应用帐号管理
本模块不仅用于对应用帐号的添加、删除、查询、修改和授权,且提供帐号将数据写入磁盘和数据同步的能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
...
@@ -15,13 +17,14 @@ import account_appAccount from '@ohos.account.appAccount';
createAppAccountManager(): AppAccountManager
应用帐号管理:获取应用帐号模块
对象。
获取应用帐号模块的
对象。
**系统能力:**
SystemCapability.Account.AppAccount
**返回值:**
| 类型 | 说明 |
| ----------------- | ------------ |
| 类型 | 说明 |
| ----------------- | ------------------------ |
| AppAccountManager | 获取应用帐号模块的实例。 |
**示例:**
...
...
@@ -43,10 +46,10 @@ addAccount(name: string, callback: AsyncCallback<void>): void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | --------------------- |
| name | string | 是
| 要添加的应用帐户的名称。
|
| callback | AsyncCallback
<
void
>
| 是
| 将此应用的帐号名添加到帐号管理服务的
回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ---------------------
-------------------
|
| name | string | 是
| 要添加的应用帐号名称。
|
| callback | AsyncCallback
<
void
>
| 是
| 将此应用的帐号名添加到帐号管理服务
回调。 |
**示例:**
...
...
@@ -61,17 +64,17 @@ addAccount(name: string, callback: AsyncCallback<void>): void
addAccount(name: string, extraInfo: string, callback: AsyncCallback
<
void
>
): void
将此应用程序的帐号名和额外信息添加到帐号管理服务中,使用callback回调异步返回结果。
将此应用程序的帐号名和额外信息
(能转换string类型的其它信息,如token)
添加到帐号管理服务中,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------------------------- | ---- | ---------------------------------------- |
| name | string | 是
| 要添加的应用帐户的名称。
|
| extraInfo | string | 是
| 要添加的应用帐户的额外信息(例如token等),额外的信息不能是应用帐号的敏感信息
。 |
| callback | AsyncCallback
<
void
>
| 是
| 将此应用程序的帐号名和额外信息添加到帐号管理服务中的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------------------------- | ---- | ----------------------------------------
--------------------
|
| name | string | 是
| 要添加的应用帐号名称。
|
| extraInfo | string | 是
| 要添加的应用帐号的额外信息(能转换string类型的其它信息,如token等),额外信息不能是应用帐号的敏感信息(如应用账号密码)
。 |
| callback | AsyncCallback
<
void
>
| 是
| 将此应用程序的帐号名和额外信息添加到帐号管理服务中回调。
|
**示例:**
...
...
@@ -86,23 +89,23 @@ addAccount(name: string, extraInfo: string, callback: AsyncCallback<void>)
### addAccount
addAccount(name: string, extraInfo
?
: string): Promise
<
void
>
addAccount(name: string, extraInfo: string): Promise
<
void
>
将此应用的帐号名或额外信息添加到帐号管理服务中,使用Promise方式异步返回结果。
将此应用的帐号名或额外信息
(能转换成string类型的其它信息)
添加到帐号管理服务中,使用Promise方式异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | -------------------------------- |
| name | string | 是
| 要添加的应用帐户的名称。
|
| extraInfo | string | 是
| 要添加的应用帐户的额外信息,额外的信息不能是应用帐号的敏感信息
。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | --------------------------------
----------------------------
|
| name | string | 是
| 要添加的应用帐号名称。
|
| extraInfo | string | 是
| 要添加的应用帐号的额外信息(能转换成string类型的其它信息),额外信息不能是应用帐号的敏感信息(如应用账号密码)
。 |
**返回值:**
| 类型
| 说明
|
| ------------------- | --------------------- |
| 类型
| 说明
|
| ------------------- | ---------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -120,18 +123,18 @@ addAccount(name: string, extraInfo?: string): Promise<void>
addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
根据指定的帐号所有者、鉴权类型和可选项
,
隐式地添加应用帐号,并使用callback回调异步返回结果。
根据指定的帐号所有者、鉴权类型和可选项隐式地添加应用帐号,并使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | --------------- |
| owner | string | 是
| 要添加的应用帐户的所有者包名。
|
| authType | string | 是
| 要添加的应用帐户的鉴权类型。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是
| 认证器回调,用于返回鉴权结果。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | ---------------
-------------------------------
|
| owner | string | 是
| 要添加的应用帐号所有者包名。
|
| authType | string | 是
| 要添加的应用帐号鉴权类型。鉴权类型为自定义。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。可选项可根据自己需要设置。
|
| callback | AuthenticatorCallback | 是
| 认证器回调,用于返回鉴权结果。
|
**示例:**
...
...
@@ -167,10 +170,10 @@ deleteAccount(name: string, callback: AsyncCallback<void>): void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ----------------- |
| name | string | 是
| 要删除的应用帐户的名称。
|
| callback | AsyncCallback
<
void
>
| 是
| 帐号管理服务中删除应用帐号的
回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | -----------------
---------------
|
| name | string | 是
| 要删除的应用帐号名称。
|
| callback | AsyncCallback
<
void
>
| 是
| 帐号管理服务中删除应用帐号
回调。 |
**示例:**
...
...
@@ -191,14 +194,14 @@ deleteAccount(name: string): Promise<void>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- |
------------ |
| name
| string | 是 | 要删除的应用帐户的
名称。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
-- | ------ | ---- | ----------
------------ |
| name
| string | 是 | 要删除的应用帐号
名称。 |
**返回值:**
| 类型
| 说明
|
| :------------------ | :-------------------- |
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -216,17 +219,17 @@ deleteAccount(name: string): Promise<void>
disableAppAccess(name: string, bundleName: string, callback: AsyncCallback
<
void
>
): void
禁止指定第三方应用帐
户的名称访问指定包名称的第三方应用
,使用callback回调异步返回结果。
禁止指定第三方应用帐
号名称对指定的第三方应用进行访问
,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | ------------------------------- |
| name | string | 是
| 要禁用访问的第三方应用帐户的名称。
|
| bundleName | string | 是
| 第三方应用的包名。
|
| callback | AsyncCallback
<
void
>
| 是
| 禁止指定第三方应用帐户的名称访问指定包名称的第三方应用的回调
。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | -------------------------------
-----------------------------
|
| name | string | 是
| 要禁用访问的第三方应用帐号名称。
|
| bundleName | string | 是
| 第三方应用的包名。
|
| callback | AsyncCallback
<
void
>
| 是
| 禁止指定第三方应用帐号名称对指定包名称的第三方应用的回调进行访问
。 |
**示例:**
...
...
@@ -241,21 +244,21 @@ disableAppAccess(name: string, bundleName: string, callback: AsyncCallback<vo
disableAppAccess(name: string, bundleName: string): Promise
<
void
>
禁止指定第三方应用帐
户的名称访问指定包名称的第三方应用
,使用Promise方式异步返回结果。
禁止指定第三方应用帐
号名称对指定包名称的第三方应用进行访问
,使用Promise方式异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | ----------------- |
| name | string | 是
| 要禁用访问的第三方应用帐户的
名称。 |
| bundleName | string | 是
| 第三方应用的包名。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | -----------------
---------------
|
| name | string | 是
| 要禁用访问的第三方应用帐号
名称。 |
| bundleName | string | 是
| 第三方应用的包名。
|
**返回值:**
| 类型
| 说明
|
| :------------------ | :-------------------- |
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -273,17 +276,17 @@ disableAppAccess(name: string, bundleName: string): Promise<void>
enableAppAccess(name: string, bundleName: string, callback: AsyncCallback
<
void
>
): void
允许指定第三方应用帐
户的名称访问指定包名称的第三方应用
,使用callback回调异步返回结果。
允许指定第三方应用帐
号名称对指定包名称的第三方应用进行访问
,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | ------------------------------- |
| name | string | 是
| 应用帐号名称。
|
| bundleName | string | 是
| 第三方应用的包名。
|
| callback | AsyncCallback
<
void
>
| 是
| 允许指定第三方应用帐户的名称访问指定包名称的第三方应用的回调
。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | -------------------------------
-----------------------------
|
| name | string | 是
| 应用帐号名称。
|
| bundleName | string | 是
| 第三方应用的包名。
|
| callback | AsyncCallback
<
void
>
| 是
| 允许指定第三方应用帐号名称对指定包名称的第三方应用的回调进行访问
。 |
**示例:**
...
...
@@ -298,21 +301,21 @@ enableAppAccess(name: string, bundleName: string, callback: AsyncCallback<voi
enableAppAccess(name: string, bundleName: string): Promise
<
void
>
允许指定第三方应用帐
户的名称访问指定包名称的第三方应用
,使用Promise方式异步返回结果。
允许指定第三方应用帐
号的名称对指定包名称的第三方应用进行访问
,使用Promise方式异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | --------- |
| name | string | 是
| 应用帐号名称。
|
| bundleName | string | 是
| 第三方应用的包名。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | ---------
---------
|
| name | string | 是
| 应用帐号名称。
|
| bundleName | string | 是 | 第三方应用的包名。 |
**返回值:**
| 类型
| 说明
|
| :------------------ | :-------------------- |
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -337,10 +340,10 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>):
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ---------------------------- | ---- | ---------------------- |
| name | string | 是
| 应用帐号名称。
|
| callback | AsyncCallback
<
boolean
>
| 是
| 检查指定应用帐号是否允许应用数据同步的
回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ---------------------------- | ---- | ----------------------
--------------------
|
| name | string | 是
| 应用帐号名称。
|
| callback | AsyncCallback
<
boolean
>
| 是
| 检查指定应用帐号是否允许应用数据同步
回调。 |
**示例:**
...
...
@@ -364,14 +367,14 @@ checkAppAccountSyncEnable(name: string): Promise<boolean>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- |
------- |
| name
| string | 是
| 应用帐号名称。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
-- | ------ | ---- | -------
------- |
| name
| string | 是
| 应用帐号名称。 |
**返回值:**
| 类型
| 说明
|
| :--------------------- | :-------------------- |
| 类型
| 说明
|
| :--------------------- | :--------------------
--------------
|
| Promise
<
boolean
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -395,12 +398,12 @@ setAccountCredential(name: string, credentialType: string, credential: string,ca
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------------------------- | ---- | -------------- |
| name | string | 是
| 应用程序帐户的名称。
|
| credentialType | string | 是
| 要设置的凭据的类型。
|
| credential | string | 是
| 要设置的凭据。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置此应用帐号的凭据的
回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------------------------- | ---- | --------------
------------
|
| name | string | 是
| 应用程序帐号名称。
|
| credentialType | string | 是
| 要设置的凭据类型。
|
| credential | string | 是
| 要设置的凭据。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置此应用帐号的凭据
回调。 |
**示例:**
...
...
@@ -421,16 +424,16 @@ setAccountCredential(name: string, credentialType: string, credential: string):
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------ | ---- | ---------- |
| name | string | 是
| 应用帐户的名称。
|
| credentialType | string | 是
| 要设置的凭据的类型。 |
| credential | string | 是
| 要设置的凭据。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------ | ---- | ----------
----------
|
| name | string | 是
| 应用帐号的名称。
|
| credentialType | string | 是 | 要设置的凭据的类型。 |
| credential | string | 是
| 要设置的凭据。
|
**返回值:**
| 类型
| 说明
|
| :------------------ | :-------------------- |
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -454,11 +457,11 @@ setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback<
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------------------------- | ---- | ---------------- |
| name | string | 是
| 应用帐户的名称。
|
| extraInfo | string | 是
| 要设置的额外信息。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置此应用帐号的额外信息的
回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------------------------- | ---- | ----------------
--------------
|
| name | string | 是
| 应用帐号名称。
|
| extraInfo | string | 是
| 要设置的额外信息。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置此应用帐号的额外信息
回调。 |
**示例:**
...
...
@@ -479,15 +482,15 @@ setAccountExtraInfo(name: string, extraInfo: string): Promise<void>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | --------- |
| name | string | 是
| 应用帐户的名称。
|
| extraInfo | string | 是
| 要设置的额外信息。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | ---------
---------
|
| name | string | 是
| 应用帐号名称。
|
| extraInfo | string | 是 | 要设置的额外信息。 |
**返回值:**
| 类型
| 说明
|
| :------------------ | :-------------------- |
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -513,11 +516,11 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ------------------------- |
| name | string | 是
| 应用帐户的名称。
|
| isEnable | boolean | 是
| 是否允许应用数据同步。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置指定的应用帐号是否允许应用程序数据同步的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | -------------------------
-------------------------
|
| name | string | 是
| 应用帐号名称。
|
| isEnable | boolean | 是
| 是否允许应用数据同步。
|
| callback | AsyncCallback
<
void
>
| 是 | 设置指定的应用帐号是否允许应用程序数据同步的回调。 |
**示例:**
...
...
@@ -540,15 +543,15 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------- | ---- | ----------- |
| name | string | 是
| 应用帐户的名称。
|
| isEnable | boolean | 是
| 是否允许应用数据同步。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------- | ---- | -----------
-----------
|
| name | string | 是
| 应用帐号名称。
|
| isEnable | boolean | 是 | 是否允许应用数据同步。 |
**返回值:**
| 类型
| 说明
|
| :------------------ | :-------------------- |
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -572,12 +575,12 @@ setAssociatedData(name: string, key: string, value: string, callback: AsyncCallb
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ----------------- |
| name | string | 是
| 应用帐户的名称。
|
| key | string | 是
| 要设置的数据的键,密钥可以自定义。 |
| value | string | 是
| 要设置的数据的值。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置与此应用帐号关联的数据的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | -----------------
-----------------
|
| name | string | 是
| 应用帐号名称。
|
| key | string | 是 | 要设置的数据的键,密钥可以自定义。 |
| value | string | 是
| 要设置的数据的值。
|
| callback | AsyncCallback
<
void
>
| 是 | 设置与此应用帐号关联的数据的回调。 |
**示例:**
...
...
@@ -597,16 +600,16 @@ setAssociatedData(name: string, key: string, value: string): Promise<void>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----------------- |
| name
| string | 是 | 应用帐户的名称。
|
| key
| string | 是
| 要设置的数据的键,密钥可以自定义。 |
| value
| string | 是 | 要设置的数据的值。
|
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -----------------
----------------- |
| name
| string | 是 | 应用帐号名称。
|
| key
| string | 是
| 要设置的数据的键,密钥可以自定义。 |
| value
| string | 是 | 要设置的数据的值。
|
**返回值:**
| 类型
| 说明
|
| :------------------ | :-------------------- |
| 类型
| 说明
|
| :------------------ | :--------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -624,17 +627,17 @@ setAssociatedData(name: string, key: string, value: string): Promise<void>
getAccountCredential(name: string, credentialType: string, callback: AsyncCallback
<
string
>
): void
获取此应用帐号的凭据,使用callback回调异步返回结果。
获取此应用帐号的凭据
(如数字密码、人脸和PIN码等)
,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------- | ---- | -------------- |
| name | string | 是
| 应用帐号名称。
|
| credentialType | string | 是
| 要获取的凭据的类型。
|
| callback | AsyncCallback
<
string
>
| 是
| 获取此应用帐号的凭据的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | --------------------------- | ---- | --------------
--------------
|
| name | string | 是
| 应用帐号名称。
|
| credentialType | string | 是
| 获取此应用帐号的凭据的类型。
|
| callback | AsyncCallback
<
string
>
| 是 | 获取此应用帐号的凭据的回调。 |
**示例:**
...
...
@@ -656,15 +659,15 @@ getAccountCredential(name: string, credentialType: string): Promise<string>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------ | ---- | ---------- |
| name | string | 是
| 应用帐号名称。
|
| credentialType | string | 是
| 要获取的凭据的类型。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------------- | ------ | ---- | ----------
----------
|
| name | string | 是
| 应用帐号名称。
|
| credentialType | string | 是 | 要获取的凭据的类型。 |
**返回值:**
| 类型
| 说明
|
| :-------------------- | :-------------------- |
| 类型
| 说明
|
| :-------------------- | :--------------------
--------------
|
| Promise
<
string
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -682,16 +685,16 @@ getAccountCredential(name: string, credentialType: string): Promise<string>
getAccountExtraInfo(name: string, callback: AsyncCallback
<
string
>
): void
获取此应用帐号的额外信息,使用callback回调异步返回结果。
获取此应用帐号的额外信息
(能转换成string类型的其它信息)
,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ---------------- |
| name | string | 是
| 应用帐号名称。
|
| callback | AsyncCallback
<
string
>
| 是
| 获取此应用帐号的额外信息的
回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ----------------
--------------
|
| name | string | 是
| 应用帐号名称。
|
| callback | AsyncCallback
<
string
>
| 是
| 获取此应用帐号的额外信息
回调。 |
**示例:**
...
...
@@ -713,14 +716,14 @@ getAccountExtraInfo(name: string): Promise<string>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- |
------- |
| name
| string | 是
| 应用帐号名称。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
-- | ------ | ---- | -------
------- |
| name
| string | 是
| 应用帐号名称。 |
**返回值:**
| 类型
| 说明
|
| :-------------------- | :-------------------- |
| 类型
| 说明
|
| :-------------------- | :--------------------
--------------
|
| Promise
<
string
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -744,11 +747,11 @@ getAssociatedData(name: string, key: string, callback: AsyncCallback<string&g
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ----------------- |
| name | string | 是
| 应用帐号名称。
|
| key | string | 是
| 要获取的数据的key。
|
| callback | AsyncCallback
<
string
>
| 是
| 获取与此应用帐号关联的数据的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | -----------------
-----------------
|
| name | string | 是
| 应用帐号名称。
|
| key | string | 是
| 要获取的数据的键。
|
| callback | AsyncCallback
<
string
>
| 是 | 获取与此应用帐号关联的数据的回调。 |
**示例:**
...
...
@@ -770,15 +773,15 @@ getAssociatedData(name: string, key: string): Promise<string>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ----
| ------ | ---- |
----------- |
| name
| string | 是
| 应用帐号名称。 |
| key
| string | 是 | 要获取的数据的key
。 |
| 参数名
| 类型 | 必填 | 说明
|
| ----
-- | ------ | ---- | -------
----------- |
| name
| string | 是
| 应用帐号名称。 |
| key
| string | 是 | 要获取的数据的键
。 |
**返回值:**
| 类型
| 说明
|
| :-------------------- | :-------------------- |
| 类型
| 说明
|
| :-------------------- | :--------------------
--------------
|
| Promise
<
string
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -804,9 +807,9 @@ getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>&
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
-------- |
| callback | AsyncCallback
<
Array
<
AppAccountInfo
>>
| 是
| 应用帐号信息列表
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------- | ---- | ----------
-------- |
| callback | AsyncCallback
<
Array
<
AppAccountInfo
>>
| 是
| 应用帐号信息列表。
|
**示例:**
...
...
@@ -830,8 +833,8 @@ getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>>
**参数:**
| 类型 | 说明 |
| ----------------------------------------
|
--------------------- |
| 类型 | 说明
|
| ----------------------------------------
-- | --------------
--------------------- |
| Promise
<
Array
<
AppAccountInfo
>>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -857,10 +860,10 @@ getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
-------- |
| owner | string
| 是 | 应用包名称
|
| callback | AsyncCallback
<
Array
<
AppAccountInfo
>>
| 是
| 应用帐号信息列表
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------- | ---- | ----------
-------- |
| owner | string
| 是 | 应用包名称。
|
| callback | AsyncCallback
<
Array
<
AppAccountInfo
>>
| 是
| 应用帐号信息列表。
|
**示例:**
...
...
@@ -885,14 +888,14 @@ getAllAccounts(owner: string): Promise<Array<AppAccountInfo>>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----- |
| owner
| string | 是 | 应用包名称
|
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -------
----- |
| owner
| string | 是 | 应用包名称。
|
**参数:**
| 类型 | 说明 |
| ----------------------------------------
|
--------------------- |
| 类型 | 说明
|
| ----------------------------------------
-- | --------------
--------------------- |
| Promise
<
Array
<
AppAccountInfo
>>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -917,11 +920,11 @@ on(type: 'change', owners: Array<string>, callback: Callback<Array<A
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
------------------------------ |
| type | 'change'
| 是 | 关于帐户更改事件,当帐户所有者更新帐户
时,订阅者将收到通知。 |
| owners | Array
<
string
>
| 是 | 指示帐户的所有者。
|
| callback | Callback
<
Array
<
AppAccountInfo
>>
| 是
| 订阅指定帐号所有者的帐户变更事件的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
--- | ---- | ------------------------------
------------------------------ |
| type | 'change'
| 是 | 关于帐号更改事件,当帐号所有者更新帐号
时,订阅者将收到通知。 |
| owners | Array
<
string
>
| 是 | 指示帐号的所有者。
|
| callback | Callback
<
Array
<
AppAccountInfo
>>
| 是
| 订阅指定帐号所有者的帐号变更事件的回调。
|
**示例:**
...
...
@@ -948,10 +951,10 @@ off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | -------------------------------- | ---- | ------------ |
| type | 'change' | 是
| 关于帐户更改事件。
|
| callback | Callback
<Array
\<
AppAccountInfo
>
> | 否
| 取消订阅帐号事件的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | -------------------------------- | ---- | ------------
------------
|
| type | 'change' | 是
| 关于帐号更改事件。
|
| callback | Callback
<Array
\<
AppAccountInfo
>
> | 否 | 取消订阅帐号事件的回调。 |
**示例:**
...
...
@@ -975,19 +978,19 @@ off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void
authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void
鉴权应用帐户
以获取OAuth令牌,使用callback回调异步返回结果。
对应用帐户进行鉴权
以获取OAuth令牌,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | --------------- |
| name | string | 是
| 要鉴权的应用帐户的名称。
|
| owner | string | 是
| 要鉴权的应用帐户的所有者包名。
|
| authType | string | 是
| 鉴权类型。
|
| options | {[key: string]: any} | 是
| 鉴权所需的可选项。
|
| callback | AuthenticatorCallback | 是
| 认证器回调,用于返回鉴权结果。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------- | ---- | ---------------
---------------
|
| name | string | 是
| 要鉴权的应用帐号名称。
|
| owner | string | 是
| 要鉴权的应用帐号所有者包名。
|
| authType | string | 是
| 鉴权类型。
|
| options | {[key: string]: any} | 是
| 鉴权所需的可选项。
|
| callback | AuthenticatorCallback | 是 | 认证器回调,用于返回鉴权结果。 |
**示例:**
...
...
@@ -1017,18 +1020,18 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri
getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback
<
string
>
): void
获取指定应用帐
户
和鉴权类型的OAuth令牌,使用callback回调异步返回结果。
获取指定应用帐
号
和鉴权类型的OAuth令牌,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | ----------- |
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户
的所有者包名。 |
| authType | string | 是
| 鉴权类型。
|
| callback |
AsyncCallback
<
string
>
| 是 | 查询结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------------------------- | ---- | -----------
-----------
|
| name | string | 是
| 应用帐号的名称。
|
| owner | string | 是
| 应用帐号
的所有者包名。 |
| authType | string | 是
| 鉴权类型。
|
| callback |
AsyncCallback
<
string
>
| 是 | 查询结果的回调。
|
**示例:**
...
...
@@ -1050,16 +1053,16 @@ getOAuthToken(name: string, owner: string, authType: string): Promise<string&
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ----------- |
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户
的所有者包名。 |
| authType | string | 是
| 鉴权类型。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | -----------
-----------
|
| name | string | 是
| 应用帐号的名称。
|
| owner | string | 是
| 应用帐号
的所有者包名。 |
| authType | string | 是
| 鉴权类型。
|
**参数:**
| 类型
| 说明
|
| --------------------- | --------------------- |
| 类型
| 说明
|
| --------------------- | ---------------------
--------------
|
| Promise
<
string
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1077,18 +1080,18 @@ getOAuthToken(name: string, owner: string, authType: string): Promise<string&
setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback
<
void
>
): void
设置指定应用帐
户
和鉴权类型的OAuth令牌,使用callback回调异步返回结果。
设置指定应用帐
号
和鉴权类型的OAuth令牌,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | -------- |
| name | string | 是
| 应用帐户
的名称。 |
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| OAuth令牌。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置结果的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | --------
--------
|
| name | string | 是
| 应用帐号
的名称。 |
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| OAuth令牌。
|
| callback | AsyncCallback
<
void
>
| 是 | 设置结果的回调。 |
**示例:**
...
...
@@ -1109,16 +1112,16 @@ setOAuthToken(name: string, authType: string, token: string): Promise<void>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | -------- |
| name | string | 是
| 应用帐户
的名称。 |
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| OAuth令牌。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | --------
--------
|
| name | string | 是
| 应用帐号
的名称。 |
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| OAuth令牌。
|
**参数:**
| 类型
| 说明
|
| ------------------- | --------------------- |
| 类型
| 说明
|
| ------------------- | ---------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1142,13 +1145,13 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string, c
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ------------ |
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户的所有者包名。
|
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| 要删除的OAuth令牌。
|
| callback | AsyncCallback
<
void
>
| 是
| 删除结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------------------------- | ---- | ------------
----------
|
| name | string | 是
| 应用帐号的名称。
|
| owner | string | 是
| 应用帐号的所有者包名。
|
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| 要删除的OAuth令牌。
|
| callback | AsyncCallback
<
void
>
| 是
| 删除结果的回调。
|
**示例:**
...
...
@@ -1169,17 +1172,17 @@ deleteOAuthToken(name: string, owner: string, authType: string, token: string):
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ------------ |
| name | string | 是
| 应用帐户的名称。
|
| owner | string | 是
| 应用帐户的所有者包名。
|
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| 要删除的OAuth令牌。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | ------------
----------
|
| name | string | 是
| 应用帐号的名称。
|
| owner | string | 是
| 应用帐号的所有者包名。
|
| authType | string | 是
| 鉴权类型。
|
| token | string | 是
| 要删除的OAuth令牌。
|
**参数:**
| 类型
| 说明
|
| ------------------- | --------------------- |
| 类型
| 说明
|
| ------------------- | ---------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1203,13 +1206,13 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | ------------ |
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是
| 被设置可见性的应用包名。
|
| isVisible | boolean | 是
| 是否可见。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------------------------- | ---- | ------------
-----------------------------
|
| name | string | 是
| 应用帐号的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是
| 被设置可见性的应用包名。
|
| isVisible | boolean | 是
| 是否可见。当设置成true可见,false不可见。
|
| callback | AsyncCallback
<
void
>
| 是
| 设置结果的回调。
|
**示例:**
...
...
@@ -1230,17 +1233,17 @@ setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVi
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------- | ---- | ------------ |
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是
| 被设置可见性的应用包名。 |
| isVisible | boolean | 是
| 是否可见。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------- | ---- | ------------
------------
|
| name | string | 是
| 应用帐号的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是 | 被设置可见性的应用包名。 |
| isVisible | boolean | 是
| 是否可见。
|
**参数:**
| 类型
| 说明
|
| ------------------- | --------------------- |
| 类型
| 说明
|
| ------------------- | ---------------------
--------------
|
| Promise
<
void
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1264,12 +1267,12 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, ca
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ---------------------------- | ---- | ------------- |
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是
| 用于
检查可见性的应用包名。 |
| callback | AsyncCallback
<
boolean
>
| 是
| 检查结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ---------------------------- | ---- | -------------
---------
|
| name | string | 是
| 应用帐号的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是
|
检查可见性的应用包名。 |
| callback | AsyncCallback
<
boolean
>
| 是
| 检查结果的回调。
|
**示例:**
...
...
@@ -1291,16 +1294,16 @@ checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): P
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | ------------- |
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是
| 用于检查可见性的应用包名。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------- | ------ | ---- | -------------
-------------
|
| name | string | 是
| 应用帐号的名称。
|
| authType | string | 是
| 鉴权类型。
|
| bundleName | string | 是 | 用于检查可见性的应用包名。 |
**参数:**
| 类型
| 说明
|
| ---------------------- | --------------------- |
| 类型
| 说明
|
| ---------------------- | ---------------------
--------------
|
| Promise
<
boolean
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1324,13 +1327,13 @@ getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback<Array&
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
| ---- |
----------- |
| name | string
| 是 | 应用帐户的名称。
|
| owner | string
| 是 | 应用帐户
的所有者包名。 |
| callback | AsyncCallback
<
Array
<
OAuthTokenInfo
>>
| 是 | 查询结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ----------------------------------------
-------------------- | ---- | -----------
----------- |
| name | string
| 是 | 应用帐号的名称。
|
| owner | string
| 是 | 应用帐号
的所有者包名。 |
| callback | AsyncCallback
<
Array
<
[
OAuthTokenInfo
](
#oauthtokeninfo8
)
>>
| 是 | 查询结果的回调。
|
**示例:**
**示例:**
```
js
const
appAccountManager
=
account_appAccount
.
createAppAccountManager
();
...
...
@@ -1350,16 +1353,16 @@ getAllOAuthTokens(name: string, owner: string): Promise<Array<OAuthTokenIn
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----------- |
| name
| string | 是 | 应用帐户的名称。
|
| owner
| string | 是 | 应用帐户
的所有者包名。 |
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -----------
----------- |
| name
| string | 是 | 应用帐号的名称。
|
| owner
| string | 是 | 应用帐号
的所有者包名。 |
**参数:**
| 类型 | 说明 |
| ----------------------------------------
|
--------------------- |
| Promise
<
Array
<
OAuthTokenInfo
>>
| Promise实例,用于获取异步返回结果。 |
| 类型 | 说明
|
| ----------------------------------------
-- | --------------
--------------------- |
| Promise
<
Array
<
[
OAuthTokenInfo
](
#oauthtokeninfo8
)
>>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1382,11 +1385,11 @@ getOAuthList(name: string, authType: string, callback: AsyncCallback<Array<
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | ----------- |
| name | string | 是
| 应用帐户的名称。
|
|
owner | string | 是 | 应用帐户的所有者包名
。 |
| callback | AsyncCallback
<
Array
<
string
>>
| 是
| 查询结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ---------------------------------------- | ---- | -----------
------------------------------
|
| name | string | 是
| 应用帐号的名称。
|
|
authType | string | 是 | 应用帐号的鉴权类型的OAuth令牌的授权列表
。 |
| callback | AsyncCallback
<
Array
<
string
>>
| 是
| 查询结果的回调。
|
**示例:**
...
...
@@ -1408,15 +1411,15 @@ getOAuthList(name: string, authType: string): Promise<Array<string>>
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| -----
| ------ | ---- |
----------- |
| name
| string | 是 | 应用帐户的名称。
|
|
owner | string | 是 | 应用帐户的所有者包名
。 |
| 参数名 | 类型
| 必填 | 说明
|
| -----
--- | ------ | ---- | ------------------------------
----------- |
| name
| string | 是 | 应用帐号的名称。
|
|
authType | string | 是 | 应用帐号的鉴权类型的OAuth令牌的授权列表
。 |
**参数:**
| 类型
| 说明
|
| ---------------------------------- | --------------------- |
| 类型
| 说明
|
| ---------------------------------- | ---------------------
--------------
|
| Promise
<
Array
<
string
>>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1440,14 +1443,15 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback<Authentic
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ----------------------------------------
| ---- |
-------- |
| sessionId | string
| 是
| 鉴权会话的标识。 |
| callback | AsyncCallback
<
AuthenticatorCallback
>
| 是
| 查询结果的回调。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ----------------------------------------
-- | ---- | --------
-------- |
| sessionId | string
| 是
| 鉴权会话的标识。 |
| callback | AsyncCallback
<
AuthenticatorCallback
>
| 是 | 查询结果的回调。 |
**示例:**
```
js
import
featureAbility
from
'
@ohos.ability.featureAbility
'
;
const
appAccountManager
=
account_appAccount
.
createAppAccountManager
();
featureAbility
.
getWant
((
err
,
want
)
=>
{
var
sessionId
=
want
.
parameters
[
account_appAccount
.
Constants
.
KEY_SESSION_ID
];
...
...
@@ -1475,14 +1479,14 @@ getAuthenticatorCallback(sessionId: string): Promise<AuthenticatorCallback>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | -------- |
| sessionId | string | 是
| 鉴权会话的标识。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------- | ------ | ---- | --------
--------
|
| sessionId | string | 是 | 鉴权会话的标识。 |
**参数:**
| 类型
| 说明
|
| ------------------------------------ | --------------------- |
| 类型
| 说明
|
| ------------------------------------ | ---------------------
--------------
|
| Promise
<
AuthenticatorCallback
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1509,16 +1513,16 @@ getAuthenticatorCallback(sessionId: string): Promise<AuthenticatorCallback>
getAuthenticatorInfo(owner: string, callback: AsyncCallback
<
AuthenticatorInfo
>
): void
获取指定应用帐
户
的认证器信息,使用callback回调异步返回结果。
获取指定应用帐
号
的认证器信息,使用callback回调异步返回结果。
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | -------------------------------------- | ---- | ----------- |
| owner | string | 是
| 应用帐户
的所有者包名。 |
| callback | AsyncCallback
<
AuthenticatorInfo
>
| 是
| 查询结果的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | -------------------------------------- | ---- | -----------
-----------
|
| owner | string | 是
| 应用帐号
的所有者包名。 |
| callback | AsyncCallback
<
AuthenticatorInfo
>
| 是
| 查询结果的回调。
|
**示例:**
...
...
@@ -1540,14 +1544,14 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----------- |
| owner
| string | 是 | 应用帐户
的所有者包名。 |
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -----------
----------- |
| owner
| string | 是 | 应用帐号
的所有者包名。 |
**参数:**
| 类型
| 说明
|
| -------------------------------- | --------------------- |
| 类型
| 说明
|
| -------------------------------- | ---------------------
--------------
|
| Promise
<
AuthenticatorInfo
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1567,10 +1571,10 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ------ | ---- |
----------- |
| owner
| string | 是 | 应用帐户
的所有者包名。 |
| name
| string | 是 | 应用帐户的名称。
|
| 参数名
| 类型 | 必填 | 说明
|
| -----
- | ------ | ---- | -----------
----------- |
| owner
| string | 是 | 应用帐号
的所有者包名。 |
| name
| string | 是 | 应用帐号的名称。
|
## OAuthTokenInfo<sup>8+</sup>
...
...
@@ -1578,10 +1582,10 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | -------- |
| authType | string | 是
| 令牌的鉴权类型。 |
| token | string | 是
| 令牌的取值。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | ------ | ---- | --------
--------
|
| authType | string | 是 | 令牌的鉴权类型。 |
| token | string | 是
| 令牌的取值。
|
## AuthenticatorInfo<sup>8+</sup>
...
...
@@ -1589,11 +1593,11 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 参数名
| 类型 | 必填 | 说明
|
| ------- | ------ | ---- | ---------- |
| owner | string | 是
| 认证器的所有者包名。 |
| iconId | string | 是
| 认证器的图标标识。
|
| labelId | string | 是
| 认证器的标签标识。
|
| 参数名
| 类型 | 必填 | 说明
|
| ------- | ------ | ---- | ----------
----------
|
| owner | string | 是 | 认证器的所有者包名。 |
| iconId | string | 是
| 认证器的图标标识。
|
| labelId | string | 是
| 认证器的标签标识。
|
## Constants<sup>8+</sup>
...
...
@@ -1601,19 +1605,19 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 名称
| 默认值 | 描述
|
| ----------------------------- | ---------------------- | ------------- |
| ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作
_隐式添加帐号。
|
| ACTION_AUTHENTICATE | "authenticate" | 表示操作
_鉴权。
|
| KEY_NAME | "name" | 表示键名
_应用帐户名称。
|
| KEY_OWNER | "owner" | 表示键名
_应用帐户
所有者。 |
| KEY_TOKEN | "token" | 表示键名
_令牌。
|
| KEY_ACTION | "action" | 表示键名
_操作。
|
| KEY_AUTH_TYPE | "authType" | 表示键名
_鉴权类型。
|
| KEY_SESSION_ID | "sessionId" | 表示键名
_会话标识。
|
| KEY_CALLER_PID | "callerPid" | 表示键名
_调用方PID。
|
| KEY_CALLER_UID | "callerUid" | 表示键名
_调用方UID。
|
| KEY_CALLER_BUNDLE_NAME | "callerBundleName" | 表示键名
_调用方包名。
|
| 名称
| 默认值 | 说明
|
| ----------------------------- | ---------------------- | -------------
-------------
|
| ACTION_ADD_ACCOUNT_IMPLICITLY | "addAccountImplicitly" | 表示操作
,隐式添加帐号。
|
| ACTION_AUTHENTICATE | "authenticate" | 表示操作
,鉴权。
|
| KEY_NAME | "name" | 表示键名
,应用帐号名称。
|
| KEY_OWNER | "owner" | 表示键名
,应用帐号
所有者。 |
| KEY_TOKEN | "token" | 表示键名
,令牌。
|
| KEY_ACTION | "action" | 表示键名
,操作。
|
| KEY_AUTH_TYPE | "authType" | 表示键名
,鉴权类型。
|
| KEY_SESSION_ID | "sessionId" | 表示键名
,会话标识。
|
| KEY_CALLER_PID | "callerPid" | 表示键名
,调用方PID。
|
| KEY_CALLER_UID | "callerUid" | 表示键名
,调用方UID。
|
| KEY_CALLER_BUNDLE_NAME | "callerBundleName" | 表示键名
,调用方包名。
|
## ResultCode<sup>8+</sup>
...
...
@@ -1621,27 +1625,27 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Account.AppAccount。
| 名称
| 默认值 | 描述
|
| ----------------------------------- | -----
|
------------ |
| SUCCESS | 0
| 表示操作成功。
|
| ERROR_ACCOUNT_NOT_EXIST | 10001
| 表示应用帐户不存在。
|
| ERROR_APP_ACCOUNT_SERVICE_EXCEPTION | 10002
| 表示应用帐户服务异常。
|
| ERROR_INVALID_PASSWORD | 10003
| 表示密码无效。
|
| ERROR_INVALID_REQUEST | 10004
| 表示请求无效。
|
| ERROR_INVALID_RESPONSE | 10005
| 表示响应无效。
|
| ERROR_NETWORK_EXCEPTION | 10006
| 表示网络异常。
|
| ERROR_OAUTH_AUTHENTICATOR_NOT_EXIST | 10007
| 表示认证器不存在。
|
| ERROR_OAUTH_CANCELED | 10008
| 表示鉴权取消。
|
| ERROR_OAUTH_LIST_TOO_LARGE | 10009
| 表示开放授权列表过大。
|
| ERROR_OAUTH_SERVICE_BUSY | 10010
| 表示开放授权服务忙碌。
|
| ERROR_OAUTH_SERVICE_EXCEPTION | 10011
| 表示开放授权服务异常。
|
| ERROR_OAUTH_SESSION_NOT_EXIST | 10012
| 表示鉴权会话不存在。
|
| ERROR_OAUTH_TIMEOUT | 10013
| 表示鉴权超时。
|
| ERROR_OAUTH_TOKEN_NOT_EXIST | 10014 | 表示开放授权令牌不存在。 |
| ERROR_OAUTH_TOKEN_TOO_MANY | 10015
| 表示开放授权令牌过多。
|
| ERROR_OAUTH_UNSUPPORT_ACTION | 10016
| 表示不支持的鉴权操作。
|
| ERROR_OAUTH_UNSUPPORT_AUTH_TYPE | 10017
| 表示不支持的鉴权类型。
|
| ERROR_PERMISSION_DENIED | 10018
| 表示权限不足。
|
| 名称
| 默认值 | 说明
|
| ----------------------------------- | -----
- | ------------
------------ |
| SUCCESS | 0
| 表示操作成功。
|
| ERROR_ACCOUNT_NOT_EXIST | 10001
| 表示应用帐号不存在。
|
| ERROR_APP_ACCOUNT_SERVICE_EXCEPTION | 10002
| 表示应用帐号服务异常。
|
| ERROR_INVALID_PASSWORD | 10003
| 表示密码无效。
|
| ERROR_INVALID_REQUEST | 10004
| 表示请求无效。
|
| ERROR_INVALID_RESPONSE | 10005
| 表示响应无效。
|
| ERROR_NETWORK_EXCEPTION | 10006
| 表示网络异常。
|
| ERROR_OAUTH_AUTHENTICATOR_NOT_EXIST | 10007
| 表示认证器不存在。
|
| ERROR_OAUTH_CANCELED | 10008
| 表示鉴权取消。
|
| ERROR_OAUTH_LIST_TOO_LARGE | 10009
| 表示开放授权列表过大。
|
| ERROR_OAUTH_SERVICE_BUSY | 10010
| 表示开放授权服务忙碌。
|
| ERROR_OAUTH_SERVICE_EXCEPTION | 10011
| 表示开放授权服务异常。
|
| ERROR_OAUTH_SESSION_NOT_EXIST | 10012
| 表示鉴权会话不存在。
|
| ERROR_OAUTH_TIMEOUT | 10013
| 表示鉴权超时。
|
| ERROR_OAUTH_TOKEN_NOT_EXIST | 10014
| 表示开放授权令牌不存在。 |
| ERROR_OAUTH_TOKEN_TOO_MANY | 10015
| 表示开放授权令牌过多。
|
| ERROR_OAUTH_UNSUPPORT_ACTION | 10016
| 表示不支持的鉴权操作。
|
| ERROR_OAUTH_UNSUPPORT_AUTH_TYPE | 10017
| 表示不支持的鉴权类型。
|
| ERROR_PERMISSION_DENIED | 10018
| 表示权限不足。
|
## AuthenticatorCallback<sup>8+</sup>
...
...
@@ -1656,10 +1660,10 @@ onResult: (code: number, result: {[key: string]: any}) => void
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ------ | -------------------- | ---- | ------ |
| code | number | 是
| 鉴权结果码。 |
| result | {[key: string]: any} | 是
| 鉴权结果。
|
| 参数名
| 类型 | 必填 | 说明
|
| ------ | -------------------- | ---- | ------
------
|
| code | number | 是 | 鉴权结果码。 |
| result | {[key: string]: any} | 是
| 鉴权结果。
|
**示例:**
...
...
@@ -1686,9 +1690,9 @@ onRequestRedirected: (request: Want) => void
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ------- | ---- | ---- | ---------- |
| request | Want | 是
| 用于跳转的请求信息。 |
| 参数名
| 类型 | 必填 | 说明
|
| ------- | ---- | ---- | ----------
----------
|
| request | Want | 是 | 用于跳转的请求信息。 |
**示例:**
...
...
@@ -1723,12 +1727,12 @@ addAccountImplicitly(authType: string, callerBundleName: string, options: {[key:
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------------- | --------------------- | ---- | --------------- |
| authType | string | 是
| 应用帐户的鉴权类型。
|
| callerBundleName | string | 是
| 鉴权请求方的包名。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是
| 认证器回调,用于返回鉴权结果。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------------- | --------------------- | ---- | ---------------
---------------
|
| authType | string | 是
| 应用帐号的鉴权类型。
|
| callerBundleName | string | 是
| 鉴权请求方的包名。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是 | 认证器回调,用于返回鉴权结果。 |
### authenticate<sup>8+</sup>
...
...
@@ -1739,13 +1743,13 @@ authenticate(name: string, authType: string, callerBundleName: string, options:
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 接口名
| 类型 | 必填 | 说明
|
| ---------------- | --------------------- | ---- | --------------- |
| name | string | 是
| 应用帐户的名称。
|
| authType | string | 是
| 应用帐户的鉴权类型。
|
| callerBundleName | string | 是
| 鉴权请求方的包名。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是
| 认证器回调,用于返回鉴权结果。 |
| 接口名
| 类型 | 必填 | 说明
|
| ---------------- | --------------------- | ---- | ---------------
---------------
|
| name | string | 是
| 应用帐号的名称。
|
| authType | string | 是
| 应用帐号的鉴权类型。
|
| callerBundleName | string | 是
| 鉴权请求方的包名。
|
| options | {[key: string]: any} | 是
| 鉴权所需要的可选项。
|
| callback | AuthenticatorCallback | 是 | 认证器回调,用于返回鉴权结果。 |
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录