已合并
asset C api optimize #3604
asset C api optimize #3604
已合并
yhf创建于 6月24日
共 2 个文件变更+16-16
@@ -54,10 +54,10 @@ extern "C" {
54 *54 *
55 * @param attributes 待新增关键资产的属性集合。55 * @param attributes 待新增关键资产的属性集合。
56 * @param attrCnt 待新增关键资产的属性数量。56 * @param attrCnt 待新增关键资产的属性数量。
57- * @return {@link Asset_ResultCode}:57+ * @return {@link Asset_ResultCode}:
58 * ASSET_SUCCESS = 0:操作成功。58 * ASSET_SUCCESS = 0:操作成功。
59 * ASSET_PERMISSION_DENIED = 201:调用方不是一个系统应用。59 * ASSET_PERMISSION_DENIED = 201:调用方不是一个系统应用。
60- * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:60+ * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:
61 * 1. 必选参数未指定。61 * 1. 必选参数未指定。
62 * 2. 参数类型错误。62 * 2. 参数类型错误。
63 * 3. 参数校验失败。63 * 3. 参数校验失败。
@@ -83,9 +83,9 @@ int32_t OH_Asset_Add(const Asset_Attr *attributes, uint32_t attrCnt);
83 *83 *
84 * @param query 待删除关键资产的搜索条件。84 * @param query 待删除关键资产的搜索条件。
85 * @param queryCnt 待删除关键资产搜索条件的个数。85 * @param queryCnt 待删除关键资产搜索条件的个数。
86- * @return {@link Asset_ResultCode}:86+ * @return {@link Asset_ResultCode}:
87 * ASSET_SUCCESS = 0:操作成功。87 * ASSET_SUCCESS = 0:操作成功。
88- * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:88+ * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:
89 * 1. 参数类型错误。89 * 1. 参数类型错误。
90 * 2. 参数校验失败。90 * 2. 参数校验失败。
91 * ASSET_SERVICE_UNAVAILABLE = 24000001:关键资产服务不可用。91 * ASSET_SERVICE_UNAVAILABLE = 24000001:关键资产服务不可用。
@@ -109,9 +109,9 @@ int32_t OH_Asset_Remove(const Asset_Attr *query, uint32_t queryCnt);
109 * @param queryCnt 待更新关键资产搜索条件的个数。109 * @param queryCnt 待更新关键资产搜索条件的个数。
110 * @param attributesToUpdate 待更新关键资产的属性集合。110 * @param attributesToUpdate 待更新关键资产的属性集合。
111 * @param updateCnt 待更新关键资产的属性数量。111 * @param updateCnt 待更新关键资产的属性数量。
112- * @return {@link Asset_ResultCode}:112+ * @return {@link Asset_ResultCode}:
113 * ASSET_SUCCESS = 0:操作成功。113 * ASSET_SUCCESS = 0:操作成功。
114- * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:114+ * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:
115 * 1. 必选参数未指定。115 * 1. 必选参数未指定。
116 * 2. 参数类型错误。116 * 2. 参数类型错误。
117 * 3. 参数校验失败。117 * 3. 参数校验失败。
@@ -138,9 +138,9 @@ int32_t OH_Asset_Update(const Asset_Attr *query, uint32_t queryCnt,
138 * @param query 关键资产的查询条件。138 * @param query 关键资产的查询条件。
139 * @param queryCnt 关键资产查询条件的个数。139 * @param queryCnt 关键资产查询条件的个数。
140 * @param challenge 挑战值,在后续调用{@link OH_Asset_Query}时使用。140 * @param challenge 挑战值,在后续调用{@link OH_Asset_Query}时使用。
141- * @return {@link Asset_ResultCode}:141+ * @return {@link Asset_ResultCode}:
142 * ASSET_SUCCESS = 0:操作成功。142 * ASSET_SUCCESS = 0:操作成功。
143- * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:143+ * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:
144 * 1. 参数类型错误。144 * 1. 参数类型错误。
145 * 2. 参数校验失败。145 * 2. 参数校验失败。
146 * ASSET_SERVICE_UNAVAILABLE = 24000001:关键资产服务不可用。146 * ASSET_SERVICE_UNAVAILABLE = 24000001:关键资产服务不可用。
@@ -166,9 +166,9 @@ int32_t OH_Asset_PreQuery(const Asset_Attr *query, uint32_t queryCnt, Asset_Blob
166 * @param query 关键资产的查询条件。166 * @param query 关键资产的查询条件。
167 * @param queryCnt 关键资产查询条件的个数。167 * @param queryCnt 关键资产查询条件的个数。
168 * @param resultSet 查询结果列表。168 * @param resultSet 查询结果列表。
169- * @return {@link Asset_ResultCode}:169+ * @return {@link Asset_ResultCode}:
170 * ASSET_SUCCESS = 0:操作成功。170 * ASSET_SUCCESS = 0:操作成功。
171- * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:171+ * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:
172 * 1. 参数类型错误。172 * 1. 参数类型错误。
173 * 2. 参数校验失败。173 * 2. 参数校验失败。
174 * ASSET_SERVICE_UNAVAILABLE = 24000001:关键资产服务不可用。174 * ASSET_SERVICE_UNAVAILABLE = 24000001:关键资产服务不可用。
@@ -193,9 +193,9 @@ int32_t OH_Asset_Query(const Asset_Attr *query, uint32_t queryCnt, Asset_ResultS
193 *193 *
194 * @param handle 待处理的查询句柄,当前包含{@link OH_Asset_PreQuery}执行成功返回的挑战值。194 * @param handle 待处理的查询句柄,当前包含{@link OH_Asset_PreQuery}执行成功返回的挑战值。
195 * @param handleCnt 句柄属性集合中元素的个数。195 * @param handleCnt 句柄属性集合中元素的个数。
196- * @return {@link Asset_ResultCode}:196+ * @return {@link Asset_ResultCode}:
197 * ASSET_SUCCESS = 0:操作成功。197 * ASSET_SUCCESS = 0:操作成功。
198- * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:198+ * ASSET_INVALID_ARGUMENT = 401:参数错误。 可能原因:
199 * 1. 必选参数未指定。199 * 1. 必选参数未指定。
200 * 2. 参数类型错误。200 * 2. 参数类型错误。
201 * 3. 参数校验失败。201 * 3. 参数校验失败。
@@ -90,7 +90,7 @@ typedef enum {
90 */90 */
91 ASSET_TAG_ACCESSIBILITY = ASSET_TYPE_NUMBER | 0x03,91 ASSET_TAG_ACCESSIBILITY = ASSET_TYPE_NUMBER | 0x03,
92 /**92 /**
93- * 表示关键资产是否在设备是否设置了锁屏密码时可用,其值为bool类型。93+ * 表示关键资产是否在设备设置了锁屏密码时可用,其值为bool类型。true表示仅在设置了锁屏密码时可访问,false表示不受锁屏密码限制。
94 */94 */
95 ASSET_TAG_REQUIRE_PASSWORD_SET = ASSET_TYPE_BOOL | 0x04,95 ASSET_TAG_REQUIRE_PASSWORD_SET = ASSET_TYPE_BOOL | 0x04,
96 /**96 /**
@@ -114,7 +114,7 @@ typedef enum {
114 */114 */
115 ASSET_TAG_SYNC_TYPE = ASSET_TYPE_NUMBER | 0x10,115 ASSET_TAG_SYNC_TYPE = ASSET_TYPE_NUMBER | 0x10,
116 /**116 /**
117- * 表示关键资产是否需持久化存储,其值为bool类型。117+ * 表示关键资产是否需持久化存储,其值为bool类型。true表示应用卸载时保留关键资产,false表示不保留关键资产。
118 * 在调用OH_Asset_Add函数时传入该属性需要校验权限ohos.permission.STORE_PERSISTENT_DATA,118 * 在调用OH_Asset_Add函数时传入该属性需要校验权限ohos.permission.STORE_PERSISTENT_DATA,
119 * 申请方式请参考[声明权限](../../security/AccessToken/declare-permissions.md)。119 * 申请方式请参考[声明权限](../../security/AccessToken/declare-permissions.md)。
120 */120 */
@@ -208,7 +208,7 @@ typedef enum {
208 */208 */
209 ASSET_TAG_OPERATION_TYPE = ASSET_TYPE_NUMBER | 0x46,209 ASSET_TAG_OPERATION_TYPE = ASSET_TYPE_NUMBER | 0x46,
210 /**210 /**
211- * @brief 表示是否加密业务自定义附属信息,其值为bool类型。211+ * @brief 表示是否加密业务自定义附属信息,其值为bool类型。true表示加密业务自定义附属信息,false表示不加密。
212 *212 *
213 * @since 14213 * @since 14
214 */214 */
@@ -538,7 +538,7 @@ typedef struct {
538 */538 */
539typedef struct {539typedef struct {
540 /**540 /**
541- * 关键资产同步的结果码。541+ * 关键资产同步的结果码。同步成功时结果码为0,同步失败时结果码参考[Asset_ResultCode](capi-asset-type-h.md#Asset_ResultCode)。
542 */542 */
543 int32_t resultCode;543 int32_t resultCode;
544 /**544 /**