Update documentation files

This commit is contained in:
2022-05-21 01:49:52 +08:00
parent a879db99a1
commit 76bb612a4c
11 changed files with 560 additions and 28 deletions

View File

@@ -0,0 +1,64 @@
## ChannelData [class]
```kotlin
data class ChannelData<T>(var key: String, var value: T?)
```
**变更记录**
`v1.0.88` `新增`
**功能描述**
> 数据通讯桥键值构造类。
这个类是对 `YukiHookDataChannel` 的一个扩展用法。
**功能示例**
建立一个模板类定义模块与宿主需要发送的键值数据。
> 示例如下
```kotlin
object DataConst {
val TEST_KV_DATA_1 = ChannelData("test_data_1", "defalut value")
val TEST_KV_DATA_2 = ChannelData("test_data_2", 0)
}
```
键值数据定义后,你就可以方便地在模块和宿主中调用所需要发送的数据。
> 模块示例如下
```kotlin
// 从指定包名的宿主获取
dataChannel(packageName = "com.example.demo").wait(DataConst.TEST_KV_DATA_1) { value ->
// Your code here.
}
// 发送给指定包名的宿主 - 未填写 value 时将使用模板提供的默认值
dataChannel(packageName = "com.example.demo").put(DataConst.TEST_KV_DATA_1, value = "sending value")
```
> 宿主示例如下
```kotlin
// 从模块获取
dataChannel.wait(DataConst.TEST_KV_DATA_1) { value ->
// Your code here.
}
// 发送给模块 - 未填写 value 时将使用模板提供的默认值
dataChannel.put(DataConst.TEST_KV_DATA_1, value = "sending value")
```
你依然可以不使用模板定义的默认值,随时修改你的默认值。
> 示例如下
```kotlin
// 获取 - 此时 value 取到的默认值将会是 2 - 并不是模板提供的 0
dataChannel.wait(DataConst.TEST_KV_DATA_2, value = 2) { value ->
// Your code here.
}
```