オーラベースのロゴ
オーラベースドキュメント
ドキュメント›JavaScript SDK reference›Realtime reference

JavaScript SDK: リアルタイムリファレンス

リアルタイム サービスとチャネルのすべてのメソッドとその署名。

6 分 読み取り·レベル 参照·2026/10/12 に改訂
この英語のテキストはフランス語のオリジナルから自動的に生成されたもので、まだレビューされていません。
このページは自動翻訳されました。英語版が正式です。
#
クラス

リアルタイムサービス

プロパティ説明
get connectionState(): ConnectionState現在の接続状態。
get isConnected(): booleanWebSocket が現在接続されているかどうか。
方法説明
onStateChange(callback: (state: ConnectionState) => void): () => void接続状態の変化をリッスンします。
onError(callback: (err: RealtimeConnectionError) => void): () => voidリアルタイム接続トランスポート エラーをリッスンします。
connect(): voidWebSocket 接続が開いていることを確認してください。
refreshToken(token: string): void既存の接続で JWT トークンを更新します (切断なし)。
setAuth(token?: string): voidプライベートおよびブロードキャスト チャネルの承認に使用されるトークンを明示的に定義/更新します (パリティ @supabase/realtime-js setAuth)。
httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>>オープンな WebSocket 接続 (パリティ @supabase/realtime-js) を使用せずに、HTTP (REST) 経由でブロードキャストを送信します。
setAutoReconnect(enabled: boolean, maxAttempts?: number): void自動再接続を有効/無効にします (デフォルトで有効)。
disconnect(): voidWebSocket を切断し、すべてのチャネルをクリーンアップします。
channel(name: string, options?: ChannelConfig): AuraChannelチャネルを名前で作成または取得します。
removeChannel(channel: string | AuraChannel): void名前または AuraChannel インスタンスによってチャネルを削除します。
getChannels(): AuraChannel[]アクティブなチャネルをリストします。
removeAllChannels(): voidすべてのチャンネルとサブスクリプションを削除します。
#
クラス

オーラチャンネル

Supabaseと互換性のあるチェーン可能な API を備えたリアルタイム チャネル。

プロパティ説明
readonly name: stringrealtime.channel(name)に渡されるチャネル名。
get fullName(): stringプロジェクトプレフィックスを含む完全なチャネル名 (サーバープロトコル用)
get isSubscribed(): booleanこのチャンネルが登録されているかどうか。
方法説明
on<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter & { event: 'INSERT'; }, callback: (payload: RealtimePostgresInsertPayload<TRow>) => void): AuraChannelSubscription
on<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter & { event: 'UPDATE'; }, callback: (payload: RealtimePostgresUpdatePayload<TRow>) => void): AuraChannelSubscription
on<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter & { event: 'DELETE'; }, callback: (payload: RealtimePostgresDeletePayload<TRow>) => void): AuraChannelSubscription
on<TRow = Record<string, unknown>>(type: 'postgres_changes', filter: PostgresChangesFilter, callback: (payload: RealtimePostgresChangesPayload<TRow>) => void): AuraChannelSubscription
on<TPayload = Record<string, unknown>>(type: 'broadcast', filter: BroadcastFilter, callback: (payload: RealtimeBroadcastEvent<TPayload>) => void): AuraChannelSubscription
on(type: 'presence', filter: PresenceFilter, callback: (payload: PresenceState | RealtimeEvent | Record<string, unknown>) => void): AuraChannelSubscription		INSERT フィルタリングを使用して PostgreSQL (CDC) イベントのリスナーを登録します。
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): thisチャネルを閉じたり、WebSocket を切断したりせずに、チャネルから 1 つ以上のリスナーを削除します。
subscribe(callback?: SubscribeCallback, timeoutMs?: number): thisチャンネル登録してください。
unsubscribe(): voidチャンネル登録を解除します。
send(message: BroadcastPayload): Promise<BroadcastSendStatus>チャネル上でブロードキャスト メッセージを送信します。
track(state: Record<string, unknown>): Promise<'ok' | 'error'>このクライアントのプレゼンス状態を追跡します。
untrack(): Promise<'ok' | 'error'>プレゼンスの追跡を停止します。
presenceState(): PresenceStateこのチャネルの現在のプレゼンス状態を取得します。
生成されたページ

このページは SDK の型宣言とコメントから生成されるため、公開されたコードから逸脱することはできません。実用的な例については、ガイドを参照してください。