HighCapable/YukiHookAPI
5
0
Fork 0
mirror of https://github.com/HighCapable/YukiHookAPI.git synced 2025-09-04 01:35:17 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update api docs

Browse Source
This commit is contained in:
fankesyooni
2023-10-05 00:37:15 +08:00
parent da26016630
commit c7decb4119
4 changed files with 37 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs-source/src/en/api/public/com/highcapable/yukihookapi/YukiHookAPI.md
View File

@@ -172,7 +172,7 @@ val isModuleActive: Boolean
在模块环境中你需要将 **Application** 继承于 **ModuleApplication**。 在模块环境中你需要将 **Application** 继承于 **ModuleApplication**。
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
在 (Xposed) 宿主环境中仅返回非 **isTaiChiModuleActive** 的激活状态。 在 (Xposed) 宿主环境中仅返回非 **isTaiChiModuleActive** 的激活状态。
@@ -194,7 +194,7 @@ val isXposedModuleActive: Boolean
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
在 (Xposed) 宿主环境中始终返回 true。 在 (Xposed) 宿主环境中始终返回 true。
@@ -234,11 +234,11 @@ val isSupportResourcesHook: Boolean
**Function Illustrate** **Function Illustrate**
> 判断当前 Hook Framework 是否支持资源钩子(Resources Hook)。 > 判断当前 Hook Framework 是否支持资源钩子 (Resources Hook)。
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
在 (Xposed) 宿主环境中可能会延迟等待事件回调后才会返回 true。 在 (Xposed) 宿主环境中可能会延迟等待事件回调后才会返回 true。
@@ -276,7 +276,7 @@ val name: String
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
::: :::
@@ -296,7 +296,7 @@ val type: ExecutorType
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
::: :::
@@ -316,7 +316,7 @@ val apiLevel: Int
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
::: :::
@@ -336,7 +336,7 @@ val versionName: String
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
::: :::
@@ -356,7 +356,7 @@ val versionCode: Int
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
::: :::
@@ -468,27 +468,15 @@ var isEnableModuleAppResourcesCache: Boolean
::: :::
### isEnableHookModuleStatus <span class="symbol">- field</span> <h3 class="deprecated">isEnableHookModuleStatus - field</h3>
```kotlin:no-line-numbers **变更记录**
var isEnableHookModuleStatus: Boolean
```
**Change Records**
`v1.0.88` `added` `v1.0.88` `added`
**Function Illustrate** `v1.2.0` `deprecated`
> 是否启用 Hook Xposed 模块激活等状态功能. 请手动迁移到 `InjectYukiHookWithXposed.isUsingXposedModuleStatus`
为原生支持 Xposed 模块激活状态检测，此功能默认启用。
::: warning
关闭后你将不能再在模块环境中使用 **YukiHookAPI.Status** 中的激活状态判断功能。
:::
### isEnableHookSharedPreferences <span class="symbol">- field</span> ### isEnableHookSharedPreferences <span class="symbol">- field</span>
@@ -639,7 +627,7 @@ object HookEntry : IYukiHookXposedInit {
) )
YukiHookAPI.Configs.isDebug = BuildConfig.DEBUG YukiHookAPI.Configs.isDebug = BuildConfig.DEBUG
YukiHookAPI.Configs.isEnableModuleAppResourcesCache = true YukiHookAPI.Configs.isEnableModuleAppResourcesCache = true
YukiHookAPI.Configs.isEnableHookModuleStatus = true YukiHookAPI.InjectYukiHookWithXposed.isUsingXposedModuleStatus = true
YukiHookAPI.Configs.isEnableHookSharedPreferences = false YukiHookAPI.Configs.isEnableHookSharedPreferences = false
YukiHookAPI.Configs.isEnableDataChannel = true YukiHookAPI.Configs.isEnableDataChannel = true
} }

5
docs-source/src/en/api/public/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.md
View File

@@ -17,6 +17,7 @@ annotation class InjectYukiHookWithXposed(
val sourcePath: String, val sourcePath: String,
val modulePackageName: String, val modulePackageName: String,
val entryClassName: String, val entryClassName: String,
val isUsingXposedModuleStatus: Boolean,
val isUsingResourcesHook: Boolean val isUsingResourcesHook: Boolean
) )
``` ```
@@ -33,6 +34,10 @@ annotation class InjectYukiHookWithXposed(
新增 `isUsingResourcesHook` 参数 新增 `isUsingResourcesHook` 参数
`v1.2.0` `modified`
新增 `isUsingXposedModuleStatus` 参数
**Function Illustrate** **Function Illustrate**
> 标识 `YukiHookAPI` 注入 Xposed 入口的类注解。 > 标识 `YukiHookAPI` 注入 Xposed 入口的类注解。

38
docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/YukiHookAPI.md
View File

@@ -164,7 +164,7 @@ val isModuleActive: Boolean
在模块环境中你需要将 **Application** 继承于 **ModuleApplication**。 在模块环境中你需要将 **Application** 继承于 **ModuleApplication**。
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
在 (Xposed) 宿主环境中仅返回非 **isTaiChiModuleActive** 的激活状态。 在 (Xposed) 宿主环境中仅返回非 **isTaiChiModuleActive** 的激活状态。
@@ -186,7 +186,7 @@ val isXposedModuleActive: Boolean
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
在 (Xposed) 宿主环境中始终返回 true。 在 (Xposed) 宿主环境中始终返回 true。
@@ -226,11 +226,11 @@ val isSupportResourcesHook: Boolean
**功能描述** **功能描述**
> 判断当前 Hook Framework 是否支持资源钩子(Resources Hook)。 > 判断当前 Hook Framework 是否支持资源钩子 (Resources Hook)。
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
在 (Xposed) 宿主环境中可能会延迟等待事件回调后才会返回 true。 在 (Xposed) 宿主环境中可能会延迟等待事件回调后才会返回 true。
@@ -268,7 +268,7 @@ val name: String
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
::: :::
@@ -288,7 +288,7 @@ val type: ExecutorType
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
::: :::
@@ -308,7 +308,7 @@ val apiLevel: Int
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
::: :::
@@ -328,7 +328,7 @@ val versionName: String
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
::: :::
@@ -348,7 +348,7 @@ val versionCode: Int
::: warning ::: warning
在模块环境中需要启用 **Configs.isEnableHookModuleStatus**。 在模块环境中需要启用 **InjectYukiHookWithXposed.isUsingXposedModuleStatus**。
::: :::
@@ -460,27 +460,15 @@ var isEnableModuleAppResourcesCache: Boolean
::: :::
### isEnableHookModuleStatus <span class="symbol">- field</span> <h3 class="deprecated">isEnableHookModuleStatus - field</h3>
```kotlin:no-line-numbers
var isEnableHookModuleStatus: Boolean
```
**变更记录** **变更记录**
`v1.0.88` `新增` `v1.0.88` `新增`
**功能描述** `v1.2.0` `作废`
> 是否启用 Hook Xposed 模块激活等状态功能. 请手动迁移到 `InjectYukiHookWithXposed.isUsingXposedModuleStatus`
为原生支持 Xposed 模块激活状态检测，此功能默认启用。
::: warning
关闭后你将不能再在模块环境中使用 **YukiHookAPI.Status** 中的激活状态判断功能。
:::
### isEnableHookSharedPreferences <span class="symbol">- field</span> ### isEnableHookSharedPreferences <span class="symbol">- field</span>
@@ -631,7 +619,7 @@ object HookEntry : IYukiHookXposedInit {
) )
YukiHookAPI.Configs.isDebug = BuildConfig.DEBUG YukiHookAPI.Configs.isDebug = BuildConfig.DEBUG
YukiHookAPI.Configs.isEnableModuleAppResourcesCache = true YukiHookAPI.Configs.isEnableModuleAppResourcesCache = true
YukiHookAPI.Configs.isEnableHookModuleStatus = true YukiHookAPI.InjectYukiHookWithXposed.isUsingXposedModuleStatus = true
YukiHookAPI.Configs.isEnableHookSharedPreferences = false YukiHookAPI.Configs.isEnableHookSharedPreferences = false
YukiHookAPI.Configs.isEnableDataChannel = true YukiHookAPI.Configs.isEnableDataChannel = true
} }

5
docs-source/src/zh-cn/api/public/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.md
View File

@@ -9,6 +9,7 @@ annotation class InjectYukiHookWithXposed(
val sourcePath: String, val sourcePath: String,
val modulePackageName: String, val modulePackageName: String,
val entryClassName: String, val entryClassName: String,
val isUsingXposedModuleStatus: Boolean,
val isUsingResourcesHook: Boolean val isUsingResourcesHook: Boolean
) )
``` ```
@@ -25,6 +26,10 @@ annotation class InjectYukiHookWithXposed(
新增 `isUsingResourcesHook` 参数 新增 `isUsingResourcesHook` 参数
`v1.2.0` `修改`
新增 `isUsingXposedModuleStatus` 参数
**功能描述** **功能描述**
> 标识 `YukiHookAPI` 注入 Xposed 入口的类注解。 > 标识 `YukiHookAPI` 注入 Xposed 入口的类注解。