diff --git a/abilitykit/capi-Readme.md b/abilitykit/capi-Readme.md new file mode 100644 index 0000000000000000000000000000000000000000..bb3e8f31d578167b38446f8d6cfe58c4ba76ca85 --- /dev/null +++ b/abilitykit/capi-Readme.md @@ -0,0 +1,9 @@ +- 头文件 + - [native_interface_bundle.h](capi-native-interface-bundle-h.md) +- 模块 + - [Native_Bundle](capi-native-bundle.md) +- 结构体 + - [OH_NativeBundle_ApplicationInfo](capi-native-bundle-oh-nativebundle-applicationinfo.md) + - [OH_NativeBundle_ElementName](capi-native-bundle-oh-nativebundle-elementname.md) + - [OH_NativeBundle_Metadata](capi-native-bundle-oh-nativebundle-metadata.md) + - [OH_NativeBundle_ModuleMetadata](capi-native-bundle-oh-nativebundle-modulemetadata.md) \ No newline at end of file diff --git a/abilitykit/capi-native-bundle-oh-nativebundle-applicationinfo.md b/abilitykit/capi-native-bundle-oh-nativebundle-applicationinfo.md new file mode 100644 index 0000000000000000000000000000000000000000..d29e98e703fb160d05a3fe64531814090e3dd0c0 --- /dev/null +++ b/abilitykit/capi-native-bundle-oh-nativebundle-applicationinfo.md @@ -0,0 +1,11 @@ +# OH_NativeBundle_ApplicationInfo + +## 概述 + +应用包信息数据结构,包含应用包名和应用指纹信息。 + +**起始版本:** 9 + +**相关模块:** [Native_Bundle](capi-native-bundle.md) + +**所在头文件:** [native_interface_bundle.h](capi-native-interface-bundle-h.md) \ No newline at end of file diff --git a/abilitykit/capi-native-bundle-oh-nativebundle-elementname.md b/abilitykit/capi-native-bundle-oh-nativebundle-elementname.md new file mode 100644 index 0000000000000000000000000000000000000000..b0eed660cf91aa8a01956d68f77caf5835ca6ea4 --- /dev/null +++ b/abilitykit/capi-native-bundle-oh-nativebundle-elementname.md @@ -0,0 +1,11 @@ +# OH_NativeBundle_ElementName + +## 概述 + +elementName信息。 + +**起始版本:** 13 + +**相关模块:** [Native_Bundle](capi-native-bundle.md) + +**所在头文件:** [native_interface_bundle.h](capi-native-interface-bundle-h.md) \ No newline at end of file diff --git a/abilitykit/capi-native-bundle-oh-nativebundle-metadata.md b/abilitykit/capi-native-bundle-oh-nativebundle-metadata.md new file mode 100644 index 0000000000000000000000000000000000000000..12e1701839bcbef853262ecc9b3db2a4a537b5a4 --- /dev/null +++ b/abilitykit/capi-native-bundle-oh-nativebundle-metadata.md @@ -0,0 +1,21 @@ +# OH_NativeBundle_Metadata + +## 概述 + +元数据信息。 + +**起始版本:** 20 + +**相关模块:** [Native_Bundle](capi-native-bundle.md) + +**所在头文件:** [native_interface_bundle.h](capi-native-interface-bundle-h.md) + +## 汇总 + +### 成员变量 + +| 名称 | 描述 | +| -- | -- | +| char* name | 元数据名称。 | +| char* value | 元数据值。 | +| char* resource | 元数据资源。 | \ No newline at end of file diff --git a/abilitykit/capi-native-bundle-oh-nativebundle-modulemetadata.md b/abilitykit/capi-native-bundle-oh-nativebundle-modulemetadata.md new file mode 100644 index 0000000000000000000000000000000000000000..6fe83b554c079e11835327d81092848fba5ba4ce --- /dev/null +++ b/abilitykit/capi-native-bundle-oh-nativebundle-modulemetadata.md @@ -0,0 +1,21 @@ +# OH_NativeBundle_ModuleMetadata + +## 概述 + +模块元数据的信息。 + +**起始版本:** 20 + +**相关模块:** [Native_Bundle](capi-native-bundle.md) + +**所在头文件:** [native_interface_bundle.h](capi-native-interface-bundle-h.md) + +## 汇总 + +### 成员变量 + +| 名称 | 描述 | +| -- | -- | +| char* moduleName | 模块名称。 | +| [OH_NativeBundle_Metadata*](capi-native-bundle-oh-nativebundle-metadata.md) metadataArray | 模块的元数据数组。 | +| size_t metadataArraySize | 模块的元数据数组大小。 | \ No newline at end of file diff --git a/abilitykit/capi-native-bundle.md b/abilitykit/capi-native-bundle.md new file mode 100644 index 0000000000000000000000000000000000000000..37ae9bf1f4c05a150c2a9eff9ab72e53eab5dab1 --- /dev/null +++ b/abilitykit/capi-native-bundle.md @@ -0,0 +1,12 @@ +# Native_Bundle + +## 概述 + +提供查询应用包信息的功能,获取到的信息包含应用包名和应用指纹信息。 + +**起始版本:** 9 +## 文件汇总 + +| 名称 | 描述 | +| -- | -- | +| [native_interface_bundle.h](capi-native-interface-bundle-h.md) | 提供查询应用包信息的功能,获取到的信息包含应用包名和应用指纹信息。 | \ No newline at end of file diff --git a/abilitykit/capi-native-interface-bundle-h.md b/abilitykit/capi-native-interface-bundle-h.md new file mode 100644 index 0000000000000000000000000000000000000000..5c77c4cecd4c42aa8fa790b544ea42a5d270a406 --- /dev/null +++ b/abilitykit/capi-native-interface-bundle-h.md @@ -0,0 +1,88 @@ +# native_interface_bundle.h + +## 概述 + +提供查询应用包信息的功能,获取到的信息包含应用包名和应用指纹信息。 + +** 引用文件: ** + +**库:** libbundle_ndk.z.so + +**系统能力:** SystemCapability.BundleManager.BundleFramework.Core + +**起始版本:** 9 + +**相关模块:** [Native_Bundle](capi-native-bundle.md) + +## 汇总 + +### 结构体 + +| 名称 | typedef关键字 | 描述 | +| -- | -- | -- | +| [OH_NativeBundle_ApplicationInfo](capi-native-bundle-oh-nativebundle-applicationinfo.md) | OH_NativeBundle_ApplicationInfo | 应用包信息数据结构,包含应用包名和应用指纹信息。 | +| [OH_NativeBundle_ElementName](capi-native-bundle-oh-nativebundle-elementname.md) | - | | +| [OH_NativeBundle_Metadata](capi-native-bundle-oh-nativebundle-metadata.md) | OH_NativeBundle_Metadata | 元数据信息。 | +| [OH_NativeBundle_ModuleMetadata](capi-native-bundle-oh-nativebundle-modulemetadata.md) | OH_NativeBundle_ModuleMetadata | 模块元数据的信息。 | + +### 函数 + +| 名称 | 描述 | +| -- | -- | +| [OH_NativeBundle_ApplicationInfo OH_NativeBundle_GetCurrentApplicationInfo()](#oh_nativebundle_getcurrentapplicationinfo) | 获取当前应用信息,包含应用包名和应用指纹信息。 | +| [char* OH_NativeBundle_GetAppId()](#oh_nativebundle_getappid) | 获取当前应用的appId。appId是应用的唯一标识,由应用包名和签名信息决定。在使用此接口后,为了避免内存泄漏,需要手动释放接口返回的指针。 | +| [char* OH_NativeBundle_GetAppIdentifiier()](#oh_nativebundle_getappidentifier)| 获取当前应用的应用程序标识符。该应用程序标识符在应用的整个生命周期中不会发生变化,包括版本更新、证书更改、公钥和私钥更改以及应用程序迁移。在使用此接口后,为了避免内存泄漏,需要手动释放接口返回的指针。 | +| [OH_NativeBundle_ElementName_OH_NativeBundel_GetMainElementName()](#oh_nativebundle_getmainelementname) | 获取当前应用入口元素mainElement的信息,包括包名、模块名和能力名。在使用此接口后,为了避免内存泄漏,需要手动释放接口返回的指针。 | +| [char* OH_NativeBundle_GetCompatibleDeviceType()](#oh_nativebundle_getcompatibledevicetype) | 获取当前应用适用的设备类型。在使用此接口后,为了避免内存泄漏,需要手动释放接口返回的指针。 | +| [bool OH_NativeBundle_IsDebugMode(bool* isDebugMode)](#oh_nativebundle_isdebugmode) | 查询当前应用的调试模式。 | +| [OH_NativeBundle_ModuleMetadata* OH_NativeBundle_GetModuleMetadata(size_t* size)](#oh_nativebundle_getmodulemetadata) | 获取当前应用程序的模块元数据数组。在使用此接口后,为了避免内存泄漏,需要手动释放接口返回的指针。 | + +## 函数说明 + +### OH_NativeBundle_GetCurrentApplicationInfo() + +``` +OH_NativeBundle_ApplicationInfo OH_NativeBundle_GetCurrentApplicationInfo() +``` + +**描述** +获取当前应用信息,包含应用包名和应用指纹信息。 + +**起始版本:** 9 + +**返回:** +| 类型 | 说明 | +| -- | -- | +| [OH_NativeBundle_ApplicationInfo](capi-native-bundle-oh-nativebundle-applicationinfo.md) | 返回新创建的OH_NativeBundle_ApplicationInfo对象。如果返回的对象为NULL,则表示创建失败。
失败的可能原因是应用程序地址空间已满,导致空间分配失败。 | + +### OH_NativeBundle_GetAppId() + +``` +char* OH_NativeBundle_GetAppId() +``` + +**描述** +获取当前应用的appId。appId是应用的唯一标识,由应用包名和签名信息决定。在使用此接口后,为了避免内存泄漏,需要手动释放接口返回的指针。 + +**起始版本:** 11 + +**返回:** +| 类型 | 说明 | +| -- | -- | +| char* | 返回一个新创建的字符串,用于指示appID信息。如果返回的对象为NULL,则表示创建失败。
失败的可能原因是应用程序地址空间已满,导致空间分配失败。 | + +### OH_NativeBundle_GetAppIdentifiier() + +``` +char* OH_NativeBundle_GetAppIdentifiier() +``` + +**描述** +获取当前应用的应用程序标识符。该应用程序标识符在应用的整个生命周期中不会发生变化,包括版本更新、证书更改、公钥和私钥更改以及应用程序迁移。在使用此接口后,为了避免内存泄漏,需要手动释放接口返回的指针。 + +**起始版本:** 11 + +**返回:** +| 类型 | 说明 | +| -- | -- | +| char* | 返回一个新创建的字符串,用于指示应用程序标识符信息。如果返回的对象为NULL,则表示创建失败。
失败的可能原因是应用程序地址空间已满,导致空间分配失败。 | \ No newline at end of file