diff options
| author | syuilo <Syuilotan@yahoo.co.jp> | 2021-11-13 12:23:49 +0900 |
|---|---|---|
| committer | syuilo <Syuilotan@yahoo.co.jp> | 2021-11-13 12:23:49 +0900 |
| commit | 2795fe457909c687f668d020ef65d52abc3182fb (patch) | |
| tree | 0a52e4e4d854333496fcc487560c93c3de5d5eb5 /src/docs/zh-CN/advanced | |
| parent | Merge branch 'develop' (diff) | |
| parent | 12.96.0 (diff) | |
| download | misskey-2795fe457909c687f668d020ef65d52abc3182fb.tar.gz misskey-2795fe457909c687f668d020ef65d52abc3182fb.tar.bz2 misskey-2795fe457909c687f668d020ef65d52abc3182fb.zip | |
Merge branch 'develop'
Diffstat (limited to 'src/docs/zh-CN/advanced')
| -rw-r--r-- | src/docs/zh-CN/advanced/aiscript.md | 7 | ||||
| -rw-r--r-- | src/docs/zh-CN/advanced/api.md | 58 | ||||
| -rw-r--r-- | src/docs/zh-CN/advanced/create-plugin.md | 74 | ||||
| -rw-r--r-- | src/docs/zh-CN/advanced/develop-bot.md | 6 | ||||
| -rw-r--r-- | src/docs/zh-CN/advanced/reversi-bot.md | 160 | ||||
| -rw-r--r-- | src/docs/zh-CN/advanced/share-page.md | 54 | ||||
| -rw-r--r-- | src/docs/zh-CN/advanced/stream.md | 350 |
7 files changed, 0 insertions, 709 deletions
diff --git a/src/docs/zh-CN/advanced/aiscript.md b/src/docs/zh-CN/advanced/aiscript.md deleted file mode 100644 index 5622a82320..0000000000 --- a/src/docs/zh-CN/advanced/aiscript.md +++ /dev/null @@ -1,7 +0,0 @@ -# AiScript -AiScript是Misskey所使用的脚本语言。 - -<div class="info">AiScript 的实现独立于 Misskey 的存储库,并且是 <a href="https://github.com/syuilo/aiscript" target="_blank"> 开源的。 </a></div> - -## 用法 -AiScript 语法和内置函数等文档会在 [ 这里 ](https://github.com/syuilo/aiscript/tree/master/docs) 发布。 diff --git a/src/docs/zh-CN/advanced/api.md b/src/docs/zh-CN/advanced/api.md deleted file mode 100644 index a1ca2f470b..0000000000 --- a/src/docs/zh-CN/advanced/api.md +++ /dev/null @@ -1,58 +0,0 @@ -# Misskey API - -您可以使用Misskey API来开发Misskey客户端、与Misskey链接的Web服务、Bot等应用(以下称为“应用程序”)。 另外还有一个流式API,因此还可以用来创建实时性的应用程序。 - -开始使用API前,您首先需要获取访问令牌。 本文档将向您介绍获取访问令牌所需的步骤,以及API的基本使用方法。 - -## 访问令牌的获取 -总的来说,API请求需要访问令牌。 获取方式则根据请求的API或者非特定用户所使用的应用程序而有所不同。 - -* 对于前者:请转到[“手动发放自己的访问令牌”](#自分自身のアクセストークンを手動発行する) -* 对于后者:请转到[“请求应用程序用户发放访问令牌”](#アプリケーション利用者にアクセストークンの発行をリクエストする) - -### 手动发放自己的访问令牌 -您可以在“设置 > API”中发放自己的访问令牌。 - -[请转到“API使用方法”](#APIの使い方) - -### 请求应用程序用户发放访问令牌 -要获取应用程序用户的访问令牌,请按照以下步骤请求发放。 - -#### 步骤 1 - -生成UUID。以下将其称为会话ID。 - -> 此会话ID需要每次重新生成,请勿重复使用。 - -#### 步骤 2 - -在用户的浏览器中显示`{_URL_}/miauth/{session}`。将`{session}`的部分替换为会话ID。 -> 例: `{_URL_}/miauth/c1f6d42b-468b-4fd2-8274-e58abdedef6f` - -显示时,可以在URL中设置一些选项作为查询参数: -* `name` ... 应用程序名称 - * > 例: `MissDeck` -* `icon` ... 应用程序图标URL - * > 例: `https://missdeck.example.com/icon.png` -* `callback` ... 认证后重定向的URL - * > 例: `https://missdeck.example.com/callback` - * 重定向时,会话ID将添加查询参数`session` -* `permission` ... 应用程序要求的权限 - * > 例: `write:notes,write:following,read:drive` - * 要求的权限需要以`,`分隔 - * 您可以在[API参考](/api-doc)中确认您所拥有的权限。 - -#### 步骤 3 -用户允许发行后,对`{_URL_}/api/miauth/{session}/check`的POST请求所返回的是一个包含访问令牌的JSON格式的响应。 - -响应中包含的属性: -* `token` ... 用户的访问令牌 -* `user` ... 用户信息 - -[请转到“API使用方法”](#APIの使い方) - -## API使用方法 -**所有API均为POST,并且请求/响应均为JSON格式。不是REST。** 访问令牌包含在请求中,参数名为`i`。 - -* [API 参考](/api-doc) -* [流式API](./stream) diff --git a/src/docs/zh-CN/advanced/create-plugin.md b/src/docs/zh-CN/advanced/create-plugin.md deleted file mode 100644 index a32d36fa8e..0000000000 --- a/src/docs/zh-CN/advanced/create-plugin.md +++ /dev/null @@ -1,74 +0,0 @@ -# 插件开发 -Misskey Web客户端插件功能使您可以扩展客户端并添加各种功能。 我们在这里给出用于创建插件的元数据定义和AiScript API参考。 - -## 元数据 -插件必须使用AiScript的元数据嵌入功能将插件的元数据定义为默认值。 元数据是一个包含以下属性的对象: - -### name -插件名称 - -### author -插件作者 - -### version -插件版本。请使用数字。 - -### description -插件说明 - -### permissions -插件要求的权限。需要在发送Misskey API请求时使用。 - -### config -表示插件设置信息的对象。 在键名中包含设置名称,在键值中包含以下属性。 - -#### type -代表设置值的类型的字符串。从下列项中选择: string number boolean - -#### label -向用户显示的设置名称 - -#### description -设置说明 - -#### default -设置的默认值 - -## API 参考 -AiScript标准内置API将不会公布。 - -### Mk:dialog(title text type) -显示一个对话框。type可以设置为以下值: info success warn error question 默认值为info。 - -### Mk:confirm(title text type) -显示确认对话框。type可以设置为以下值: info success warn error question 默认值为question。 如果用户选择“OK”,则返回true;如果用户选择“取消”,则返回false。 - -### Mk:api(endpoint params) -通过Misskey API发送请求。在第一个参数中传入终端名称,在第二个参数中传入参数对象。 - -### Mk:save(key value) -给任意对象名赋值,并使其持久化。所谓的持久化的值,指的是该值即使在AiScript上下文结束后仍然保留,并且可以通过Mk:load读取。 - -### Mk:load(key) -读取由Mk:save生成的持久化的值。 - -### Plugin:register_post_form_action(title fn) -将操作添加到发布表单。第一个参数是操作名,第二个参数是该操作对应的回调函数。 帖子表单对象作为第一个参数传给回调函数。 - -### Plugin:register_note_action(title fn) -将项目添加到帖子菜单。第一个参数是菜单项名字,第二个参数是该菜单项对应的回调函数。 目标项目对象作为第一个参数传给回调函数。 - -### Plugin:register_user_action(title fn) -将项目添加到用户菜单。第一个参数是菜单项名字,第二个参数是该菜单项对应的回调函数。 目标用户对象作为第一个参数传给回调函数。 - -### Plugin:register_note_view_interruptor(fn) -改写显示在UI上的帖子信息。 目标帖子对象作为第一个参数传给回调函数。 该帖子将会使用回调函数的返回值进行改写。 - -### Plugin:register_note_post_interruptor(fn) -发贴时改写帖子信息。 目标帖子对象作为第一个参数传给回调函数。 该帖子将会使用回调函数的返回值进行改写。 - -### Plugin:open_url(url) -在浏览器的新标签页中打开第一个参数传入的URL。 - -### Plugin:config -存储插件设置的对象。该值是通过插件定义的配置中设置的键值来传入的。 diff --git a/src/docs/zh-CN/advanced/develop-bot.md b/src/docs/zh-CN/advanced/develop-bot.md deleted file mode 100644 index 593c61891e..0000000000 --- a/src/docs/zh-CN/advanced/develop-bot.md +++ /dev/null @@ -1,6 +0,0 @@ -# 新建 Bot -您可以使用 [Misskey API](./api)来开发Bot机器人。此外,一些机器人已经公开发布,您可以把它们作为参考。 - -- [syuilo/ai](https://github.com/syuilo/ai) ... 运行在Node.js上的TypeScript实现的Bot - -创建机器人时,我们强烈建议您在个人资料设置中启用Bot机器人标志。 diff --git a/src/docs/zh-CN/advanced/reversi-bot.md b/src/docs/zh-CN/advanced/reversi-bot.md deleted file mode 100644 index 96a252b382..0000000000 --- a/src/docs/zh-CN/advanced/reversi-bot.md +++ /dev/null @@ -1,160 +0,0 @@ -# Misskey黑白棋机器人开发 -下面列出的是为 Misskey 黑白棋功能开发一个Bot机器人的方法。 - -1. 使用以下参数来连接到`games/reversi`流: - * `i`: bot账号的API Key - -2. 当出现对局邀请时,流中会触发`invited`事件 - * 事件内容中包含邀请您参加游戏的用户信息,用户名字为`parent`。 - -3. 向`games/reversi/match`发送请求,其中`user_id`包含`parent`的`id` - -4. 请求成功时将返回游戏信息,可以使用以下参数连接到`games/reversi-game`流: - * `i`: bot账号的API Key - * `game`: `game`的`id` - -5. 与此同时,每次对手更改游戏设置时,都会触发`update-settings`事件,如果有必要的话,需要对其进行处理。 - -6. 满足设定条件时,向流发送`{ type: 'accept' }`消息 - -7. 游戏开始时会触发`started`事件 - * 游戏状态信息会包含在该事件中 - -8. 要放置棋子,向流发送`{ type: 'set', pos: <位置> }`(后面会说明位置的计算方法) - -9. 当对方或者您放置棋子时,会触发`set`事件 - * `color`中包含该棋子的颜色 - * `pos`中包含该棋子的位置 - -## 位置计算方法 -当棋盘尺寸为8x8时,每个方格的位置(称为索引)如下所示: -``` -+--+--+--+--+--+--+--+--+ -| 0| 1| 2| 3| 4| 5| 6| 7| -+--+--+--+--+--+--+--+--+ -| 8| 9|10|11|12|13|14|15| -+--+--+--+--+--+--+--+--+ -|16|17|18|19|20|21|22|23| -... -``` - -### 从X,Y坐标转换为索引 -``` -pos = x + (y * mapWidth) -``` -`mapWidth`可以根据游戏信息中的`map`,通过如下方法计算出来: -``` -mapWidth = map[0].length -``` - -### 从索引转换为X,Y坐标 -``` -x = pos % mapWidth -y = Math.floor(pos / mapWidth) -``` - -## 棋盘信息 -棋盘信息包含在游戏信息的`map`中。 它是一个字符串数组,每个字符代表一块格子的信息。 您可以根据这些来了解地图如何设计: -* `(空)` ... 没有格子 -* `-` ... 格子 -* `b` ... 黑子先下 -* `w` ... 白子先下 - -以下面这个4*4的简单棋盘为例: -```text -+---+---+---+---+ -| | | | | -+---+---+---+---+ -| | ○ | ● | | -+---+---+---+---+ -| | ● | ○ | | -+---+---+---+---+ -| | | | | -+---+---+---+---+ -``` - -这种情况下,棋盘数据是这样的: -```javascript -['----', '-wb-', '-bw-', '----'] -``` - -## 能和用户互动的交互式Bot机器人的创建 -要和用户交互,您可以在游戏设置屏幕上向用户显示提示窗口。 例如,可以让用户选择Bot机器人的难度。 - -要显示窗口,需要向`reversi-game`流发送下列消息: -```javascript -{ - type: 'init-form', - body: [表单控件数组] -} -``` - -下面说明窗口控件数组的结构。 窗口控件指的是如下面所示的对象: -```javascript -{ - id: 'switch1', - type: 'switch', - label: 'Enable hoge', - value: false -} -``` -`id` ... 控件ID。 `type` ... 控件类型。说明详见后文。 `label` ... 控件元素上显示的文字。 `value` ... 控件元素的默认值。 - -### 控件行为的处理 -当用户与对话框交互时将会触发流的`update-form`事件。 事件的内容包含控件的ID和用户设置的值。 例如,如果用户将上面显示的开关控件打开,则将触发以下事件: -```javascript -{ - id: 'switch1', - value: true -} -``` - -### 窗口控件的类型 -#### 开关 -type: `switch` 显示一个开关。当您想要打开/关闭某些功能时非常有用。 - -##### 属性 -`label` ... 开关上显示的文字。 - -#### 单选按钮 -type: `radio` 显示一个单选按钮。用来表示单项选择。例如,可以选择Bot机器人的难度。 - -##### 属性 -`items` ... 单元按钮的选择项。例: -```javascript -items: [{ - label: '弱', - value: 1 -}, { - label: '中', - value: 2 -}, { - label: '强', - value: 3 -}] -``` - -#### 滑块 -type: `slider` 显示一个滑块。 - -##### 属性 -`min` ... 滑块最小值。 `max` ... 滑块最大值。 `step` ... 滑块值的步长。 - -#### 文本框 -type: `textbox` 显示一个文本框。可以在各种需要用户输入的地方使用。 - -## 向用户显示消息 -设置屏幕上与用户交互,是除了对话框外的另一种方法。您可以向用户显示一条消息。 例如,当用户选择Bot机器人不支持的模式或棋盘时显示警告。 要显示消息,请将以下消息发送到流: -```javascript -{ - type: 'message', - body: { - text: '消息内容', - type: '消息类型' - } -} -``` -消息类型:`success`, `info`, `warning`, `error`。 - -## 认输 -要认输,请发送请求到<a href="./api/endpoints/games/reversi/games/surrender">这个终端</a>。 diff --git a/src/docs/zh-CN/advanced/share-page.md b/src/docs/zh-CN/advanced/share-page.md deleted file mode 100644 index 56f6d5ec19..0000000000 --- a/src/docs/zh-CN/advanced/share-page.md +++ /dev/null @@ -1,54 +0,0 @@ -# 分享页面 -`/share`を開くと、共有用の投稿フォームを開くことができます。 ここではシェアページで利用できるクエリ文字列の一覧を示します。 - -## 查询文本列表 -### 文本 - -<dl> -<dt>title</dt> -<dd>标题。[ … ]将被插入到文本开头。</dd> -<dt>text</dt> -<dd>正文。</dd> -<dt>url</dt> -<dd>URL。它将被插入到末尾。</dd> -</dl> - -### リプライ情報 -以下のいずれか - -<dl> -<dt>replyId</dt> -<dd>リプライ先のノートid</dd> -<dt>replyUri</dt> -<dd>リプライ先のUrl(リモートのノートオブジェクトを指定)</dd> -</dl> - -### Renote情報 -以下のいずれか - -<dl> -<dt>renoteId</dt> -<dd>Renote先のノートid</dd> -<dt>renoteUri</dt> -<dd>Renote先のUrl(リモートのノートオブジェクトを指定)</dd> -</dl> - -### 可见性 -※specifiedに相当する値はvisibility=specifiedとvisibleAccts/visibleUserIdsで指定する - -<dl> -<dt>visibility</dt> -<dd>公開範囲 ['public' | 'home' | 'followers' | 'specified']</dd> -<dt>localOnly</dt> -<dd>0(false) or 1(true)</dd> -<dt>visibleUserIds</dt> -<dd>specified時のダイレクト先のユーザーid カンマ区切りで</dd> -<dt>visibleAccts</dt> -<dd>specified時のダイレクト先のacct(@?username[@host]) カンマ区切りで</dd> -</dl> - -### 文件 -<dl> -<dt>fileIds</dt> -<dd>添付したいファイルのid(カンマ区切りで)</dd> -</dl> diff --git a/src/docs/zh-CN/advanced/stream.md b/src/docs/zh-CN/advanced/stream.md deleted file mode 100644 index 16093e0b96..0000000000 --- a/src/docs/zh-CN/advanced/stream.md +++ /dev/null @@ -1,350 +0,0 @@ -# 流式API - -通过流式API,您可以实时接收各种信息(例如,你的时间线中的新帖文,收到的消息,关注等),并进行各种操作。 - -## 连接到流 - -要使用流式API,您需要使用**websocket**连接到Misskey服务器。 - -请使用参数`i`连接到以下URL,并在websocket连接中包含认证信息。例如: -``` -%WS_URL%/streaming?i=xxxxxxxxxxxxxxx -``` - -认证信息是您的API密钥,从应用程序连接到流时需要引用的用户访问令牌 - -<div class="info">ℹ️ 关于如何获取认证信息,请参考<a href="./api">此文档</a>。</div> - ---- - -您可以省略身份验证信息。此时无需登录即可使用,但是可以接收的信息和可以执行的操作将受到限制。例: - -``` -%WS_URL%/streaming -``` - ---- - -ストリームに接続すると、後述するAPI操作や、投稿の購読を行ったりすることができます。 しかしまだこの段階では、例えばタイムラインへの新しい投稿を受信したりすることはできません。 それを行うには、ストリーム上で、後述する**チャンネル**に接続する必要があります。 - -**ストリームでのやり取りはすべてJSONです。** - -## 频道 -MisskeyのストリーミングAPIにはチャンネルという概念があります。これは、送受信する情報を分離するための仕組みです。 Misskeyのストリームに接続しただけでは、まだリアルタイムでタイムラインの投稿を受信したりはできません。 ストリーム上でチャンネルに接続することで、様々な情報を受け取ったり情報を送信したりすることができるようになります。 - -ひとつのストリーム上で、同時に複数のチャンネルに接続することができます。 - -### 连接到频道 -要连接到频道,请将JSON数据发送到流: - -```json -{ - type: 'connect', - body: { - channel: 'xxxxxxxx', - id: 'foobar', - params: { - ... - } - } -} -``` - -其中: -* `channel`には接続したいチャンネル名を設定します。频道类型将在后面说明。 -* `id`にはそのチャンネルとやり取りするための任意のIDを設定します。ストリームでは様々なメッセージが流れるので、そのメッセージがどのチャンネルからのものなのか識別する必要があるからです。このIDは、UUIDや、乱数のようなもので構いません。 -* `params`はチャンネルに接続する際のパラメータです。チャンネルによって接続時に必要とされるパラメータは異なります。パラメータ不要のチャンネルに接続する際は、このプロパティは省略可能です。 - -<div class="info">ℹ️ IDはチャンネルごとではなく「チャンネルの接続ごと」です。なぜなら、同じチャンネルに異なるパラメータで複数接続するケースもあるからです。</div> - -### 从频道接收消息 -例えばタイムラインのチャンネルなら、新しい投稿があった時にメッセージを発します。そのメッセージを受け取ることで、タイムラインに新しい投稿がされたことをリアルタイムで知ることができます。 - -当频道发送消息时,以下数据将以JSON格式传输到流中: -```json -{ - type: 'channel', - body: { - id: 'foobar', - type: 'something', - body: { - some: 'thing' - } - } -} -``` - -其中: -* `id`には前述したそのチャンネルに接続する際に設定したIDが設定されています。これで、このメッセージがどのチャンネルからのものなのか知ることができます。 -* `type`にはメッセージの種類が設定されます。チャンネルによって、どのような種類のメッセージが流れてくるかは異なります。 -* `body`にはメッセージの内容が設定されます。チャンネルによって、どのような内容のメッセージが流れてくるかは異なります。 - -### 向频道发送消息 -チャンネルによっては、メッセージを受け取るだけでなく、こちらから何かメッセージを送信し、何らかの操作を行える場合があります。 - -要将消息发送到频道,请将JSON格式数据发送到流: -```json -{ - type: 'channel', - body: { - id: 'foobar', - type: 'something', - body: { - some: 'thing' - } - } -} -``` - -其中: -* `id`には前述したそのチャンネルに接続する際に設定したIDを設定します。これで、このメッセージがどのチャンネルに向けたものなのか識別させることができます。 -* `type`にはメッセージの種類を設定します。チャンネルによって、どのような種類のメッセージを受け付けるかは異なります。 -* `body`にはメッセージの内容を設定します。チャンネルによって、どのような内容のメッセージを受け付けるかは異なります。 - -### 断开频道连接 -チャンネルから切断するには、次のようなデータをJSONでストリームに送信します: - -```json -{ - type: 'disconnect', - body: { - id: 'foobar' - } -} -``` - -其中: -* `id`には前述したそのチャンネルに接続する際に設定したIDを設定します。 - -## 通过流发送API请求 - -ストリームを経由してAPIリクエストすると、HTTPリクエストを発生させずにAPIを利用できます。そのため、コードを簡潔にできたり、パフォーマンスの向上を見込めるかもしれません。 - -ストリームを経由してAPIリクエストするには、次のようなデータをJSONでストリームに送信します: -```json -{ - type: 'api', - body: { - id: 'xxxxxxxxxxxxxxxx', - endpoint: 'notes/create', - data: { - text: 'yee haw!' - } - } -} -``` - -其中: -* `id`には、APIのレスポンスを識別するための、APIリクエストごとの一意なIDを設定する必要があります。UUIDや、簡単な乱数のようなもので構いません。 -* `endpoint`には、あなたがリクエストしたいAPIのエンドポイントを指定します。 -* `data`には、エンドポイントのパラメータを含めます。 - -<div class="info">ℹ️ APIのエンドポイントやパラメータについてはAPIリファレンスをご確認ください。</div> - -### レスポンスの受信 - -APIへリクエストすると、レスポンスがストリームから次のような形式で流れてきます。 - -```json -{ - type: 'api:xxxxxxxxxxxxxxxx', - body: { - ... - } -} -``` - -其中: -* `xxxxxxxxxxxxxxxx`の部分には、リクエストの際に設定された`id`が含まれています。これにより、どのリクエストに対するレスポンスなのか判別することができます。 -* `body`には、レスポンスが含まれています。 - -## 投稿のキャプチャ - -Misskeyは投稿のキャプチャと呼ばれる仕組みを提供しています。これは、指定した投稿のイベントをストリームで受け取る機能です。 - -例えばタイムラインを取得してユーザーに表示したとします。ここで誰かがそのタイムラインに含まれるどれかの投稿に対してリアクションしたとします。 - -しかし、クライアントからするとある投稿にリアクションが付いたことなどは知る由がないため、リアルタイムでリアクションをタイムライン上の投稿に反映して表示するといったことができません。 - -この問題を解決するために、Misskeyは投稿のキャプチャ機構を用意しています。投稿をキャプチャすると、その投稿に関するイベントを受け取ることができるため、リアルタイムでリアクションを反映させたりすることが可能になります。 - -### 投稿をキャプチャする - -投稿をキャプチャするには、ストリームに次のようなメッセージを送信します: - -```json -{ - type: 'subNote', - body: { - id: 'xxxxxxxxxxxxxxxx' - } -} -``` - -其中: -* `id`にキャプチャしたい投稿の`id`を設定します。 - -このメッセージを送信すると、Misskeyにキャプチャを要請したことになり、以後、その投稿に関するイベントが流れてくるようになります。 - -例えば投稿にリアクションが付いたとすると、次のようなメッセージが流れてきます: - -```json -{ - type: 'noteUpdated', - body: { - id: 'xxxxxxxxxxxxxxxx', - type: 'reacted', - body: { - reaction: 'like', - userId: 'yyyyyyyyyyyyyyyy' - } - } -} -``` - -其中: -* `body`内の`id`に、イベントを発生させた投稿のIDが設定されます。 -* `body`内の`type`に、イベントの種類が設定されます。 -* `body`内の`body`に、イベントの詳細が設定されます。 - -#### 事件类型 - -##### `reacted` -その投稿にリアクションがされた時に発生します。 - -* `reaction`に、リアクションの種類が設定されます。 -* `userId`に、リアクションを行ったユーザーのIDが設定されます。 - -例: -```json -{ - type: 'noteUpdated', - body: { - id: 'xxxxxxxxxxxxxxxx', - type: 'reacted', - body: { - reaction: 'like', - userId: 'yyyyyyyyyyyyyyyy' - } - } -} -``` - -##### `deleted` -その投稿が削除された時に発生します。 - -* `deletedAt`表示删除的日期和时间。 - -例: -```json -{ - type: 'noteUpdated', - body: { - id: 'xxxxxxxxxxxxxxxx', - type: 'deleted', - body: { - deletedAt: '2018-10-22T02:17:09.703Z' - } - } -} -``` - -##### `pollVoted` -その投稿に添付されたアンケートに投票された時に発生します。 - -* `choice`に、選択肢IDが設定されます。 -* `userId`に、投票を行ったユーザーのIDが設定されます。 - -例: -```json -{ - type: 'noteUpdated', - body: { - id: 'xxxxxxxxxxxxxxxx', - type: 'pollVoted', - body: { - choice: 2, - userId: 'yyyyyyyyyyyyyyyy' - } - } -} -``` - -### 投稿のキャプチャを解除する - -その投稿がもう画面に表示されなくなったりして、その投稿に関するイベントをもう受け取る必要がなくなったときは、キャプチャの解除を申請してください。 - -次のメッセージを送信します: - -```json -{ - type: 'unsubNote', - body: { - id: 'xxxxxxxxxxxxxxxx' - } -} -``` - -其中: -* `id`にキャプチャを解除したい投稿の`id`を設定します。 - -このメッセージを送信すると、以後、その投稿に関するイベントは流れてこないようになります。 - -# チャンネル一覧 -## `main` -アカウントに関する基本的な情報が流れてきます。このチャンネルにパラメータはありません。 - -### 流れてくるイベント一覧 - -#### `renote` -自分の投稿がRenoteされた時に発生するイベントです。自分自身の投稿をRenoteしたときは発生しません。 - -#### `mention` -誰かからメンションされたときに発生するイベントです。 - -#### `readAllNotifications` -自分宛ての通知がすべて既読になったことを表すイベントです。このイベントを利用して、「通知があることを示すアイコン」のようなものをオフにしたりする等のケースが想定されます。 - -#### `meUpdated` -自分の情報が更新されたことを表すイベントです。 - -#### `follow` -自分が誰かをフォローしたときに発生するイベントです。 - -#### `unfollow` -自分が誰かのフォローを解除したときに発生するイベントです。 - -#### `followed` -自分が誰かにフォローされたときに発生するイベントです。 - -## `homeTimeline` -ホームタイムラインの投稿情報が流れてきます。このチャンネルにパラメータはありません。 - -### 流れてくるイベント一覧 - -#### `note` -タイムラインに新しい投稿が流れてきたときに発生するイベントです。 - -## `localTimeline` -ローカルタイムラインの投稿情報が流れてきます。このチャンネルにパラメータはありません。 - -### 流れてくるイベント一覧 - -#### `note` -ローカルタイムラインに新しい投稿が流れてきたときに発生するイベントです。 - -## `hybridTimeline` -ソーシャルタイムラインの投稿情報が流れてきます。このチャンネルにパラメータはありません。 - -### 流れてくるイベント一覧 - -#### `note` -ソーシャルタイムラインに新しい投稿が流れてきたときに発生するイベントです。 - -## `globalTimeline` -グローバルタイムラインの投稿情報が流れてきます。このチャンネルにパラメータはありません。 - -### 流れてくるイベント一覧 - -#### `note` -グローバルタイムラインに新しい投稿が流れてきたときに発生するイベントです。 |