Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
37c7b1ee
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,发现更多精彩内容 >>
未验证
提交
37c7b1ee
编写于
3月 22, 2023
作者:
O
openharmony_ci
提交者:
Gitee
3月 22, 2023
浏览文件
操作
浏览文件
下载
差异文件
!16411 modify huks doc describe problem
Merge pull request !16411 from zengbenchong/cherry-pick-1679478866
上级
49225ec0
09201993
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
39 addition
and
39 deletion
+39
-39
zh-cn/application-dev/reference/apis/js-apis-huks.md
zh-cn/application-dev/reference/apis/js-apis-huks.md
+39
-39
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-huks.md
浏览文件 @
37c7b1ee
...
...
@@ -926,7 +926,7 @@ exportKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback\<H
| -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ |
| keyAlias | string | 是 | 密钥别名,应与所用密钥生成时使用的别名相同。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 | 空对象(此处传空即可)。 |
| callback | AsyncCallback
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| 是 | 回调函数。
返回HUKS_SUCCESS
时表示接口使用成功,其他时为错误。outData:返回从密钥中导出的公钥。 |
| callback | AsyncCallback
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| 是 | 回调函数。
不返回err值
时表示接口使用成功,其他时为错误。outData:返回从密钥中导出的公钥。 |
**示例:**
...
...
@@ -1005,7 +1005,7 @@ getKeyItemProperties(keyAlias: string, options: HuksOptions, callback: AsyncCall
| -------- | ---------------------------------------------------- | ---- | ------------------------------------------------------------ |
| keyAlias | string | 是 | 密钥别名,应与所用密钥生成时使用的别名相同。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 | 空对象(此处传空即可)。 |
| callback | AsyncCallback
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| 是 | 回调函数。
errorCode:返回HUKS_SUCCESS时表示接口使用成功,其他时为错误
。 |
| callback | AsyncCallback
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| 是 | 回调函数。
不返回err值时表示接口使用成功,其他时为错误。properties:返回值为生成密钥时所需参数
。 |
**示例:**
...
...
@@ -1161,9 +1161,9 @@ initSession操作密钥接口,使用Callback回调异步返回结果。huks.in
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------- | ---- | ---------------------------------------------------- |
| keyAlias | string | 是 |
Init
操作密钥的别名。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
Init
操作的参数集合。 |
| callback | AsyncCallback
\<
[
HuksSessionHandle
](
#hukssessionhandle9
)
> | 是 | 回调函数。将
Init操作
操作返回的handle添加到密钥管理系统的回调。 |
| keyAlias | string | 是 |
initSession
操作密钥的别名。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
initSession
操作的参数集合。 |
| callback | AsyncCallback
\<
[
HuksSessionHandle
](
#hukssessionhandle9
)
> | 是 | 回调函数。将
initSession
操作返回的handle添加到密钥管理系统的回调。 |
## huks.initSession<sup>9+</sup>
...
...
@@ -1177,14 +1177,14 @@ initSession操作密钥接口,使用Promise方式异步返回结果。huks.ini
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ------------------------------------------------ |
| keyAlias | string | 是 |
Init
操作密钥的别名。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
Init
参数集合。 |
| keyAlias | string | 是 |
initSession
操作密钥的别名。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
initSession
参数集合。 |
**返回值**
:
| 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- |
| Promise
\<
[
HuksSessionHandle
](
#hukssessionhandle9
)
> | Promise对象。将
Init
操作返回的handle添加到密钥管理系统的回调。 |
| Promise
\<
[
HuksSessionHandle
](
#hukssessionhandle9
)
> | Promise对象。将
initSession
操作返回的handle添加到密钥管理系统的回调。 |
## huks.updateSession<sup>9+</sup>
...
...
@@ -1198,9 +1198,9 @@ updateSession操作密钥接口,使用Callback回调异步返回结果。huks.
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | -------------------------------------------- |
| handle | number | 是 |
Update
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
Update
的参数集合。 |
| callback | AsyncCallback
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| 是 | 回调函数。将
Update
操作的结果添加到密钥管理系统的回调。 |
| handle | number | 是 |
updateSession
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
updateSession
的参数集合。 |
| callback | AsyncCallback
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| 是 | 回调函数。将
updateSession
操作的结果添加到密钥管理系统的回调。 |
## huks.updateSession<sup>9+</sup>
...
...
@@ -1215,16 +1215,16 @@ updateSession操作密钥接口,使用Callback回调异步返回结果。huks.
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | -------------------------------------------- |
| handle | number | 是 |
Update
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
Update
操作的参数集合。 |
| token | Uint8Array | 是 |
Update
操作的token。 |
| callback | AsyncCallback
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| 是 | 回调函数。将
Update
操作的结果添加到密钥管理系统的回调。 |
| handle | number | 是 |
updateSession
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
updateSession
操作的参数集合。 |
| token | Uint8Array | 是 |
updateSession
操作的token。 |
| callback | AsyncCallback
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| 是 | 回调函数。将
updateSession
操作的结果添加到密钥管理系统的回调。 |
## huks.updateSession<sup>9+</sup>
updateSession(handle: number, options: HuksOptions, token?: Uint8Array) : Promise
\<
HuksReturnResult>
u
u
pdateSession操作密钥接口,使用Promise方式异步返回结果。huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用。
updateSession操作密钥接口,使用Promise方式异步返回结果。huks.initSession, huks.updateSession, huks.finishSession为三段式接口,需要一起使用。
**系统能力**
:SystemCapability.Security.Huks
...
...
@@ -1232,15 +1232,15 @@ uupdateSession操作密钥接口,使用Promise方式异步返回结果。huks.
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------------- | ---- | -------------------------------------------- |
| handle | number | 是 |
Update
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
Update
操作的参数集合。 |
| token | Uint8Array | 否 |
Update
操作的token。 |
| handle | number | 是 |
updateSession
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
updateSession
操作的参数集合。 |
| token | Uint8Array | 否 |
updateSession
操作的token。 |
**返回值**
:
| 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- |
| Promise
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| Promise对象。将
Update
操作的结果添加到密钥管理系统的回调。 |
| Promise
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| Promise对象。将
updateSession
操作的结果添加到密钥管理系统的回调。 |
## huks.finishSession<sup>9+</sup>
...
...
@@ -1254,10 +1254,10 @@ finishSession操作密钥接口,使用Callback回调异步返回结果。huks.
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------------- | ---- | -------------------------------------------- |
| handle | number | 是 |
Finish
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
Finish
的参数集合。 |
| token | Uint8Array | 是 |
Finish
操作的token。 |
| callback | AsyncCallback
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| 是 | 回调函数。将
Finish
操作的结果添加到密钥管理系统的回调。 |
| handle | number | 是 |
finishSession
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
finishSession
的参数集合。 |
| token | Uint8Array | 是 |
finishSession
操作的token。 |
| callback | AsyncCallback
<
[
HuksReturnResult
](
#huksreturnresult9
)
>
| 是 | 回调函数。将
finishSession
操作的结果添加到密钥管理系统的回调。 |
## huks.finishSession<sup>9+</sup>
...
...
@@ -1271,10 +1271,10 @@ finishSession操作密钥接口,使用Callback回调异步返回结果。huks.
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------------- | ---- | -------------------------------------------- |
| handle | number | 是 |
Finish
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
Finish
的参数集合。 |
| token | Uint8Array | 是 |
Finish
操作的token。 |
| callback | AsyncCallback
\<
[
HuksReturnResult
](
#huksreturnresult9
)
> | 是 | 回调函数。将
Finish
操作的结果添加到密钥管理系统的回调。 |
| handle | number | 是 |
finishSession
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
finishSession
的参数集合。 |
| token | Uint8Array | 是 |
finishSession
操作的token。 |
| callback | AsyncCallback
\<
[
HuksReturnResult
](
#huksreturnresult9
)
> | 是 | 回调函数。将
finishSession
操作的结果添加到密钥管理系统的回调。 |
## huks.finishSession<sup>9+</sup>
...
...
@@ -1288,9 +1288,9 @@ finishSession操作密钥接口,使用Promise方式异步返回结果。huks.i
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------------------- | ---- | ----------------------------------- |
| handle | number | 是 |
Finish
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
Finish
操作的参数集合。 |
| token | Uint8Array | 否 |
Finish
操作的token。 |
| handle | number | 是 |
finishSession
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
finishSession
操作的参数集合。 |
| token | Uint8Array | 否 |
finishSession
操作的token。 |
**返回值**
:
...
...
@@ -1302,7 +1302,7 @@ finishSession操作密钥接口,使用Promise方式异步返回结果。huks.i
abortSession(handle: number, options: HuksOptions, callback: AsyncCallback
\<
void>) : void
abort操作密钥接口,使用Callback回调异步返回结果 。
abort
Session
操作密钥接口,使用Callback回调异步返回结果 。
**系统能力**
:SystemCapability.Security.Huks
...
...
@@ -1310,9 +1310,9 @@ abort操作密钥接口,使用Callback回调异步返回结果 。
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------------------- |
| handle | number | 是 |
Abort
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
Abort
操作的参数集合。 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数。将
Abort
操作的结果添加到密钥管理系统的回调。 |
| handle | number | 是 |
abortSession
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
abortSession
操作的参数集合。 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数。将
abortSession
操作的结果添加到密钥管理系统的回调。 |
**示例:**
...
...
@@ -1447,7 +1447,7 @@ async function huksAbort() {
abortSession(handle: number, options: HuksOptions) : Promise
\<
void>;
abort操作密钥接口,使用Promise方式异步返回结果。
abort
Session
操作密钥接口,使用Promise方式异步返回结果。
**系统能力**
:SystemCapability.Security.Huks
...
...
@@ -1455,14 +1455,14 @@ abort操作密钥接口,使用Promise方式异步返回结果。
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------- | ---- | ------------------------------------------- |
| handle | number | 是 |
Abort
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
Abort
操作的参数集合。 |
| handle | number | 是 |
abortSession
操作的handle。 |
| options |
[
HuksOptions
](
#huksoptions
)
| 是 |
abortSession
操作的参数集合。 |
**返回值**
:
| 类型 | 说明 |
| ----------------------------------- | -------------------------------------------------- |
| Promise
\<
void> | Promise对象。将
Abort
操作的结果添加到密钥管理系统的回调。 |
| Promise
\<
void> | Promise对象。将
abortSession
操作的结果添加到密钥管理系统的回调。 |
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录