認証情報の取得については、こちらのドキュメントをご確認ください。
+--- + +認証情報は省略することもできますが、その場合非ログインでの利用ということになり、受信できる情報や可能な操作は限られます。例: + +``` +%URL%/streaming +``` + +--- + +ストリームに接続すると、後述するAPI操作や、投稿の購読を行ったりすることができます。 +しかしまだこの段階では、例えばタイムラインへの新しい投稿を受信したりすることはできません。 +それを行うには、ストリーム上で、後述する**チャンネル**に接続する必要があります。 + +**ストリームでのやり取りはすべてJSONです。** + +## チャンネル +MisskeyのストリーミングAPIにはチャンネルという概念があります。これは、送受信する情報を分離するための仕組みです。 +Misskeyのストリームに接続しただけでは、まだリアルタイムでタイムラインの投稿を受信したりはできません。 +ストリーム上でチャンネルに接続することで、様々な情報を受け取ったり情報を送信したりすることができるようになります。 + +### チャンネルに接続する +チャンネルに接続するには、次のようなデータをJSONでストリームに送信します: + +```json +{ + type: 'connect', + body: { + channel: 'xxxxxxxx', + id: 'foobar', + params: { + ... + } + } +} +``` + +ここで、 +* `channel`には接続したいチャンネル名を設定します。チャンネルの種類については後述します。 +* `id`にはそのチャンネルとやり取りするための任意のIDを設定します。ストリームでは様々なメッセージが流れるので、そのメッセージがどのチャンネルからのものなのか識別する必要があるからです。このIDは、UUIDや、乱数のようなもので構いません。 +* `params`はチャンネルに接続する際のパラメータです。チャンネルによって接続時に必要とされるパラメータは異なります。パラメータ不要のチャンネルに接続する際は、このプロパティは省略可能です。 + +IDはチャンネルごとではなく「チャンネルの接続ごと」です。なぜなら、同じチャンネルに異なるパラメータで複数接続するケースもあるからです。
+APIのエンドポイントやパラメータについてはAPIリファレンスをご確認ください。
@@ -62,9 +160,9 @@ APIへリクエストすると、レスポンスがストリームから次の } ``` -`xxxxxxxxxxxxxxxx`の部分には、リクエストの際に設定された`id`が含まれています。これにより、どのリクエストに対するレスポンスなのか判別することができます。 - -`body`には、レスポンスが含まれています。 +ここで、 +* `xxxxxxxxxxxxxxxx`の部分には、リクエストの際に設定された`id`が含まれています。これにより、どのリクエストに対するレスポンスなのか判別することができます。 +* `body`には、レスポンスが含まれています。 ## 投稿のキャプチャ @@ -82,12 +180,15 @@ Misskeyは投稿のキャプチャと呼ばれる仕組みを提供していま ```json { - type: 'capture', - id: 'xxxxxxxxxxxxxxxx' + type: 'subNote', + body: { + id: 'xxxxxxxxxxxxxxxx' + } } ``` -`id`には、キャプチャしたい投稿の`id`を設定します。 +ここで、 +* `id`にキャプチャしたい投稿の`id`を設定します。 このメッセージを送信すると、Misskeyにキャプチャを要請したことになり、以後、その投稿に関するイベントが流れてくるようになります。 @@ -97,22 +198,83 @@ Misskeyは投稿のキャプチャと呼ばれる仕組みを提供していま { type: 'noteUpdated', body: { - note: { - ... + id: 'xxxxxxxxxxxxxxxx', + type: 'reacted', + body: { + reaction: 'like', + userId: 'yyyyyyyyyyyyyyyy' } } } ``` -`body`内の`note`には、その投稿の最新の情報が含まれています。 +ここで、 +* `body`内の`id`に、イベントを発生させた投稿のIDが設定されます。 +* `body`内の`type`に、イベントの種類が設定されます。 +* `body`内の`body`に、イベントの詳細が設定されます。 ---- +#### イベントの種類 -このように、投稿の情報が更新されると、`noteUpdated`イベントが流れてくるようになります。`noteUpdated`イベントが発生するのは、以下の場合です: +##### `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' + } + } +} +``` ### 投稿のキャプチャを解除する @@ -122,62 +284,49 @@ Misskeyは投稿のキャプチャと呼ばれる仕組みを提供していま ```json { - type: 'decapture', - id: 'xxxxxxxxxxxxxxxx' + type: 'unsubNote', + body: { + id: 'xxxxxxxxxxxxxxxx' + } } ``` -`id`には、キャプチャを解除したい投稿の`id`を設定します。 +ここで、 +* `id`にキャプチャを解除したい投稿の`id`を設定します。 このメッセージを送信すると、以後、その投稿に関するイベントは流れてこないようになります。 -## 流れてくるイベント一覧 +# チャンネル一覧 +## `main` +アカウントに関する基本的な情報が流れてきます。このチャンネルにパラメータはありません。 -流れてくるすべてのメッセージはJSON形式で、必ず`type`というプロパティが含まれています。これにより、メッセージの種類(イベント)を判別することができます。 - -### `note` - -タイムラインに新しい投稿が流れてきたときに発生するイベントです。 - -`body`プロパティの中に、投稿情報が含まれています。 - -### `renote` +### 流れてくるイベント一覧 +#### `renote` 自分の投稿がRenoteされた時に発生するイベントです。自分自身の投稿をRenoteしたときは発生しません。 -`body`プロパティの中に、Renoteされた投稿情報が含まれています。 - -### `mention` - +#### `mention` 誰かからメンションされたときに発生するイベントです。 -`body`プロパティの中に、投稿情報が含まれています。 - -### `readAllNotifications` - +#### `readAllNotifications` 自分宛ての通知がすべて既読になったことを表すイベントです。このイベントを利用して、「通知があることを示すアイコン」のようなものをオフにしたりする等のケースが想定されます。 -### `meUpdated` - +#### `meUpdated` 自分の情報が更新されたことを表すイベントです。 -`body`プロパティの中に、最新の自分のアカウントの情報が含まれています。 - -### `follow` - +#### `follow` 自分が誰かをフォローしたときに発生するイベントです。 -`body`プロパティの中に、フォローしたユーザーの情報が含まれています。 - -### `unfollow` - +#### `unfollow` 自分が誰かのフォローを解除したときに発生するイベントです。 -`body`プロパティの中に、フォロー解除したユーザーの情報が含まれています。 - -### `followed` - +#### `followed` 自分が誰かにフォローされたときに発生するイベントです。 -`body`プロパティの中に、フォローしてきたユーザーの情報が含まれています。 +## `homeTimeline` +ホームタイムラインの投稿情報が流れてきます。このチャンネルにパラメータはありません。 +### 流れてくるイベント一覧 + +#### `note` +タイムラインに新しい投稿が流れてきたときに発生するイベントです。 diff --git a/src/docs/style.styl b/src/docs/style.styl index 70d77b5499..4af0f288b0 100644 --- a/src/docs/style.styl +++ b/src/docs/style.styl @@ -1,6 +1,9 @@ @import "../client/style" @import "./ui" +html + --primary #fb4e4e + body margin 0 color #34495e