QueueCustomEvent class

Represents a custom queue event emitted through QueueEventsProducer.

Implemented types

Constructors

QueueCustomEvent({required String id, required String queue, required String name, required Map<String, Object?> payload, required DateTime emittedAt, Map<String, String> headers = const {}, Map<String, Object?> meta = const {}})
Creates a queue custom event.
const

Properties

attributes Map<String, Object?>
Event attributes for diagnostics/observability.
no setteroverride
emittedAt DateTime
Timestamp when the event was emitted.
final
eventName String
Canonical event name.
no setteroverride
hashCode int
The hash code for this object.
no setterinherited
headers Map<String, String>
Event headers.
final
id String
Message identifier used by the underlying broker envelope.
final
meta Map<String, Object?>
Additional metadata supplied by the publisher.
final
name String
Custom event name.
final
occurredAt DateTime
Timestamp when the event occurred.
no setteroverride
payload Map<String, Object?>
Event payload.
final
queue String
Queue scope for this event.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

metaAs<T>({required Codec<T, Object?> codec}) → T
Decodes the full event metadata payload with codec.
metaJson<T>({required T decode(Map<String, dynamic> payload), String? typeName}) → T
Decodes the full event metadata payload with a JSON decoder.
metaVersionedJson<T>({required int version, required T decode(Map<String, dynamic> payload, int version), int? defaultDecodeVersion, String? typeName}) → T
Decodes the full event metadata payload with a version-aware JSON decoder.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
payloadAs<T>({required Codec<T, Object?> codec}) → T
Decodes the entire payload as a typed DTO with codec.
payloadJson<T>({required T decode(Map<String, dynamic> payload), String? typeName}) → T
Decodes the entire payload as a typed DTO with a JSON decoder.
payloadValue<T>(String key, {Codec<T, Object?>? codec}) → T?
Returns the decoded payload value for key, or null when it is absent.
payloadValueOr<T>(String key, T fallback, {Codec<T, Object?>? codec}) → T
Returns the decoded payload value for key, or fallback when absent.
payloadVersionedJson<T>({required int version, required T decode(Map<String, dynamic> payload, int version), int? defaultDecodeVersion, String? typeName}) → T
Decodes the entire payload as a typed DTO with a version-aware JSON decoder.
requiredPayloadValue<T>(String key, {Codec<T, Object?>? codec}) → T
Returns the decoded payload value for key, throwing when it is absent.
toJson() Map<String, Object?>
Converts the event to a JSON-compatible map.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited