Update doc
This commit is contained in:
parent
7b5d6dcd9b
commit
bdcf09c618
|
@ -2,6 +2,8 @@
|
||||||
|
|
||||||
ストリーミングAPIを使うと、リアルタイムで様々な情報(例えばタイムラインに新しい投稿が流れてきた、メッセージが届いた、フォローされた、など)を受け取ったり、HTTPリクエストを発生させることなくAPIにアクセスしたりすることができます。
|
ストリーミングAPIを使うと、リアルタイムで様々な情報(例えばタイムラインに新しい投稿が流れてきた、メッセージが届いた、フォローされた、など)を受け取ったり、HTTPリクエストを発生させることなくAPIにアクセスしたりすることができます。
|
||||||
|
|
||||||
|
ストリーミングAPIは複数の種類がありますが、ここではメインとなる「ホームストリーム」について説明します。
|
||||||
|
|
||||||
## ストリームに接続する
|
## ストリームに接続する
|
||||||
|
|
||||||
以下のURLに**websocket**接続します。
|
以下のURLに**websocket**接続します。
|
||||||
|
@ -113,3 +115,13 @@ Misskeyは投稿のキャプチャと呼ばれる仕組みを提供していま
|
||||||
`id`には、キャプチャを解除したい投稿の`id`を設定します。
|
`id`には、キャプチャを解除したい投稿の`id`を設定します。
|
||||||
|
|
||||||
このメッセージを送信すると、以後、その投稿に関するイベントは流れてこないようになります。
|
このメッセージを送信すると、以後、その投稿に関するイベントは流れてこないようになります。
|
||||||
|
|
||||||
|
## 流れてくるイベント一覧
|
||||||
|
|
||||||
|
流れてくるすべてのメッセージはJSON形式で、必ず`type`というプロパティが含まれています。これにより、メッセージの種類(イベント)を判別することができます。
|
||||||
|
|
||||||
|
### `note`
|
||||||
|
|
||||||
|
タイムラインに新しい投稿が流れてきたときに発生するイベントです。
|
||||||
|
|
||||||
|
`body`プロパティの中に、投稿情報が含まれています。
|
||||||
|
|
Loading…
Reference in New Issue