UserNotificationsRepository
Документация для класса UserNotificationsRepository.
Методы
getNotifications
Описание
Получает список уведомлений пользователя.
HTTP метод: GET
URL: /api/v1/user/notifications
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | IUserNotificationPayload |
Возвращает: Promise<IPaginationShell<IUserNotification[]>>
markAsReadNotifications
Описание
Отмечает уведомления как прочитанные.
HTTP метод: POST
URL: /api/v1/user/notifications/mark-as-read
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | IMarkAsReadUserNotificationPayload |
Возвращает: Promise<void>
deleteNotifications
Описание
Удаляет указанные уведомления.
HTTP метод: POST
URL: /api/v1/user/notifications/delete
Параметры:
| Имя | Тип | Описание |
|---|---|---|
payload | IDeleteUserNotificationPayload |
Возвращает: Promise<void>
Определения типов
Определения интерфейсов, перечислений и псевдонимов типов, используемых в методах этого репозитория.
IDeleteUserNotificationPayload
| Свойство | Тип | Описание |
|---|---|---|
ids | number[] |
IMarkAsReadUserNotificationPayload
| Свойство | Тип | Описание |
|---|---|---|
ids | number[] |
INotificationsRepository
Интерфейс не содержит собственных свойств и не наследует другие локальные интерфейсы.
IPaginationLinks
| Свойство | Тип | Описание |
|---|---|---|
first | string | null | |
last | string | null | |
next | string | null | |
prev | string | null |
IPaginationMeta
| Свойство | Тип | Описание |
|---|---|---|
path | string | |
current_page | number | |
per_page | number | |
to | number | |
from | number | |
total | number | |
links | IPaginationMetaLink[] | |
last_page | number |
IPaginationMetaLink
| Свойство | Тип | Описание |
|---|---|---|
active | boolean | |
label | string | |
url | string | null |
IPaginationPayload
| Свойство | Тип | Описание |
|---|---|---|
page | number | |
per_page | number |
IPaginationShell
| Свойство | Тип | Описание |
|---|---|---|
links | IPaginationLinks[] | |
meta | IPaginationMeta | |
data | list |
IUserNotificationPayload
Наследует: IPaginationPayload
| Свойство | Тип | Описание |
|---|---|---|
sort (опц.) | ENotificationSortTypes | |
order (опц.) | ENotificationOrderTypes | |
ref_notification_type (опц.) | ENotificationType |
ENotificationOrderTypes
| Член | Значение | Описание |
|---|---|---|
ascending | asc | |
descending | desc |
ENotificationReadTypes
TODO: Надо отработать это на бэке
| Член | Значение | Описание |
|---|---|---|
read | read | |
unread | unread |
ENotificationSortTypes
| Член | Значение | Описание |
|---|---|---|
createdAt | created_at | |
id | id | |
title | title |
ENotificationType
| Член | Значение | Описание |
|---|---|---|
Systemic | 1 | |
Informative | 2 |