Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
Sharkey
Manage
Activity
Members
Labels
Plan
Issues
337
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
25
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
TransFem.org
Sharkey
Commits
56958d23
Unverified
Commit
56958d23
authored
3 years ago
by
syuilo
Committed by
GitHub
3 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Update README.md
parent
b11c00cc
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+16
-6
16 additions, 6 deletions
README.md
with
16 additions
and
6 deletions
README.md
+
16
−
6
View file @
56958d23
...
...
@@ -37,6 +37,10 @@ const meta = await cli.request('meta', { detail: true });
```
## Streaming
misskey.jsのストリーミングでは、二つのクラスが提供されます。
ひとつは、ストリーミングのコネクション自体を司る
`Stream`
クラスと、もうひとつはストリーミングのチャンネルの概念を表す
`Channel`
クラスです。
ストリーミングを利用する際は、まず
`Stream`
クラスのインスタンスを初期化し、その後で
`Stream`
インスタンスのメソッドを利用して
`Channel`
クラスのインスタンスを取得する形になります。
```
ts
import
*
as
Misskey
from
'
misskey-js
'
;
...
...
@@ -50,7 +54,7 @@ mainChannel.on('notification', notification => {
コネクションが途切れても自動で再接続されます。
### チャンネルへの接続
チャンネルへの接続は
`useChannel`
メソッドを使用します。
チャンネルへの接続は
`
Stream`
クラスの
`
useChannel`
メソッドを使用します。
パラメータなし
```
ts
...
...
@@ -69,7 +73,7 @@ const messagingChannel = stream.useChannel('messaging', {
```
### チャンネルから切断
`dispose`
メソッドを呼び出します。
`Channel`
クラスの
`dispose`
メソッドを呼び出します。
```
ts
const
stream
=
new
Misskey
.
Stream
(
'
https://misskey.test
'
,
{
token
:
'
TOKEN
'
});
...
...
@@ -80,7 +84,7 @@ mainChannel.dispose();
```
### メッセージの受信
チャンネル接続インスタン
スはEventEmitterを継承しており、メッセージがサーバーから受信されると受け取ったイベント名でペイロードをemitします。
`Channel`
クラ
スはEventEmitterを継承しており、メッセージがサーバーから受信されると受け取ったイベント名でペイロードをemitします。
```
ts
import
*
as
Misskey
from
'
misskey-js
'
;
...
...
@@ -93,7 +97,7 @@ mainChannel.on('notification', notification => {
```
### メッセージの送信
チャンネル接続インスタン
スの
`send`
メソッドを使用してメッセージをサーバーに送信することができます。
`Channel`
クラ
スの
`send`
メソッドを使用してメッセージをサーバーに送信することができます。
```
ts
import
*
as
Misskey
from
'
misskey-js
'
;
...
...
@@ -109,7 +113,7 @@ messagingChannel.send('read', {
```
### コネクション確立イベント
ストリーミングインスタン
スの
`_connected_`
イベントが利用可能です。
`Stream`
クラ
スの
`_connected_`
イベントが利用可能です。
```
ts
import
*
as
Misskey
from
'
misskey-js
'
;
...
...
@@ -121,7 +125,7 @@ stream.on('_connected_', () => {
```
### コネクション切断イベント
ストリーミングインスタン
スの
`_disconnected_`
イベントが利用可能です。
`Stream`
クラ
スの
`_disconnected_`
イベントが利用可能です。
```
ts
import
*
as
Misskey
from
'
misskey-js
'
;
...
...
@@ -132,6 +136,12 @@ stream.on('_disconnected_', () => {
});
```
### コネクションの状態
`Stream`
クラスの
`state`
プロパティで確認できます。
-
`initializing`
: 接続確立前
-
`connected`
: 接続完了
-
`reconnecting`
: 再接続中
---
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment