Renames description to message.

This commit is contained in:
Vitor Pamplona 2023-11-29 17:29:26 -05:00
parent db8c826fca
commit e9c985fed0

14
88.md
View File

@ -6,18 +6,18 @@ NOTIFY Request
`draft` `optional`
At any point, the relay can send a `NOTIFY` request to a client with a user-readable description to be displayed as is. The description SHOULD be rendered as if it was a Kind 1 post in a visible part of the application to allow the user to quickly see and act if needed.
At any given moment, the relay can send a `NOTIFY` request to a client carrying a user-friendly message to be displayed as is. The message SHOULD be rendered as if it was a Kind 1 post in a visible part of the application to allow the user to quickly see and act if needed.
```js
[
"NOTIFY",
"<Description>"
"<Message>"
]
```
Clients SHOULD expect the same request to be received multiple times. If the user dismisses it, the client SHOULD ignore new requests with the same description.
Clients SHOULD expect the same request to be received multiple times. If the user dismisses it once, the client SHOULD ignore new requests with the same message.
Supporting relays SHOULD keep the same description across subscriptions and minimize the number of times each request is sent to avoid annoying users with multiple interruptions.
Supporting relays SHOULD use the same message across subscriptions and minimize the number of times each request is sent to avoid annoying users with multiple interruptions.
## Examples of use
@ -40,7 +40,7 @@ Paid relays often run into friction when renewing subscriptions. The API describ
### Upselling Plans
Relays can now progressively upgrade their user's subscriptions based on their use.
Relays can now progressively upgrade their user's subscriptions based on their individual needs.
```js
[
@ -58,7 +58,7 @@ Relays can now progressively upgrade their user's subscriptions based on their u
### Unlock Closed Access
Relays can offer paid access to specific event kinds or add protections to the current use right when the user is trying to make use of them.
Relays can offer access to specific event kinds when they are used. They can also suggest contextual features right when the user is trying to make use of them.
```js
[
@ -76,7 +76,7 @@ Relays can offer paid access to specific event kinds or add protections to the c
### Request for Donations
If relays are fundraising, they can send a one-time message to their connected users.
If relays are fundraising, they can send a personalized message to their connected users.
```js
[