JavaScript SDK: odniesienie do powiadomień
Każdy sposób wysyłania i administrowania powiadomieniami wraz z jego podpisem.
6 min przeczytane·Poziom odniesienie·Zmieniono 12 paź 2026
Ten tekst w języku angielskim został wygenerowany automatycznie na podstawie francuskiego oryginału i nie był jeszcze recenzowany.
Ta strona została przetłumaczona automatycznie. Wersja angielska jest miarodajna.
#
Klasa
Usługa powiadomień
| Nieruchomość | Opis |
|---|---|
readonly admin: NotificationsAdminService | Podklient administracyjny: statystyki, kolejka, złom (DLQ), logi dostawców, zdarzenia, reguły i ustawienia. |
| Metoda | Opis |
|---|---|
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>> | Kolejkuje powiadomienie do wysłania (Modern Object API). |
sendBatch(items: Array<SendNotificationRequest | SendNotificationItem>): Promise<AuraResponse<BatchSendResponse>> | Wysyła partię powiadomień (POST /send/batch). |
sendEmail(recipient: string, subject: string, body: string, options?: SendEmailOptions): Promise<AuraResponse<Notification>> | Wysyła e-mail transakcyjny (channel: 'email'). |
sendSms(recipient: string, body: string, options?: SendSmsOptions): Promise<AuraResponse<Notification>> | Wysyła transakcyjną wiadomość SMS (channel: 'sms'). |
sendPush(recipient: string, title: string, body: string, options?: SendPushOptions): Promise<AuraResponse<Notification>> | Wysyła mobilne powiadomienie push (channel: 'push', FCM lub APN). |
sendWebhook(targetUrl: string, event: string, payload: string | Record<string, unknown>, options?: SendWebhookOptions): Promise<AuraResponse<Notification>> | Wysyła wychodzący element webhook HTTP POST (channel: 'webhook'). |
retry(id: string): Promise<AuraResponse<Notification>> | Ponów nieudane powiadomienie (status: 'failed' lub '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[]>> | Wyświetla historię powiadomień projektu, którą można filtrować według channel, status i search, posortowaną według created_at, updated_at lub status, z paginacją limit / offset. |
get(id: string): Promise<AuraResponse<Notification>> | Odczytuje powiadomienie według jego identyfikatora. |
listTemplates(): Promise<AuraResponse<NotificationTemplate[]>> | Wyświetla listę szablonów wiadomości projektu. |
getTemplate(id: string): Promise<AuraResponse<NotificationTemplate>> | Odczytuje szablon wiadomości według jego identyfikatora. |
createTemplate(template: Omit<NotificationTemplate, 'id' | 'project_id' | 'created_at' | 'updated_at'>): Promise<AuraResponse<NotificationTemplate>> | Tworzy szablon — name, channel, subject, body i nic więcej. |
updateTemplate(id: string, updates: Partial<Pick<NotificationTemplate, 'name' | 'subject' | 'body'>>): Promise<AuraResponse<NotificationTemplate>> | Aktualizuje szablon: name, subject i/lub body. |
deleteTemplate(id: string): Promise<AuraResponse<null>> | Usuwa szablon wiadomości. |
#
Klasa
PowiadomieniaAdminService
| Metoda | Opis |
|---|---|
getSettings(): Promise<AuraResponse<NotificationSettingsPublic>> | Pobiera ustawienia publicznego dostawcy i przydziału projektu (GET /settings). |
updateSettings(settings: NotificationSettingsPatch | Partial<NotificationSettings>): Promise<AuraResponse<NotificationSettingsPublic>> | Aktualizuje ustawienia dostawcy lub limitu projektu (PATCH /settings). |
getStats(options?: { window?: NotificationStatsWindow; channel?: NotificationChannel; }): Promise<AuraResponse<NotificationStats>> | Zagregowane statystyki wysyłania (GET /stats). |
getQueue(): Promise<AuraResponse<NotificationQueueStats>> | Odczytuje stan kolejki wysyłającej: głębokość i rozkład oczekujących powiadomień. |
listAttempts(notificationId: string): Promise<AuraResponse<NotificationAttempt[]>> | Wyświetla listę prób wysłania powiadomienia wraz z odpowiedzią dostawcy na każdą z nich. |
listDeadLetters(options?: { channel?: NotificationChannel; search?: string; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationDeadLetter[]>> | Wyświetla listę powiadomień umieszczonych w kolejce śmieci (DLQ), z możliwością filtrowania według channel i search. |
retryDeadLetter(id: string): Promise<AuraResponse<Notification>> | Wysyła ponownie określone powiadomienie z kolejki złomów (DLQ). |
listEvents(options?: { status?: 'received' | 'matched' | 'ignored' | 'failed' | 'enqueued'; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationEvent[]>> | Wyświetla listę zdarzeń odebranych przez silnik reguł, które można filtrować według status. |
listProviderLogs(options?: { channel?: NotificationChannel; status?: NotificationAttemptStatus; limit?: number; offset?: number; }): Promise<AuraResponse<NotificationProviderLog[]>> | Dzienniki wykonania dostawców zewnętrznych (GET /providers/logs). |
previewTemplate(id: string, variables: Record<string, unknown>): Promise<AuraResponse<NotificationTemplatePreview>> | Renderuje model z podanym variables do podglądu, bez wysyłania komunikatu. |
listRules(): Promise<AuraResponse<NotificationRule[]>> | Wyświetla reguły powiadamiania o projekcie (automatyczne wyzwalanie wysyłki). |
createRule(rule: CreateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | Tworzy regułę powiadamiania: dla każdego zdarzenia typu trigger_type sprawdzającego condition, wysyłany jest komunikat channel do odbiorcy podany przez recipient_expr, z opcjonalnym opóźnieniem. |
getRule(id: string): Promise<AuraResponse<NotificationRule>> | Odczytuje regułę powiadomienia według jej identyfikatora. |
updateRule(id: string, updates: UpdateNotificationRuleRequest): Promise<AuraResponse<NotificationRule>> | Aktualizuje regułę powiadamiania: zmieniają się tylko podane pola (na przykład enabled). |
deleteRule(id: string): Promise<AuraResponse<null>> | Usuwa regułę powiadamiania. |
Wygenerowana strona
Ta strona jest generowana na podstawie deklaracji typów i komentarzy pakietu SDK, więc nie może odbiegać od opublikowanego kodu. Aby poznać sprawdzone przykłady, przeczytaj przewodniki.
Ostatnia aktualizacja · 12 paź 2026