LemonCore.Events.TalkModeChanged (lemon_core v0.1.0)

A session's talk mode changed. Published on system.

Summary

Types

t()

Functions

event_type()

The LemonCore.Event type atom this payload is published under.

event_version()

Payload version. Bumped only for a breaking field change (see the semver table in docs/platform/bus-events.md §4.3).

fields()

The struct's field names, in declaration order.

from_map(payload)

Build the payload from a map that may be a legacy free-form payload.

new(payload)

Build the payload, raising on unknown or missing keys.

Types

t()

@type t() :: %LemonCore.Events.TalkModeChanged{
  mode: atom() | String.t(),
  session_key: String.t()
}

Functions

event_type()

@spec event_type() :: atom()

The LemonCore.Event type atom this payload is published under.

event_version()

@spec event_version() :: pos_integer()

Payload version. Bumped only for a breaking field change (see the semver table in docs/platform/bus-events.md §4.3).

fields()

@spec fields() :: [atom()]

The struct's field names, in declaration order.

from_map(payload)

@spec from_map(map() | struct() | keyword()) :: struct()

Build the payload from a map that may be a legacy free-form payload.

Unknown keys are dropped and string keys are accepted, so a consumer can coerce whatever arrives on the topic. Enforced keys are still required — a map missing them is not a valid payload under any version.

new(payload)

@spec new(map() | keyword()) :: struct()

Build the payload, raising on unknown or missing keys.

This is the publisher-side constructor: a typo should fail at the point of publish, not silently produce a payload with a nil field that a consumer reads as absent.