شعار أوراباسي
aurabaseمستندات
مستندات›JavaScript SDK reference›Realtime reference

JavaScript SDK: مرجع في الوقت الفعلي

كل طريقة من طرق الخدمة الفعلية والقنوات وتوقيعها.

6 د قراءة·المستوى مرجع·تمت المراجعة في 12‏/10‏/2026
تم إنشاء هذا النص الإنجليزي تلقائيًا من النص الأصلي الفرنسي ولم تتم مراجعته بعد.
تمت ترجمة هذه الصفحة تلقائيًا. النسخة الإنجليزية موثوقة.
#
فئة

خدمة الوقت الحقيقي

الملكيةالوصف
get connectionState(): ConnectionStateحالة الاتصال الحالية.
get isConnected(): booleanما إذا كان WebSocket متصلاً حاليًا.
الطريقةالوصف
onStateChange(callback: (state: ConnectionState) => void): () => voidاستمع لتغييرات حالة الاتصال.
onError(callback: (err: RealtimeConnectionError) => void): () => voidاستمع لأخطاء نقل الاتصال في الوقت الفعلي.
connect(): voidتأكد من أن اتصال WebSocket مفتوح.
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>>يرسل بثًا عبر HTTP (REST)، بدون اتصال WebSocket مفتوح (التكافؤ @supabase/realtime-js).
setAutoReconnect(enabled: boolean, maxAttempts?: number): voidتمكين/تعطيل إعادة الاتصال التلقائي (ممكّن افتراضيًا).
disconnect(): voidافصل WebSocket وقم بتنظيف كافة القنوات.
channel(name: string, options?: ChannelConfig): AuraChannelإنشاء أو استرداد قناة بالاسم.
removeChannel(channel: string | AuraChannel): voidقم بإزالة قناة بالاسم أو بمثيل AuraChannel.
getChannels(): AuraChannel[]قائمة القنوات النشطة.
removeAllChannels(): voidإزالة كافة القنوات والاشتراكات.
#
فئة

قناة الهالة

قناة في الوقت الفعلي مع واجهة برمجة التطبيقات القابلة للتسلسل Supabase.

الملكيةالوصف
readonly name: stringاسم القناة كما تم تمريره إلى realtime.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		تسجيل مستمع لأحداث PostgreSQL (CDC) مع تصفية INSERT.
off(type?: RealtimeListenType, filter?: PostgresChangesFilter | BroadcastFilter | PresenceFilter, callback?: (payload: unknown) => void): thisإزالة مستمع واحد أو أكثر من القناة دون إغلاق القناة أو قطع WebSocket.
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، لذلك لا يمكن أن تنحرف عن التعليمات البرمجية المنشورة. للحصول على أمثلة عملية، اقرأ الأدلة.