メインコンテンツまでスキップ

misskey_streamingからの移行

Streaming は misskey_client に統合されました。すべての呼び出し元を移行後、単独の misskey_streaming 依存を削除し、issue #30を含む最初の misskey_client リリースを使用してください。

クライアントと購読

// 移行前
final streaming = MisskeyStreaming.create(
origin: Uri.parse('https://misskey.example.com'),
token: token,
);
final handle = await streaming.subscribeChannelStream(
channel: 'homeTimeline',
);

// 移行後
final client = MisskeyClient(
config: MisskeyClientConfig(
baseUrl: Uri.parse('https://misskey.example.com'),
),
tokenProvider: () => token,
streamingConfig: MisskeyStreamingConfig(),
);
await client.streaming.connect();
final home = await client.streaming.subscribe(
const MisskeyStreamingChannel.homeTimeline(),
);

MisskeyStreaming.fromClient() は不要です。フォーク固有チャンネルには subscribeRaw() を使い、非同期になった unsubscribe()await してください。

既存の void oldLogger(String level, String message) callbackは FunctionLogger(oldLogger) でラップしてclientの logger に渡し、MisskeyClientConfig.enableLogtrue にします。

旧API統合API
handle.streammessages / events / notes / notifications
messagesFor(id)対象ハンドルの messages
captureNote(handle.id, noteId)handle.captureNote(noteId)
MisskeyMessageMisskeyStreamingMessage
status / isConnectedstateChanges / state == MisskeyStreamingConnectionState.connected
originMisskeyClientConfig.baseUrl
tokenProvider / logger callbacktokenProvider / logger: FunctionLogger(oldLogger)enableLog: true
再接続設定MisskeyStreamingConfig
pingInterval廃止(公開application-level ping設定なし)
customHeaders / protocols公開設定なし
exceptionMapper型付き例外と errors

キャプチャ操作は home.captureNote(noteId) / home.uncaptureNote(noteId) に移動します。再利用する場合は disconnect()、完全終了は dispose() または MisskeyClient.dispose() を使用します。sendToChannel() の公開代替はありません。

詳細はStreaming APIガイド完全な移行リファレンスを参照してください。