ores.inbox.notification_kind
Table of Contents
Reference data table of the kinds of notification. Examples: 'inbox.approval_waiting', 'inbox.approval_decided'.
A notification carries a kind and its values, not a finished sentence. The kind names the message key the screen renders in the reader's language. A component adds a kind with a seed row and needs no change to the subsystem.
mail_optional says whether a person may turn the mail copy of this kind off.
A password recovery is a kind a person cannot turn off. The in-application copy
is always kept.
Kinds are managed by the system tenant.
1. Flags
2. Columns
2.1. code
Unique kind code, prefixed by the component that raises it.
Examples: 'inbox.approval_waiting'.
2.2. name
Human-readable name for the kind.
std::string(faker::word::noun()) + " Notice"
2.3. description
What the kind tells a person.
std::string(faker::lorem::sentence())
2.4. message_key
The key of the message the screen renders, with the notification's arguments, in the reader's language.
Examples: 'notification.inbox.approval_waiting'.
std::string("notification.") + std::string(faker::word::noun())
2.5. mail_optional
Whether a person may turn the mail copy of this kind off.
2.6. display_order
Order for UI display purposes.
faker::number::integer(1, 100)
3. SQL
3.1. Flags
4. Validation function
5. C++
5.1. Flags
5.2. Repository
5.3. Domain includes
#include <string>
5.4. Entity includes
#include <string>
5.5. Conventions
5.6. Table display
| column | header |
|---|---|
| code | Code |
| name | Name |
| message_key | Message Key |
| mail_optional | Mail Optional |
| modified_by | Modified By |
| version | Version |
5.7. Presentation
5.7.1. Detail fields
| field | label | widget | type | is_key | is_required | placeholder |
|---|---|---|---|---|---|---|
| code | Code | codeEdit | line_edit | true | true | Enter kind code |
| name | Name | nameEdit | line_edit | true | Enter display name | |
| description | Description | descriptionEdit | text_edit | Enter a description | ||
| message_key | Message Key | messageKeyEdit | line_edit | true | Enter a message key |
5.7.2. Columns
| enum_name | field | header | type | width |
|---|---|---|---|---|
| Code | code | Code | string | 200 |
| Name | name | Name | string | 200 |
| MessageKey | message_key | Message Key | string | 240 |
| DisplayOrder | display_order | Order | int | 80 |
| Version | version | Version | int | 80 |
| ModifiedBy | modified_by | Modified By | string | 120 |
| RecordedAt | recorded_at | Recorded At | timestamp | 150 |
5.8. Custom repository methods
6. See also
- Notification requirements — the design this lookup implements.
- ores.inbox.notification — the notification whose kind this lookup names.