mirror of
https://github.com/zhamao-robot/zhamao-framework.git
synced 2026-07-21 15:45:36 +08:00
update api docs
This commit is contained in:
committed by
github-actions[bot]
parent
2633e91d4d
commit
ede5f456a8
@@ -26,7 +26,7 @@ public function onRequest999(OneBot\Driver\Event\Http\HttpRequestEvent $event):
|
||||
## onRequest1
|
||||
|
||||
```php
|
||||
public function onRequest1(OneBot\Driver\Event\Http\HttpRequestEvent $event): mixed
|
||||
public function onRequest1(OneBot\Driver\Event\Http\HttpRequestEvent $event): void
|
||||
```
|
||||
|
||||
### 描述
|
||||
@@ -43,7 +43,7 @@ public function onRequest1(OneBot\Driver\Event\Http\HttpRequestEvent $event): mi
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| mixed | |
|
||||
| void | |
|
||||
|
||||
|
||||
## getInstance
|
||||
|
||||
@@ -1,5 +1,28 @@
|
||||
# ZM\Event\Listener\WSEventListener
|
||||
|
||||
## onWebSocketOpen
|
||||
|
||||
```php
|
||||
public function onWebSocketOpen(OneBot\Driver\Event\WebSocket\WebSocketOpenEvent $event): void
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| event | OneBot\Driver\Event\WebSocket\WebSocketOpenEvent | |
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| void | |
|
||||
|
||||
|
||||
## getInstance
|
||||
|
||||
```php
|
||||
|
||||
23
docs/api/ZM/Plugin/OneBot12Adapter.md
Normal file
23
docs/api/ZM/Plugin/OneBot12Adapter.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# ZM\Plugin\OneBot12Adapter
|
||||
|
||||
## handleWSReverseInput
|
||||
|
||||
```php
|
||||
public function handleWSReverseInput(OneBot\Driver\Event\WebSocket\WebSocketOpenEvent $event): void
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| event | OneBot\Driver\Event\WebSocket\WebSocketOpenEvent | |
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| void | |
|
||||
23
docs/api/ZM/Plugin/PluginManager.md
Normal file
23
docs/api/ZM/Plugin/PluginManager.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# ZM\Plugin\PluginManager
|
||||
|
||||
## addPlugin
|
||||
|
||||
```php
|
||||
public function addPlugin(array $meta): void
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| meta | array | |
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| void | |
|
||||
71
docs/api/ZM/Utils/ConnectionUtil.md
Normal file
71
docs/api/ZM/Utils/ConnectionUtil.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# ZM\Utils\ConnectionUtil
|
||||
|
||||
## addConnection
|
||||
|
||||
```php
|
||||
public function addConnection(int $fd, array $handle): bool
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| fd | int | |
|
||||
| handle | array | |
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| bool | |
|
||||
|
||||
|
||||
## setConnection
|
||||
|
||||
```php
|
||||
public function setConnection(int $fd, array $handle): void
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| fd | int | |
|
||||
| handle | array | |
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| void | |
|
||||
|
||||
|
||||
## removeConnection
|
||||
|
||||
```php
|
||||
public function removeConnection(int $fd): void
|
||||
```
|
||||
|
||||
### 描述
|
||||
|
||||
作者很懒,什么也没有说
|
||||
|
||||
### 参数
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| fd | int | |
|
||||
|
||||
### 返回
|
||||
|
||||
| 类型 | 描述 |
|
||||
| ---- | ----------- |
|
||||
| void | |
|
||||
@@ -3,7 +3,7 @@
|
||||
## parseUri
|
||||
|
||||
```php
|
||||
public function parseUri(OneBot\Http\ServerRequest $request, mixed $node, mixed $params): int
|
||||
public function parseUri(Psr\Http\Message\RequestInterface $request, mixed $node, mixed $params): int
|
||||
```
|
||||
|
||||
### 描述
|
||||
@@ -14,7 +14,7 @@ public function parseUri(OneBot\Http\ServerRequest $request, mixed $node, mixed
|
||||
|
||||
| 名称 | 类型 | 描述 |
|
||||
| -------- | ---- | ----------- |
|
||||
| request | OneBot\Http\ServerRequest | |
|
||||
| request | Psr\Http\Message\RequestInterface | |
|
||||
| node | mixed | |
|
||||
| params | mixed | |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user