メインコンテンツまでスキップ
バージョン: 0.4.2

💬 チャットフィーチャーブロック

チャットフィーチャーブロックは、Nodeblocksアプリケーションにおけるリアルタイム通信管理のための完全な事前構成済み機能を提供します。これらのフィーチャーは、チャンネル、メッセージ、サブスクリプション管理のための即座に使用可能なAPIエンドポイントを作成するために、スキーマ、ルート、ハンドラーを組み合わせます。


🎯 概要

チャットフィーチャーブロックは以下を目的として設計されています:

  • チャットチャンネル管理によるリアルタイム通信の実現
  • メッセージ交換と履歴管理のサポート
  • サブスクリプション管理による通知システムの構築
  • 安全なチャット操作のための検証とルーティングの実装
  • マルチチャンネル通信アーキテクチャの提供

🔧 利用可能なチャットフィーチャー

📺 チャンネルフィーチャー

createChannelFeature

チャンネル作成機能。

目的: 新しいチャットチャンネルの作成を処理

使用方法:

import { features } from '@nodeblocks/backend-sdk';

app.use('/api', defService(partial(features.createChannelFeature, [{ dataStores: db }])));

APIエンドポイント: POST /api/channels


getChannelFeature

チャンネル取得機能。

目的: 特定チャンネルの詳細情報を取得

APIエンドポイント: GET /api/channels/:channelId


findChannelsFeature

チャンネル検索機能。

目的: フィルタリングとページネーション付きチャンネルリストの提供

APIエンドポイント: GET /api/channels


updateChannelFeature

チャンネル更新機能。

目的: チャンネル情報の変更を処理

APIエンドポイント: PUT /api/channels/:channelId


deleteChannelFeature

チャンネル削除機能。

目的: チャンネルと関連データの削除を処理

APIエンドポイント: DELETE /api/channels/:channelId


💬 メッセージフィーチャー

createChatMessageFeature

チャットメッセージ作成機能。

目的: 新しいメッセージの送信を処理

APIエンドポイント: POST /api/messages


getChatMessageFeature

チャットメッセージ取得機能。

目的: 特定メッセージの詳細情報を取得

APIエンドポイント: GET /api/messages/:messageId


findChatMessagesFeature

チャットメッセージ検索機能。

目的: フィルタリングとページネーション付きメッセージ履歴の提供

APIエンドポイント: GET /api/messages


updateChatMessageFeature

チャットメッセージ更新機能。

目的: メッセージ内容の編集を処理

APIエンドポイント: PUT /api/messages/:messageId


deleteChatMessageFeature

チャットメッセージ削除機能。

目的: メッセージの削除を処理

APIエンドポイント: DELETE /api/messages/:messageId


🔔 サブスクリプションフィーチャー

createChatSubscriptionFeature

チャットサブスクリプション作成機能。

目的: 新しい通知サブスクリプションの作成を処理

APIエンドポイント: POST /api/subscriptions


getChatSubscriptionFeature

チャットサブスクリプション取得機能。

目的: 特定サブスクリプションの詳細情報を取得

APIエンドポイント: GET /api/subscriptions/:subscriptionId


findChatSubscriptionsFeature

チャットサブスクリプション検索機能。

目的: フィルタリングとページネーション付きサブスクリプションリストの提供

APIエンドポイント: GET /api/subscriptions


deleteChatSubscriptionFeature

チャットサブスクリプション削除機能。

目的: サブスクリプションの削除を処理

APIエンドポイント: DELETE /api/subscriptions/:subscriptionId


🔗 関連ドキュメント