जावास्क्रिप्ट एसडीके: अधिसूचना संदर्भ
सूचनाएं भेजने और प्रशासित करने की प्रत्येक विधि, उसके हस्ताक्षर के साथ।
6 मि॰ पढ़ें·स्तर संदर्भ·12 अक्टू॰ 2026 पर संशोधित
यह अंग्रेजी पाठ फ़्रेंच मूल से स्वचालित रूप से उत्पन्न हुआ था और अभी तक इसकी समीक्षा नहीं की गई है।
यह पृष्ठ स्वचालित रूप से अनुवादित किया गया था. अंग्रेजी संस्करण प्रामाणिक है.
#
कक्षा
अधिसूचना सेवा
| संपत्ति | विवरण |
|---|---|
readonly admin: NotificationsAdminService | प्रशासन उपग्राहक: आँकड़े, कतार, स्क्रैप (डीएलक्यू), आपूर्तिकर्ता लॉग, घटनाएँ, नियम और सेटिंग्स। |
| तरीका | विवरण |
|---|---|
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>> | भेजी जाने वाली अधिसूचना को कतारबद्ध करता है (आधुनिक ऑब्जेक्ट एपीआई)। |
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 पोस्ट वेबहुक (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[]>> | कचरा कतार (डीएलक्यू) में रखी गई सूचनाओं को सूचीबद्ध करता है, जिन्हें channel और search द्वारा फ़िल्टर किया जा सकता है। |
retryDeadLetter(id: string): Promise<AuraResponse<Notification>> | स्क्रैप कतार (डीएलक्यू) से एक विशिष्ट अधिसूचना पुनः भेजता है। |
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 की जांच करता है, एक वैकल्पिक विलंब के साथ, recipient_expr द्वारा दिए गए प्राप्तकर्ता को channel पर एक संदेश भेजा जाता है। |
getRule(id: string): Promise<AuraResponse<NotificationRule>> | किसी अधिसूचना नियम को उसके पहचानकर्ता द्वारा पढ़ता है. |
updateRule(id: string, updates: UpdateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | अधिसूचना नियम को अद्यतन करता है: केवल प्रदान किए गए फ़ील्ड बदलते हैं (उदाहरण के लिए enabled)। |
deleteRule(id: string): Promise<AuraResponse<null>> | एक अधिसूचना नियम हटाता है. |
जनरेट किया गया पेज
यह पृष्ठ एसडीके की प्रकार की घोषणाओं और टिप्पणियों से उत्पन्न हुआ है, इसलिए यह प्रकाशित कोड से अलग नहीं हो सकता है। कारगर उदाहरणों के लिए, मार्गदर्शिकाएँ पढ़ें।
आखरी अपडेट · 12 अक्टू॰ 2026