Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
5f076246
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看板
提交
5f076246
编写于
6月 29, 2022
作者:
L
lichenchen
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
应用账号新增接口docs资料修改
Signed-off-by:
N
lichenchen
<
lichenchen15@huawei.com
>
上级
a7bc82f3
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
46 addition
and
45 deletion
+46
-45
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
+46
-45
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-appAccount.md
浏览文件 @
5f076246
...
...
@@ -134,7 +134,7 @@ addAccountImplicitly(owner: string, authType: string, options: {[key: string]: a
| owner | string | 是 | 要添加的应用帐号所有者包名。 |
| authType | string | 是 | 要添加的应用帐号鉴权类型。鉴权类型为自定义。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。可选项可根据自己需要设置。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,用于返回鉴权结果。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,用于返回鉴权结果。 |
**示例:**
...
...
@@ -809,7 +809,7 @@ getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>&
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| callback | AsyncCallback
<
Array
<
AppAccountInfo
>>
| 是 | 应用帐号信息列表。 |
| callback | AsyncCallback
<
Array
<
[AppAccountInfo](#appaccountinfo)
>>
| 是 | 应用帐号信息列表。 |
**示例:**
...
...
@@ -835,7 +835,7 @@ getAllAccessibleAccounts(): Promise<Array<AppAccountInfo>>
| 类型 | 说明 |
| ---------------------------------------- | --------------------- |
| Promise
<
Array
<
AppAccountInfo
>>
| Promise实例,用于获取异步返回结果。 |
| Promise
<
Array
<
[AppAccountInfo](#appaccountinfo)
>>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -863,7 +863,7 @@ getAllAccounts(owner: string, callback: AsyncCallback<Array<AppAccountInfo
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | --------- |
| owner | string | 是 | 应用包名称。 |
| callback | AsyncCallback
<
Array
<
AppAccountInfo
>>
| 是 | 应用帐号信息列表。 |
| callback | AsyncCallback
<
Array
<
[AppAccountInfo](#appaccountinfo)
>>
| 是 | 应用帐号信息列表。 |
**示例:**
...
...
@@ -896,7 +896,7 @@ getAllAccounts(owner: string): Promise<Array<AppAccountInfo>>
| 类型 | 说明 |
| ---------------------------------------- | --------------------- |
| Promise
<
Array
<
AppAccountInfo
>>
| Promise实例,用于获取异步返回结果。 |
| Promise
<
Array
<
[AppAccountInfo](#appaccountinfo)
>>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -924,7 +924,7 @@ on(type: 'change', owners: Array<string>, callback: Callback<Array<A
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | 'change' | 是 | 关于帐号更改事件,当帐号所有者更新帐号时,订阅者将收到通知。 |
| owners | Array
<
string
>
| 是 | 指示帐号的所有者。 |
| callback | Callback
<
Array
<
AppAccountInfo
>>
| 是 | 订阅指定帐号所有者的帐号变更事件的回调。 |
| callback | Callback
<
Array
<
[AppAccountInfo](#appaccountinfo)
>>
| 是 | 订阅指定帐号所有者的帐号变更事件的回调。 |
**示例:**
...
...
@@ -954,7 +954,7 @@ off(type: 'change', callback?: Callback<Array\<AppAccountInfo>>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | ---- | ------------ |
| type | 'change' | 是 | 关于帐号更改事件。 |
| callback | Callback
<Array
\<
AppAccountInfo
>
> | 否 | 取消订阅帐号事件的回调。 |
| callback | Callback
<Array
\<
[
AppAccountInfo
](
#appaccountinfo
)
>
> | 否 | 取消订阅帐号事件的回调。 |
**示例:**
...
...
@@ -990,7 +990,7 @@ authenticate(name: string, owner: string, authType: string, options: {[key: stri
| owner | string | 是 | 要鉴权的应用帐号所有者包名。 |
| authType | string | 是 | 鉴权类型。 |
| options | {[key: string]: any} | 是 | 鉴权所需的可选项。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,用于返回鉴权结果。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,用于返回鉴权结果。 |
**示例:**
...
...
@@ -1446,7 +1446,7 @@ getAuthenticatorCallback(sessionId: string, callback: AsyncCallback<Authentic
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------- |
| sessionId | string | 是 | 鉴权会话的标识。 |
| callback | AsyncCallback
<
AuthenticatorCallback
>
| 是 | 查询结果的回调。 |
| callback | AsyncCallback
<
[AuthenticatorCallback](#authenticatorcallback8)
>
| 是 | 查询结果的回调。 |
**示例:**
...
...
@@ -1487,7 +1487,7 @@ getAuthenticatorCallback(sessionId: string): Promise<AuthenticatorCallback>
| 类型 | 说明 |
| ------------------------------------ | --------------------- |
| Promise
<
AuthenticatorCallback
>
| Promise实例,用于获取异步返回结果。 |
| Promise
<
[AuthenticatorCallback](#authenticatorcallback8)
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1522,7 +1522,7 @@ getAuthenticatorInfo(owner: string, callback: AsyncCallback<AuthenticatorInfo
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ----------- |
| owner | string | 是 | 应用帐号的所有者包名。 |
| callback | AsyncCallback
<
AuthenticatorInfo
>
| 是 | 查询结果的回调。 |
| callback | AsyncCallback
<
[AuthenticatorInfo](#authenticatorinfo8)
>
| 是 | 查询结果的回调。 |
**示例:**
...
...
@@ -1552,7 +1552,7 @@ getAuthenticatorInfo(owner: string): Promise<AuthenticatorInfo>
| 类型 | 说明 |
| -------------------------------- | --------------------- |
| Promise
<
AuthenticatorInfo
>
| Promise实例,用于获取异步返回结果。 |
| Promise
<
[AuthenticatorInfo](#authenticatorinfo8)
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1695,7 +1695,7 @@ checkAccountLabels(name: string, owner: string, labels: Array<string>, cal
| -------------- | ------------------------- | ----- | --------------- |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者。|
| labels | Array
<
string
&
l
t;
| 是 | 标签数组。 |
| labels | Array
<
string
&
g
t;
| 是 | 标签数组。 |
| callback | AsyncCallback
<
void
>
| 是 | 检查结果的回调。 |
**示例:**
...
...
@@ -1722,7 +1722,7 @@ checkAccountLabels(name: string, owner: string, labels: Array<string>): Pr
| -------------- | ------------------------- | ----- | --------------- |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者。|
| labels | Array
<
string
&
l
t;
| 是 | 标签数组。 |
| labels | Array
<
string
&
g
t;
| 是 | 标签数组。 |
**参数:**
...
...
@@ -1754,7 +1754,7 @@ selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback&
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | ----- | --------------- |
| options | SelectAccountsOptions | 是 | 选择帐户的选项。 |
| callback | AsyncCallback
<
AppAccountInfo
>
| 是 | 选择结果的回调。 |
| callback | AsyncCallback
<
[AppAccountInfo](#appaccountinfo)
>
| 是 | 选择结果的回调。 |
**示例:**
...
...
@@ -1781,13 +1781,13 @@ selectAccountsByOptions(options: SelectAccountsOptions): Promise<void>
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------- | ----- | --------------- |
| options |
SelectAccountsOptions
| 是 | 选择帐户的选项。 |
| options |
[
SelectAccountsOptions
](
#selectaccountsoptions9
)
| 是 | 选择帐户的选项。 |
**参数:**
| 类型 | 说明 |
| ------------------- | -------------------------------- |
| Promise
<
AppAccountInfo
>
| Promise实例,用于获取异步返回结果。 |
| Promise
<
[AppAccountInfo](#appaccountinfo)
>
| Promise实例,用于获取异步返回结果。 |
**示例:**
...
...
@@ -1817,7 +1817,7 @@ verifyCredential(name: string, owner: string, callback: AuthenticatorCallback):
| -------- | --------------------- | ----- | ----------------------- |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,返回验证结果。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,返回验证结果。 |
**示例:**
...
...
@@ -1848,8 +1848,8 @@ verifyCredential(name: string, owner: string, options, callback: AuthenticatorCa
| -------- | ----------------------- | ----- | ----------------------- |
| name | string | 是 | 应用帐户的名称。 |
| owner | string | 是 | 应用帐户的所有者。 |
| options |
VerifyCredentialOptions
| 是 | 验证凭据的选项。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,返回验证结果。 |
| options |
[
VerifyCredentialOptions
](
#verifycredentialoptions9
)
| 是 | 验证凭据的选项。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,返回验证结果。 |
**示例:**
...
...
@@ -1883,8 +1883,8 @@ setAuthenticatorProperties(owner: string, callback: AuthenticatorCallback): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ----- | ----------------------- |
| owner | string | 是 | 认证器的所有者。 |
| options |
SetPropertiesOptions
| 是 | 设置属性的选项。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,返回设置结果。 |
| options |
[
SetPropertiesOptions
](
#setpropertiesoptions9
)
| 是 | 设置属性的选项。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,返回设置结果。 |
**示例:**
...
...
@@ -1914,8 +1914,8 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ----- | ----------------------- |
| owner | string | 是 | 认证器的所有者。 |
| options |
SetPropertiesOptions
| 是 | 设置属性的选项。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,返回设置结果。 |
| options |
[
SetPropertiesOptions
](
#setpropertiesoptions9
)
| 是 | 设置属性的选项。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,返回设置结果。 |
**示例:**
...
...
@@ -1977,7 +1977,7 @@ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callbac
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | --------------------------- | ----- | ------------------- |
| allowedAccounts | Array
<
AppAccountInfo
>
| 否 | 允许的帐号数组。 |
| allowedAccounts | Array
<
[AppAccountInfo](#appAccountinfo)
>
| 否 | 允许的帐号数组。 |
| allowedOwners | Array
<
string
>
| 否 | 允许的帐号所有者数组。 |
| requiredLabels | Array
<
string
>
| 否 | 认证器的标签标识。 |
...
...
@@ -2160,7 +2160,7 @@ addAccountImplicitly(authType: string, callerBundleName: string, options: {[key:
| authType | string | 是 | 应用帐号的鉴权类型。 |
| callerBundleName | string | 是 | 鉴权请求方的包名。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,用于返回鉴权结果。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,用于返回鉴权结果。 |
### authenticate<sup>8+</sup>
...
...
@@ -2177,7 +2177,7 @@ authenticate(name: string, authType: string, callerBundleName: string, options:
| authType | string | 是 | 应用帐号的鉴权类型。 |
| callerBundleName | string | 是 | 鉴权请求方的包名。 |
| options | {[key: string]: any} | 是 | 鉴权所需要的可选项。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,用于返回鉴权结果。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,用于返回鉴权结果。 |
### verifyCredential<sup>9+</sup>
...
...
@@ -2188,11 +2188,11 @@ verifyCredential(name: string, options: VerifyCredentialOptions, callback: Authe
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 接口名
| 类型 | 必填 | 说明
|
| ---------
| ------------------------ | -- -- | ------------
--------------- |
| 接口名
| 类型 | 必填 | 说明
|
| ---------
------- | --------------------- | ---- |
--------------- |
| name | string | 是 | 应用帐号的名称。 |
| options |
VerifyCredentialOptions
| 是 | 验证凭据的可选项。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,用于返回验证结果。 |
| options |
[
VerifyCredentialOptions
](
#verifycredentialoptions9
)
| 是 | 验证凭据的可选项。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,用于返回验证结果。 |
### setProperties<sup>9+</sup>
...
...
@@ -2203,10 +2203,10 @@ setProperties(options: SetPropertiesOptions, callback: AuthenticatorCallback): v
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 接口名
| 类型 | 必填 | 说明
|
| ---------
| --------------------- | -- -- | ------------
--------------- |
| options |
SetPropertiesOptions
| 是 | 设置属性的可选项。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,用于返回设置结果。 |
| 接口名
| 类型 | 必填 | 说明
|
| ---------
------- | --------------------- | ---- |
--------------- |
| options |
[
SetPropertiesOptions
](
#setpropertiesoptions9
)
| 是 | 设置属性的可选项。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,用于返回设置结果。 |
### checkAccountLabels<sup>9+</sup>
...
...
@@ -2217,11 +2217,11 @@ checkAccountLabels(name: string, labels: Array<string>, callback: Authenti
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 接口名
| 类型 | 必填 | 说明
|
| ---------
| --------------------- | -- -- | ------------
--------------- |
| 接口名
| 类型 | 必填 | 说明
|
| ---------
------- | --------------------- | ---- |
--------------- |
| name | string | 是 | 应用帐号的名称。 |
| labels | Array
<string>
| 是 | 标签数组。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,用于返回检查结果。 |
| labels | Array
<
string
>
| 是 | 标签数组。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,用于返回检查结果。 |
### isAccountRemovable<sup>9+</sup>
...
...
@@ -2232,10 +2232,10 @@ isAccountRemovable(name: string, callback: AuthenticatorCallback): void;
**系统能力:**
SystemCapability.Account.AppAccount
**参数:**
| 接口名
| 类型 | 必填 | 说明
|
| ---------
| --------------------- | -- -- | ------------
--------------- |
| 接口名
| 类型 | 必填 | 说明
|
| ---------
------- | --------------------- | ---- |
--------------- |
| name | string | 是 | 应用帐号的名称。 |
| callback |
AuthenticatorCallback
| 是 | 认证器回调,用于返回判断结果。 |
| callback |
[
AuthenticatorCallback
](
#authenticatorcallback8
)
| 是 | 认证器回调,用于返回判断结果。 |
### getRemoteObject<sup>9+</sup>
...
...
@@ -2277,7 +2277,7 @@ getRemoteObject(): rpc.RemoteObject;
callback
.
onResult
(
account_appAccount
.
ResultCode
.
SUCCESS
,
{});
}
checkAccountLabels
(
name
:
string
,
labels
:
Array
&
lt
;
string
&
gt
;
,
callback
:
AuthenticatorCallback
)
{
checkAccountLabels
(
name
:
string
,
labels
:
Array
<
string
>
,
callback
:
AuthenticatorCallback
)
{
var
result
=
{[
account_appAccount
.
Constants
.
KEY_BOOLEAN_RESULT
]:
false
};
callback
.
onResult
(
account_appAccount
.
ResultCode
.
SUCCESS
,
result
);
}
...
...
@@ -2287,10 +2287,11 @@ getRemoteObject(): rpc.RemoteObject;
callback
.
onResult
(
account_appAccount
.
ResultCode
.
SUCCESS
,
result
);
}
}
var
authenticator
=
null
;
export
default
{
onConnect
(
want
)
{
return
new
MyAuthenticator
();
authenticator
=
new
MyAuthenticator
();
return
authenticator
.
getRemoteObject
();
}
}
```
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录