notification

Entrega notificações aos usuários, incluindo stream e controles de leitura/progresso.

Caminho de origem: libraries/core/src/notification

Arquivo do módulo: notification.module.ts

Introdução

Esta página documenta o submódulo notification como parte do pacote Core. Use-a como referência técnica rápida para escopo de implementação, APIs expostas e pontos de integração MCP.

Endpoints HTTP

9 endpoints

Lista as notificações do usuário atual.

Query: page, pageSize

Abre um stream de server-sent events para receber notificações em tempo real.

Retorna o número de notificações não lidas do usuário atual.

Cria e despacha uma notificação para um usuário.

Body

Field	Type	Required	Notes
user_id	number	yes	—
title	string	yes	—
body	string	no	—
icon	string	no	—
type	"info" \| "success" \| "warning" \| "error" \| "progress"	no	—
action_type	"url" \| "sheet" \| "modal"	no	—
action_url	string	no	—
action_data	object	no	—
auto_remove	boolean	no	—
progress	number	no	0–100
started_at	string	no	ISO 8601 date string

Marca todas as notificações do usuário atual como lidas.

Marca uma única notificação como lida.

Params: id (int)

Atualiza o valor de progresso de uma notificação do tipo progresso.

Params: id (int)

Body

Field	Type	Required	Notes
progress	number	yes	0–100
body	string	no	Updated message text
success	boolean	no	—

Exclui todas as notificações do usuário atual.

Exclui uma notificação específica.

Params: id (int)

Ferramentas MCP

Ferramentas nomeadas que podem ser chamadas por modelos de IA através do Model Context Protocol (MCP).

core.notifications.list
Lista as notificações do usuário atual com paginação
core.notifications.unread-count
Retorna o número de notificações não lidas do usuário atual
core.notifications.mark-read
Marca uma única notificação como lida
core.notifications.mark-all-read
Marca todas as notificações do usuário atual como lidas
core.notifications.create
Cria e despacha uma notificação para um usuário
core.notifications.delete
Exclui uma notificação específica
core.notifications.delete-all
Exclui todas as notificações do usuário atual
core.notifications.update-progress
Atualiza o valor de progresso de uma notificação do tipo progresso