SDKEvent class

Top-level event envelope. Every event published by every SDK is wrapped in exactly one SDKEvent — analytics consumers, app developers, and pipelines all decode the same bytes.

`voice_pipeline` carries the streaming voice pipeline events from `voice_events.proto` (UserSaid / AssistantToken / AudioFrame / VAD / Interrupted / StateChange / Error / Metrics). Higher-level voice lifecycle events live in this file's `voice` field.

Available extensions

GeneratedMessageGenericExtensions

Constructors

SDKEvent({Int64? timestampMs, ErrorSeverity? severity, InitializationEvent? initialization, ConfigurationEvent? configuration, GenerationEvent? generation, ModelEvent? model, PerformanceEvent? performance, NetworkEvent? network, StorageEvent? storage, FrameworkEvent? framework, DeviceEvent? device, ComponentInitializationEvent? componentInit, String? id, String? sessionId, EventDestination? destination, Iterable<MapEntry<String, String>>? properties, VoiceLifecycleEvent? voice, VoiceEvent? voicePipeline, ComponentLifecycleEvent? componentLifecycle, EventCategory? category, SDKComponent? component, SDKError? error, SessionEvent? session, AuthEvent? auth, ModelRegistryEvent? modelRegistry, DownloadEvent? download, StorageLifecycleEvent? storageLifecycle, HardwareRoutingEvent? hardwareRouting, CapabilityOperationEvent? capability, TelemetryEvent? telemetry, CancellationEvent? cancellation, FailureEvent? failure, String? operationId, String? correlationId, String? source, String? traceId}): factory
SDKEvent.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]): factory
SDKEvent.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]): factory

Properties

auth ↔ AuthEvent: getter/setter pair
cancellation ↔ CancellationEvent: getter/setter pair
capability ↔ CapabilityOperationEvent: getter/setter pair
category ↔ EventCategory: getter/setter pair
component ↔ SDKComponent: getter/setter pair
componentInit ↔ ComponentInitializationEvent: getter/setter pair
componentLifecycle ↔ ComponentLifecycleEvent: getter/setter pair
configuration ↔ ConfigurationEvent: getter/setter pair
correlationId ↔ String: Cross-service correlation key supplied by the SDK/app or generated by the portable layer. Native/Web adapters may propagate it through HTTP headers or OS task metadata, but C++ owns the canonical event field.
getter/setter pair
destination ↔ EventDestination: Event routing destination (Swift EventDestination, Kotlin EventDestination, Dart EventDestination).
getter/setter pair
device ↔ DeviceEvent: getter/setter pair
download ↔ DownloadEvent: getter/setter pair
error ↔ SDKError: Typed failure details for any failed event. When the event itself is only an error notification, use the failure oneof arm below.
getter/setter pair
failure ↔ FailureEvent: getter/setter pair
framework ↔ FrameworkEvent: getter/setter pair
generation ↔ GenerationEvent: getter/setter pair
hardwareRouting ↔ HardwareRoutingEvent: getter/setter pair
hashCode → int: Calculates a hash code based on the contents of the protobuf.
no setterinherited
id ↔ String: Event identifier (UUID). Required by Swift SDKEvent.id / Kotlin SDKEvent.id / Dart SDKEvent.id for de-duplication.
getter/setter pair
info_ → BuilderInfo: no setter
initialization ↔ InitializationEvent: getter/setter pair
isFrozen → bool: Returns true if this message is marked read-only. Otherwise false.
no setterinherited
model ↔ ModelEvent: getter/setter pair
modelRegistry ↔ ModelRegistryEvent: getter/setter pair
network ↔ NetworkEvent: getter/setter pair
operationId ↔ String: Logical operation identifier for this event, e.g. "download.start", "model.load", or "llm.generate". This is separate from the event UUID so retry/cancel/progress/failure events can share one operation id.
getter/setter pair
performance ↔ PerformanceEvent: getter/setter pair
properties → PbMap<String, String>: Free-form metadata for properties not modeled above (mirrors properties: Map<String, String> from each SDK).
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
session ↔ SessionEvent: getter/setter pair
sessionId ↔ String: Optional session id for grouping related events (Swift sessionId / Kotlin sessionId / Dart sessionId).
getter/setter pair
severity ↔ ErrorSeverity: getter/setter pair
source ↔ String: Source that emitted the event: "cpp", "swift", "kotlin", "flutter", "react_native", "web", or a backend/plugin key. This disambiguates platform adapter facts from portable orchestration events.
getter/setter pair
storage ↔ StorageEvent: getter/setter pair
storageLifecycle ↔ StorageLifecycleEvent: getter/setter pair
telemetry ↔ TelemetryEvent: getter/setter pair
timestampMs ↔ Int64: Wall-clock time of event creation, milliseconds since Unix epoch.
getter/setter pair
traceId ↔ String: Optional tracing identifier for diagnostics. Empty when tracing is not enabled; do not use it as a business key.
getter/setter pair
unknownFields → UnknownFieldSet: no setterinherited
voice ↔ VoiceLifecycleEvent: getter/setter pair
voicePipeline ↔ VoiceEvent: getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void: Adds an extension field value to a repeated field.
inherited
check() → void: Throws a StateError if the message has required fields without a value.
inherited
clear() → void: Clears all data that was set in this message.
inherited
clearAuth() → void
clearCancellation() → void
clearCapability() → void
clearCategory() → void
clearComponent() → void
clearComponentInit() → void
clearComponentLifecycle() → void
clearConfiguration() → void
clearCorrelationId() → void
clearDestination() → void
clearDevice() → void
clearDownload() → void
clearError() → void
clearEvent() → void
clearExtension(Extension extension) → void: Clears an extension field and also removes the extension.
inherited
clearFailure() → void
clearField(int tagNumber) → void: Clears the contents of a given field.
inherited
clearFramework() → void
clearGeneration() → void
clearHardwareRouting() → void
clearId() → void
clearInitialization() → void
clearModel() → void
clearModelRegistry() → void
clearNetwork() → void
clearOperationId() → void
clearPerformance() → void
clearSession() → void
clearSessionId() → void
clearSeverity() → void
clearSource() → void
clearStorage() → void
clearStorageLifecycle() → void
clearTelemetry() → void
clearTimestampMs() → void
clearTraceId() → void
clearVoice() → void
clearVoicePipeline() → void
clone() → SDKEvent: Creates a deep copy of the fields in this message.
copyWith(void updates(SDKEvent)) → SDKEvent: Apply updates to a copy of this message.
createEmptyInstance() → SDKEvent: Creates an empty instance of the same message type as this.
deepCopy() → T: Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message.
ensureAuth() → AuthEvent
ensureCancellation() → CancellationEvent
ensureCapability() → CapabilityOperationEvent
ensureComponentInit() → ComponentInitializationEvent
ensureComponentLifecycle() → ComponentLifecycleEvent
ensureConfiguration() → ConfigurationEvent
ensureDevice() → DeviceEvent
ensureDownload() → DownloadEvent
ensureError() → SDKError
ensureFailure() → FailureEvent
ensureFramework() → FrameworkEvent
ensureGeneration() → GenerationEvent
ensureHardwareRouting() → HardwareRoutingEvent
ensureInitialization() → InitializationEvent
ensureModel() → ModelEvent
ensureModelRegistry() → ModelRegistryEvent
ensureNetwork() → NetworkEvent
ensurePerformance() → PerformanceEvent
ensureSession() → SessionEvent
ensureStorage() → StorageEvent
ensureStorageLifecycle() → StorageLifecycleEvent
ensureTelemetry() → TelemetryEvent
ensureVoice() → VoiceLifecycleEvent
ensureVoicePipeline() → VoiceEvent
extensionsAreInitialized() → bool: inherited
freeze() → GeneratedMessage: Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic: Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic: Returns the value of extension.
inherited
getField(int tagNumber) → dynamic: Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic: Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?: inherited
hasAuth() → bool
hasCancellation() → bool
hasCapability() → bool
hasCategory() → bool
hasComponent() → bool
hasComponentInit() → bool
hasComponentLifecycle() → bool
hasConfiguration() → bool
hasCorrelationId() → bool
hasDestination() → bool
hasDevice() → bool
hasDownload() → bool
hasError() → bool
hasExtension(Extension extension) → bool: Returns true if a value of extension is present.
inherited
hasFailure() → bool
hasField(int tagNumber) → bool: Whether this message has a field associated with tagNumber.
inherited
hasFramework() → bool
hasGeneration() → bool
hasHardwareRouting() → bool
hasId() → bool
hasInitialization() → bool
hasModel() → bool
hasModelRegistry() → bool
hasNetwork() → bool
hasOperationId() → bool
hasPerformance() → bool
hasRequiredFields() → bool: Whether the message has required fields.
inherited
hasSession() → bool
hasSessionId() → bool
hasSeverity() → bool
hasSource() → bool
hasStorage() → bool
hasStorageLifecycle() → bool
hasTelemetry() → bool
hasTimestampMs() → bool
hasTraceId() → bool
hasVoice() → bool
hasVoicePipeline() → bool
isInitialized() → bool: Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void: Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void: Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void: Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void: inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T: Available on T, provided by the GeneratedMessageGenericExtensions extension
Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void: Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void: Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage: Creates a writable, shallow copy of this message.
inherited
toDebugString() → String: Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?: Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String: Returns a String representation of this message.
inherited
whichEvent() → SDKEvent_Event
writeToBuffer() → Uint8List: Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void: Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String: Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>: Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

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

Static Methods

create() → SDKEvent
getDefault() → SDKEvent