Powiadomienia
Powiadomienia informują użytkowników o aktywności na platformie, takiej jak terminy, aktualizacje i inne zdarzenia. Pojawiają się w kilku miejscach, między innymi pod ikoną dzwonka i w wiadomościach e-mail.
Powiadomienia dotyczące wyłącznie zalogowanego użytkownika pojawiają się pod ikoną dzwonka. Domyślnie użytkownik otrzymuje również wiadomość e-mail za każdym razem, gdy dostanie powiadomienie. Można to wyłączyć i dostosować w ustawieniach profilu użytkownika.
Zapytania
Pobieranie powiadomień
- Zwraca metadane dotyczące powiadomień użytkownika.
- Można je wykonywać tylko bezpośrednio na głównym poziomie zapytania - nie można ich zagnieżdżać w innym zapytaniu.
query {
notifications(filter_read: true) {
text
title
id
}
}
{
"data": {
"notifications": [
{
"text": "This is a notification",
"title": "New test notification",
"id": "123456"
}
]
},
"extensions": {
"request_id": "YOUR_REQUEST_ID"
}
}
Argumenty
| Argument | Typ | Opis |
|---|---|---|
| cursor | ID |
Unikalny identyfikator ostatniego powiadomienia do pobrania. |
| filter_read | Boolean |
Czy pobrać tylko nieprzeczytane powiadomienia. |
| limit | Int |
Liczba zwracanych powiadomień. Domyślna wartość to 25. |
| since | ISO8601DateTime |
Filtruje powiadomienia od tej daty włącznie. |
Pola
| Pole | Typ | Opis |
|---|---|---|
| board | Board |
Tablica powiązana z powiadomieniem. |
| created_at | Date |
Data utworzenia powiadomienia. |
| creators | [User!]! |
Twórca lub twórcy powiadomienia. |
| id | ID! |
Unikalny identyfikator powiadomienia. |
| item | Item |
Element powiązany z powiadomieniem. |
| read | Boolean! |
Informuje, czy powiadomienie zostało przeczytane. |
| text | String |
Treść powiadomienia. |
| title | String |
Tytuł powiadomienia. |
| update | Update |
Aktualizacja powiązana z powiadomieniem. |
Mutacje
Wymagany zakres:notifications:write
Tworzenie powiadomienia
Wysyła powiadomienie przez API, które pojawia się pod ikoną dzwonka. Może również wysłać wiadomość e-mail, jeśli preferencje e-mail odbiorcy są odpowiednio skonfigurowane.
Jeśli wyślesz powiadomienie z widoku tablicy lub widżetu przy użyciu uwierzytelniania bez interakcji, zostanie ono wysłane z aplikacji i będzie wyświetlać jej nazwę oraz ikonę. Jeśli użyjesz osobistego klucza API, powiadomienie będzie wyglądać tak, jakby wysłał je użytkownik, który zainstalował aplikację na koncie.
Ta mutacja tylko wysyła powiadomienie. Ponieważ powiadomienia są przetwarzane asynchronicznie, podczas wykonywania mutacji nie można pobrać identyfikatora powiadomienia.
mutation {
create_notification(
user_id: 12345678
target_id: 674387
text: "This is a notification"
target_type: Project
) {
text
}
}
Argumenty
| Argument | Typ | Opis | Wartości wyliczeniowe |
|---|---|---|---|
| target_id | ID! |
Unikalny identyfikator obiektu docelowego. Wartość zależy od • |
|
| target_type | NotificationTargetType! |
Typ obiektu docelowego. | Post (wysyła powiadomienie dotyczące aktualizacji lub odpowiedzi)Project (wysyła powiadomienie dotyczące elementu lub tablicy) |
| text | String! |
Treść powiadomienia. | |
| user_id | ID! |
Unikalny identyfikator użytkownika. |