Struct NotificationRequested 

pub struct NotificationRequested {
    pub channel: String,
    pub template: Option<String>,
    pub body: Option<String>,
    pub to: Value,
    pub data: Value,
    pub trigger: String,
}

A request to tell someone something, staged by a hook trigger’s send_email or notify. An effect outside the database is never performed inside the write’s transaction: the request is an outbox row (NotificationRequested) that commits with the write, and a consumer (a mail or notification module’s relay subscriber) performs it, at least once and idempotently.

The payload is this struct as JSON. channel is email or notify; a send_email names a template and a notify a template or a literal body; to is what the trigger’s recipient expression evaluated to (an address, an id, or a list of them); data is the template’s variables; trigger is <Model>.<key> of the trigger that asked.

Fields

channel: String

email or notify.

template: Option<String>

The template to render, when the request names one.

body: Option<String>

The literal text of a notify, with its #{field} already filled in.

to: Value

The recipients, as evaluated.

data: Value

The template variables, as evaluated.

trigger: String

The trigger that asked: <Model>.<key>.

Implementations

impl NotificationRequested

pub const NAME: &'static str = "NotificationRequested"

The event type of the outbox row.

pub const VERSION: i32 = 1

The payload version.

pub fn record( &self, aggregate: &str, aggregate_id: &str, company_id: Uuid, ctx: &WriteCtx, ) -> OutboxRecord

The outbox row of this request, about aggregate (User) aggregate_id, under company_id (see WriteCtx::company_of), carrying the write’s correlation and causation ids.

Trait Implementations

impl Clone for NotificationRequested

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NotificationRequested

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NotificationRequested

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NotificationRequested

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for NotificationRequested

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NotificationRequested