Logo Aurabase
aurabasedocumenti
documenti›JavaScript SDK reference›Realtime reference

SDK JavaScript: riferimento in tempo reale

Ogni metodo del servizio realtime e dei canali, con la sua firma.

6 min letto·Livello riferimento·Revisionato il 12 ott 2026
Questo testo inglese è stato generato automaticamente dall'originale francese e non è stato ancora rivisto.
Questa pagina è stata tradotta automaticamente. Fa fede la versione inglese.
#
Classe

Servizio in tempo reale

ProprietàDescrizione
get connectionState(): ConnectionStateStato della connessione attuale.
get isConnected(): booleanSe il WebSocket è attualmente connesso.
MetodoDescrizione
onStateChange(callback: (state: ConnectionState) => void): () => voidAscolta i cambiamenti dello stato della connessione.
onError(callback: (err: RealtimeConnectionError) => void): () => voidAscolta gli errori di trasporto della connessione in tempo reale.
connect(): voidAssicurati che la connessione WebSocket sia aperta.
refreshToken(token: string): voidAggiorna il token JWT su una connessione esistente (nessuna disconnessione).
setAuth(token?: string): voidDefinisce/aggiorna esplicitamente il token utilizzato per l'autorizzazione dei canali privati e broadcast (parità @supabase/realtime-js setAuth).
httpBroadcast(channel: string, event: string, payload?: Record<string, unknown>, options?: HttpBroadcastOptions): Promise<AuraResponse<null>>Invia una trasmissione tramite HTTP (REST), senza una connessione WebSocket aperta (parità @supabase/realtime-js).
setAutoReconnect(enabled: boolean, maxAttempts?: number): voidAbilita/disabilita la riconnessione automatica (abilitata per impostazione predefinita).
disconnect(): voidDisconnetti il WebSocket e pulisci tutti i canali.
channel(name: string, options?: ChannelConfig): AuraChannelCrea o recupera un canale per nome.
removeChannel(channel: string | AuraChannel): voidRimuovi un canale per nome o per istanza AuraChannel.
getChannels(): AuraChannel[]Elenca i canali attivi.
removeAllChannels(): voidRimuovi tutti i canali e le iscrizioni.
#
Classe

AuraChannel

Un canale in tempo reale con API concatenabile compatibile con Supabase.

ProprietàDescrizione
readonly name: stringNome del canale passato a realtime.channel(name).
get fullName(): stringNome completo del canale con prefisso del progetto (per protocollo server)
get isSubscribed(): booleanSe questo canale è stato iscritto.
MetodoDescrizione
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
Registra un listener per eventi PostgreSQL (CDC) con filtro INSERT.
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): thisRimuove uno o più ascoltatori dal canale senza chiudere il canale o tagliare il WebSocket.
subscribe(callback?: SubscribeCallback, timeoutMs?: number): thisIscriviti al canale.
unsubscribe(): voidAnnulla l'iscrizione al canale.
send(message: BroadcastPayload): Promise<BroadcastSendStatus>Invia un messaggio broadcast sul canale.
track(state: Record<string, unknown>): Promise<'ok' | 'error'>Tieni traccia dello stato di presenza per questo client.
untrack(): Promise<'ok' | 'error'>Interrompere il monitoraggio della presenza.
presenceState(): PresenceStateOttieni lo stato di presenza corrente per questo canale.
Pagina generata

Questa pagina viene generata dalle dichiarazioni di tipo e dai commenti dell'SDK, quindi non può derivare dal codice pubblicato. Per esempi pratici, leggi le guide.

Ultimo aggiornamento · 12 ott 2026