specs/notifications/shared/v0_1/notification
library
Classes
-
Notification
-
The members of one notification, as notifications/notify carries them and as a
recipient's agent records them. The originator is the
issuer of the
notifications/notify document and the addressee its recipient; neither is
repeated here, because the originator's proof covers both.
-
Subject
-
Where the thing is and how to open it. Only these three members: what the thing
contains is shown by its holder, to a reader it admits, when the thing is opened
with
openWith.
Extension Types
-
Status
-
Whether the thing is still open to the audience:
available, or withdrawn —
cancelled by its holder, or no longer open to the audience — in which case the
recipient keeps the record only to show that it was withdrawn (VTI-NTF-024).
Typedefs
-
Did
= String
-
A DID.
-
Kind
= String
-
What the thing is. Either a registered kind — one lowerCamelCase name in the VTI
specification's notification kind registry (Appendix G), such as
election — or an
unregistered kind, written <reverse-DNS domain>:<name> under a domain its definer
controls, such as org.example:meetingInvite. A recipient that does not recognise
a kind holds, lists and discards it and does nothing else with it (VTI-NTF-012).
-
NotificationId
= String
-
The originator's identifier for one notification, unique among the notifications
that originator issues and the same in every document that carries it — retries,
re-issued documents and relayed copies alike. It is the notification's idempotency
key (VTI-NTF-021). Compared for equality only. An originator SHOULD make it
unguessable and SHOULD NOT make it descriptive: it travels as far as the
notification does.