JavaScript SDK: مرجع الإشعارات
كل طريقة لإرسال وإدارة الإخطارات مع التوقيع الخاص بها.
6 د قراءة·المستوى مرجع·تمت المراجعة في 12/10/2026
تم إنشاء هذا النص الإنجليزي تلقائيًا من النص الأصلي الفرنسي ولم تتم مراجعته بعد.
تمت ترجمة هذه الصفحة تلقائيًا. النسخة الإنجليزية موثوقة.
#
فئة
خدمة الإخطارات
| الملكية | الوصف |
|---|---|
readonly admin: NotificationsAdminService | العميل الفرعي للإدارة: الإحصائيات وقائمة الانتظار والخردة (DLQ) وسجلات الموردين والأحداث والقواعد والإعدادات. |
| الطريقة | الوصف |
|---|---|
send(options: SendNotificationOptions): Promise<AuraResponse<Notification>>send(channel: NotificationChannel, recipient: string, body: string, options?: { subject?: string; templateId?: string; variables?: Record<string, unknown>; metadata?: Record<string, unknown>; idempotencyKey?: string; }): Promise<AuraResponse<Notification>> | يصطف الإشعار ليتم إرساله (Modern Object API). |
sendBatch(items: Array<SendNotificationRequest | SendNotificationItem>): Promise<AuraResponse<BatchSendResponse>> | يرسل مجموعة من الإخطارات (POST /send/batch). |
sendEmail(recipient: string, subject: string, body: string, options?: SendEmailOptions): Promise<AuraResponse<Notification>> | يرسل بريدًا إلكترونيًا للمعاملات (channel: 'email'). |
sendSms(recipient: string, body: string, options?: SendSmsOptions): Promise<AuraResponse<Notification>> | يرسل رسالة نصية قصيرة خاصة بالمعاملات (channel: 'sms'). |
sendPush(recipient: string, title: string, body: string, options?: SendPushOptions): Promise<AuraResponse<Notification>> | يرسل إشعار دفع عبر الهاتف المحمول (channel: 'push' أو FCM أو APNs). |
sendWebhook(targetUrl: string, event: string, payload: string | Record<string, unknown>, options?: SendWebhookOptions): Promise<AuraResponse<Notification>> | يصدر خطاف ويب صادرًا لـ HTTP POST (channel: 'webhook'). |
retry(id: string): Promise<AuraResponse<Notification>> | أعد محاولة تلقي إشعار فاشل (status: 'failed' أو 'dead_lettered'). |
list(options?: { channel?: NotificationChannel; status?: NotificationStatus; search?: string; sort?: 'created_at' | 'updated_at' | 'status'; order?: 'asc' | 'desc'; limit?: number; offset?: number; }): Promise<AuraResponse<Notification[]>> | يسرد سجل إشعارات المشروع، الذي يمكن تصفيته حسب channel و status و search، مرتبة حسب created_at, updated_at أو status، مع ترقيم الصفحات limit / offset. |
get(id: string): Promise<AuraResponse<Notification>> | يقرأ الإخطار عن طريق معرفه. |
listTemplates(): Promise<AuraResponse<NotificationTemplate[]>> | يسرد قوالب رسائل المشروع. |
getTemplate(id: string): Promise<AuraResponse<NotificationTemplate>> | يقرأ قالب الرسالة بواسطة معرفه. |
createTemplate(template: Omit<NotificationTemplate, 'id' | 'project_id' | 'created_at' | 'updated_at'>): Promise<AuraResponse<NotificationTemplate>> | ينشئ قالبًا — name و channel و subject و body ولا شيء آخر. |
updateTemplate(id: string, updates: Partial<Pick<NotificationTemplate, 'name' | 'subject' | 'body'>>): Promise<AuraResponse<NotificationTemplate>> | يقوم بتحديث القالب: name و/أو subject و/أو body. |
deleteTemplate(id: string): Promise<AuraResponse<null>> | حذف قالب الرسالة. |
#
فئة
خدمة الإخطارات
| الطريقة | الوصف |
|---|---|
getSettings(): Promise<AuraResponse<NotificationSettingsPublic>> | يسترد المورد العام للمشروع وإعدادات الحصص (GET /settings). |
updateSettings(settings: NotificationSettingsPatch | Partial<NotificationSettings>): Promise<AuraResponse<NotificationSettingsPublic>> | يقوم بتحديث إعدادات مورد المشروع أو الحصص (PATCH /settings). |
getStats(options?: { window?: NotificationStatsWindow; channel?: NotificationChannel; }): Promise<AuraResponse<NotificationStats>> | إحصائيات الإرسال المجمعة (GET /stats). |
getQueue(): Promise<AuraResponse<NotificationQueueStats>> | يقرأ حالة قائمة انتظار الإرسال: عمق الإخطارات المعلقة وتوزيعها. |
listAttempts(notificationId: string): Promise<AuraResponse<NotificationAttempt[]>> | يسرد محاولات إرسال إشعار، مع استجابة الموفر لكل منها. |
listDeadLetters(options?: { channel?: NotificationChannel; search?: string; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationDeadLetter[]>> | يسرد الإشعارات الموضوعة في قائمة انتظار البيانات المهملة (DLQ)، والتي يمكن تصفيتها بواسطة channel وsearch. |
retryDeadLetter(id: string): Promise<AuraResponse<Notification>> | إعادة إرسال إشعار محدد من قائمة انتظار الخردة (DLQ). |
listEvents(options?: { status?: 'received' | 'matched' | 'ignored' | 'failed' | 'enqueued'; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationEvent[]>> | يسرد الأحداث التي يتلقاها محرك القواعد، ويمكن تصفيتها بواسطة status. |
listProviderLogs(options?: { channel?: NotificationChannel; status?: NotificationAttemptStatus; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationProviderLog[]>> | سجلات تنفيذ بائعي الطرف الثالث (GET /providers/logs). |
previewTemplate(id: string, variables: Record<string, unknown>): Promise<AuraResponse<NotificationTemplatePreview>> | يعرض نموذجًا بـ variables المحدد للمعاينة، دون إرسال رسالة. |
listRules(): Promise<AuraResponse<NotificationRule[]>> | يسرد قواعد إعلام المشروع (التشغيل التلقائي للإرسال). |
createRule(rule: CreateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | إنشاء قاعدة إعلام: لكل حدث من النوع trigger_type يتحقق من condition، يتم إرسال رسالة على channel إلى المستلم المقدم بواسطة recipient_expr، مع تأخير اختياري. |
getRule(id: string): Promise<AuraResponse<NotificationRule>> | يقرأ قاعدة الإعلام بواسطة معرفه. |
updateRule(id: string, updates: UpdateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | يقوم بتحديث قاعدة الإعلام: تتغير الحقول المتوفرة فقط (على سبيل المثال enabled). |
deleteRule(id: string): Promise<AuraResponse<null>> | يحذف قاعدة الإخطار. |
الصفحة التي تم إنشاؤها
يتم إنشاء هذه الصفحة من إعلانات النوع وتعليقات SDK، لذلك لا يمكن أن تنحرف عن التعليمات البرمجية المنشورة. للحصول على أمثلة عملية، اقرأ الأدلة.
آخر تحديث · 12/10/2026