Files
YukiHookAPI/docs/api/public/YukiHookFactory.md

225 lines
4.6 KiB
Markdown

## YukiHookFactory *- kt*
**变更记录**
`v1.0` `添加`
`v1.0.80` `修改`
合并到 `IYukiHookXposedInit`,将方法体进行 inline
**功能描述**
> 这是 `YukiHookAPI` 相关 `lambda` 方法的封装类以及部分 API 用法。
### IYukiHookXposedInit.configs *- ext-method*
```kotlin
inline fun IYukiHookXposedInit.configs(initiate: YukiHookAPI.Configs.() -> Unit)
```
**变更记录**
`v1.0.1` `新增`
`v1.0.80` `修改`
合并到 `IYukiHookXposedInit`
**功能描述**
> 在 `IYukiHookXposedInit` 中配置 `Configs`。
### IYukiHookXposedInit.encase *- ext-method*
```kotlin
fun IYukiHookXposedInit.encase(initiate: PackageParam.() -> Unit)
```
```kotlin
fun IYukiHookXposedInit.encase(vararg hooker: YukiBaseHooker)
```
**变更记录**
`v1.0` `添加`
`v1.0.80` `修改`
合并到 `IYukiHookXposedInit`
**功能描述**
> 在 `IYukiHookXposedInit` 中调用 `YukiHookAPI`。
### Context.modulePrefs *- ext-field*
```kotlin
val Context.modulePrefs: YukiHookModulePrefs
```
**变更记录**
`v1.0` `添加`
**功能描述**
> 获取模块的存取对象。
### Context.modulePrefs *- ext-method*
```kotlin
fun Context.modulePrefs(name: String): YukiHookModulePrefs
```
**变更记录**
`v1.0` `添加`
**功能描述**
> 获取模块的存取对象,可设置 `name` 为自定义 Sp 存储名称。
### Context.dataChannel *- ext-method*
```kotlin
fun Context.dataChannel(packageName: String): YukiHookDataChannel.NameSpace
```
**变更记录**
`v1.0.88` `新增`
**功能描述**
> 获取模块的数据通讯桥命名空间对象。
!> 只能在模块环境使用此功能,其它环境下使用将不起作用。
### Context.processName *- ext-field*
```kotlin
val Context.processName: String
```
**变更记录**
`v1.0` `添加`
**功能描述**
> 获取当前进程名称。
### Context+Resources.injectModuleAppResources *- ext-method*
```kotlin
fun Context.injectModuleAppResources()
```
```kotlin
fun Resources.injectModuleAppResources()
```
**变更记录**
`v1.0.93` `新增`
**功能描述**
> 向 Hook APP (宿主) `Context` 或 `Resources` 注入当前 Xposed 模块的资源。
注入成功后,你就可以直接使用例如 `ImageView.setImageResource``Resources.getString` 装载当前 Xposed 模块的资源 ID。
注入的资源作用域仅限当前 `Context``Resources`,你需要在每个用到宿主 `Context``Resources` 的地方重复调用此方法进行注入才能使用。
!> 只能在 (Xposed) 宿主环境使用此功能,其它环境下使用将不生效且会打印警告信息。
### Context.registerModuleAppActivities *- ext-method*
```kotlin
fun Context.registerModuleAppActivities(proxy: Any?)
```
**变更记录**
`v1.0.93` `新增`
**功能描述**
> 向 Hook APP (宿主) 注册当前 Xposed 模块的 `Activity`。
注册成功后,你就可以直接使用 `Context.startActivity` 来启动未在宿主中注册的 `Activity`
使用此方法会在未注册的 `Activity` 在 Hook APP (宿主) 中启动时自动调用 `injectModuleAppResources` 注入当前 Xposed 模块的资源。
你要将需要在宿主启动的 `Activity` 继承于 `ModuleAppActivity``ModuleAppCompatActivity`
!> 只能在 (Xposed) 宿主环境使用此功能,其它环境下使用将不生效且会打印警告信息。
### Context.applyModuleTheme *- ext-method*
```kotlin
fun Context.applyModuleTheme(theme: Int, configuration: Configuration?): ModuleContextThemeWrapper
```
**变更记录**
`v1.0.93` `新增`
**功能描述**
> 生成一个 `ContextThemeWrapper` 代理以应用当前 Xposed 模块的主题资源。
在 Hook APP (宿主) 中使用此方法会自动调用 `injectModuleAppResources` 注入当前 Xposed 模块的资源。
如果在 Hook APP (宿主) 中使用此方法发生 `ClassCastException`,请手动设置 `configuration`
### ~~isSupportResourcesHook *- field*~~ <!-- {docsify-ignore} -->
**变更记录**
`v1.0.80` `新增`
`v1.0.91` `移除`
请转移到 `YukiHookAPI.Status.isSupportResourcesHook`
### ~~isModuleActive *- field*~~ <!-- {docsify-ignore} -->
**变更记录**
`v1.0.6` `新增`
`v1.0.91` `移除`
请转移到 `YukiHookAPI.Status.isModuleActive`
### ~~isXposedModuleActive *- field*~~ <!-- {docsify-ignore} -->
**变更记录**
`v1.0.6` `新增`
`v1.0.91` `移除`
请转移到 `YukiHookAPI.Status.isXposedModuleActive`
### ~~isTaiChiModuleActive *- field*~~ <!-- {docsify-ignore} -->
**变更记录**
`v1.0` `添加`
`v1.0.91` `移除`
请转移到 `YukiHookAPI.Status.isTaiChiModuleActive`
## ~~YukiHookModuleStatus *- class*~~ <!-- {docsify-ignore} -->
**变更记录**
`v1.0` `添加`
`v1.0.91` `作废`
请转移到 `YukiHookAPI.Status`