EventTypeInfo

Record in Oadm.Sdk.Events · Oadm.Sdk.dll

An event a source can publish. Id is stable and unique (“oadm.device-triggers.<id>”); DisplayName names the event in plain language (“Blur detected”), for a stateful event its “on” state; Group groups the picker of the rule dialog (“Image Health”).

public sealed record EventTypeInfo(string Id, string DisplayName, string Group, EventKind Kind, EventScope Scope = Device, IReadOnlyList<EventField>? Fields = null)

Guide: Event rules

Parameters

• Id: Stable, unique id.
• DisplayName: The event in plain words; for an on and off event its on state.
• Group: The group in the event list of the rule dialog.
• Kind: One-shot or on and off.
• Scope: Per device or for the server.
• Fields: The data fields a condition can filter on.

Properties

DataFields

IReadOnlyList<EventField> DataFields { get; }

EventTypeInfo.Fields, never null.

Description

string? Description { get; init; }

One short sentence for the rule dialog (optional).

DisplayName

string DisplayName { get; init; }

The event in plain words; for an on and off event its on state.

Fields

IReadOnlyList<EventField>? Fields { get; init; }

The data fields a condition can filter on.

Group

string Group { get; init; }

The group in the event list of the rule dialog.

Id

string Id { get; init; }

Stable, unique id.

Kind

EventKind Kind { get; init; }

One-shot or on and off.

Scope

EventScope Scope { get; init; }

Per device or for the server.

Used by

• IEventSource.EventTypes