Enum DeviceEventKind 

pub enum DeviceEventKind {
    Registered(DeviceRegistration),
    Disconnected {},
    Capabilities {
        capabilities: StationMediaCapabilities,
    },
    OffHook {
        call_id: CallId,
        line_instance: LineInstance,
    },
    OnHook {
        call_id: CallId,
        line_instance: LineInstance,
    },
    Digit {
        call_id: CallId,
        digit: Digit,
    },
    EnblocCall {
        call_id: CallId,
        line_instance: LineInstance,
        number: String,
    },
    SpeedDial {
        call_id: CallId,
        line_instance: LineInstance,
        number: String,
        await_further_digits: bool,
    },
    SoftKey {
        call_id: Option<CallId>,
        line_instance: LineInstance,
        soft_key: SoftKey,
    },
    LineButton {
        line_instance: LineInstance,
        call_id: Option<CallId>,
    },
    HookFlash {
        call_id: Option<CallId>,
        line_instance: LineInstance,
    },
    FeatureButton {
        instance: LineInstance,
    },
    DoNotDisturbButton {
        instance: LineInstance,
    },
    RecordingButton {
        instance: LineInstance,
    },
    MobilityButton {
        instance: LineInstance,
    },
    VoicemailButton {
        call_id: CallId,
        line_instance: LineInstance,
    },
    ParkingLotButton {
        instance: LineInstance,
        call_id: Option<CallId>,
        line_instance: LineInstance,
    },
    ParkingMenuSelection {
        lot: String,
        slot: u32,
    },
    PhoneServiceResponse {
        response: PhoneServiceEvent,
    },
    ConferenceListAction {
        action: ConferenceListAction,
    },
    ReceiveChannelOpened {
        call_id: CallId,
        status: MediaStatus,
        endpoint: MediaEndpoint,
    },
    MultimediaReceiveChannelOpened {
        call_id: CallId,
        codec: Codec,
        endpoint: MediaEndpointAddress,
        passthrough_party_id: PassthroughPartyId,
    },
    MultimediaReceiveChannelFailed {
        call_id: CallId,
        codec: Codec,
        status: MediaStatus,
        endpoint: MediaEndpointAddress,
        passthrough_party_id: PassthroughPartyId,
    },
    MultimediaReceiveChannelTimedOut {
        call_id: CallId,
        codec: Codec,
        passthrough_party_id: PassthroughPartyId,
    },
    MultimediaTransmitStarted {
        call_id: CallId,
        codec: Codec,
        endpoint: MediaEndpointAddress,
        passthrough_party_id: PassthroughPartyId,
    },
    MultimediaTransmitFailed {
        call_id: CallId,
        codec: Codec,
        status: MediaStatus,
        endpoint: MediaEndpointAddress,
        passthrough_party_id: PassthroughPartyId,
    },
    MultimediaTransmitTimedOut {
        call_id: CallId,
        codec: Codec,
        passthrough_party_id: PassthroughPartyId,
    },
    TransmitChannelOpen {
        call_id: CallId,
        outcome: TransmitOpenOutcome,
        endpoint: MediaEndpoint,
    },
    HandsetAcknowledgementTimedOut {
        call_id: CallId,
        acknowledgement: HandsetAcknowledgement,
    },
    MediaTransmissionFailed {
        call_id: CallId,
        status: MediaStatus,
        endpoint: MediaEndpoint,
    },
    MulticastReceptionStarted {
        conference_id: ConferenceId,
        call_id: CallId,
        route: MulticastMediaRoute,
    },
    MulticastReceptionFailed {
        conference_id: ConferenceId,
        call_id: CallId,
        status: MediaStatus,
    },
    MulticastReceptionTimedOut {
        conference_id: ConferenceId,
        call_id: CallId,
    },
    MulticastTransmissionStarted {
        conference_id: ConferenceId,
        call_id: CallId,
        route: MulticastMediaRoute,
    },
    MulticastTransmissionFailed {
        conference_id: ConferenceId,
        call_id: CallId,
        status: MediaStatus,
        address: IpAddr,
        port: u16,
    },
    ConnectionStatisticsCollected {
        snapshot: MediaStatisticsSnapshot,
    },
    Alarm {
        severity: AlarmSeverity,
        text: String,
        parameters: Option<[u32; 2]>,
    },
    XmlAlarm {
        telemetry: PhoneAlarmTelemetry,
    },
    LocationInformation {
        telemetry: PhoneLocationTelemetry,
    },
    HeadsetStatusChanged {
        enabled: bool,
    },
    MediaPathChanged {
        path: MediaPathId,
        event: MediaPathEvent,
    },
    UnhandledMessage {
        message: ClientMessage,
    },
}

State transitions and handset input produced by one station session.

Call-bearing variants use the server-owned CallId rather than the raw wire reference. Media success and failure variants are emitted only after correlation against the current request generation.

Variants

Registered(DeviceRegistration)

Reports a station that completed registration and session initialization. Carries the accepted device definition, peer details, and negotiated state.

Disconnected

Reports that the station session ended or was replaced by a newer session. Consumers should retire state associated with this event’s generation.

Capabilities

Replaces the station’s advertised audio and multimedia capabilities. The snapshot is scoped to the connection generation that reported it.

Fields

capabilities: StationMediaCapabilities

OffHook

Reports that the handset went off hook on a resolved line and call. The server has already allocated or selected the addressable call identity.

Fields

call_id: CallId

line_instance: LineInstance

OnHook

Reports that the handset went on hook for a resolved line and call. Integrations can use it to request hangup or complete hook-driven actions.

Fields

call_id: CallId

line_instance: LineInstance

Digit

Reports one keypad digit associated with an addressable handset call. The digit is decoded but no dialing or in-call policy is applied here.

Fields

call_id: CallId

digit: Digit

EnblocCall

Reports a complete en-bloc number submitted for a newly allocated call. The line and server-owned call identity are resolved before emission.

Fields

call_id: CallId

line_instance: LineInstance

number: String

SpeedDial

Reports activation of a configured speed dial on a resolved call and line. Indicates whether the configuration permits collecting additional digits.

Fields

call_id: CallId

line_instance: LineInstance

number: String

await_further_digits: bool

SoftKey

Reports a decoded soft-key press with its resolved station context. Call identity is present only when the selected key is call-scoped.

Fields

call_id: Option<CallId>

Active call when the key is call-scoped.

line_instance: LineInstance

soft_key: SoftKey

LineButton

Reports a physical line-button press and any call selected on that line. The line is always resolved even when no addressable call is active.

Fields

line_instance: LineInstance

call_id: Option<CallId>

HookFlash

Reports a handset hook-flash gesture on the resolved line context. Call identity is included when the gesture belongs to an active call.

Fields

call_id: Option<CallId>

line_instance: LineInstance

FeatureButton

Reports activation of a configured generic feature button. The instance identifies the exact feature definition on the station.

Fields

instance: LineInstance

DoNotDisturbButton

Reports activation of a configured do-not-disturb feature button. The instance identifies which station feature definition was pressed.

Fields

instance: LineInstance

RecordingButton

Reports activation of a configured recording feature button. The instance identifies the exact physical button that was pressed.

Fields

instance: LineInstance

MobilityButton

Reports activation of a configured mobility feature button. The instance identifies the owner of any temporary mobility appearance.

Fields

instance: LineInstance

VoicemailButton

Reports a configured voicemail-button press on an exact line and call. The server allocates or resolves the addressable call before emission.

Fields

call_id: CallId

line_instance: LineInstance

ParkingLotButton

Reports activation of a configured parking-lot feature button. Includes its feature instance, line context, and active call when present.

Fields

instance: LineInstance

Feature-button instance, distinct from the call line instance.

call_id: Option<CallId>

Active call associated with the press, when any.

line_instance: LineInstance

ParkingMenuSelection

Reports a parking slot selected from the station parking menu. Carries the configured lot identity and numeric slot chosen by the user.

Fields

lot: String

slot: u32

PhoneServiceResponse

Reports a correlated response submitted by a station phone service. The typed response retains application routing and submitted form values.

Fields

response: PhoneServiceEvent

ConferenceListAction

Reports an action selected from a station conference service document. The typed action identifies its conference, participant, and operation.

Fields

action: ConferenceListAction

ReceiveChannelOpened

Reports that the current audio receive request was acknowledged. Carries the correlated call, media status, and allocated station endpoint.

Fields

call_id: CallId

status: MediaStatus

endpoint: MediaEndpoint

MultimediaReceiveChannelOpened

Reports that the current multimedia receive channel opened successfully. Carries the correlated call, codec, endpoint, and passthrough identity.

Fields

call_id: CallId

codec: Codec

endpoint: MediaEndpointAddress

passthrough_party_id: PassthroughPartyId

MultimediaReceiveChannelFailed

Reports a negative acknowledgement for the current multimedia receive request. Carries the failed endpoint, codec, status, and correlated passthrough identity.

Fields

call_id: CallId

codec: Codec

status: MediaStatus

endpoint: MediaEndpointAddress

passthrough_party_id: PassthroughPartyId

MultimediaReceiveChannelTimedOut

Reports expiry of the current multimedia receive acknowledgement deadline. Carries the call, codec, and passthrough identity of the retired request.

Fields

call_id: CallId

codec: Codec

passthrough_party_id: PassthroughPartyId

MultimediaTransmitStarted

Reports that the current multimedia transmit request started successfully. Carries the correlated call, codec, endpoint, and passthrough identity.

Fields

call_id: CallId

codec: Codec

endpoint: MediaEndpointAddress

passthrough_party_id: PassthroughPartyId

MultimediaTransmitFailed

Reports a negative acknowledgement for the current multimedia transmit request. Carries the failed endpoint, codec, status, and correlated passthrough identity.

Fields

call_id: CallId

codec: Codec

status: MediaStatus

endpoint: MediaEndpointAddress

passthrough_party_id: PassthroughPartyId

MultimediaTransmitTimedOut

Reports expiry of the current multimedia transmit acknowledgement deadline. Carries the call, codec, and passthrough identity of the retired request.

Fields

call_id: CallId

codec: Codec

passthrough_party_id: PassthroughPartyId

TransmitChannelOpen

Fields

call_id: CallId

outcome: TransmitOpenOutcome

endpoint: MediaEndpoint

HandsetAcknowledgementTimedOut

Reports expiry of an audio receive or transmit acknowledgement deadline. Identifies the correlated call and the acknowledgement type that expired.

Fields

call_id: CallId

acknowledgement: HandsetAcknowledgement

MediaTransmissionFailed

Reports a station-declared failure of an active audio transmission. Carries the correlated call, media status, and failed remote endpoint.

Fields

call_id: CallId

status: MediaStatus

endpoint: MediaEndpoint

MulticastReceptionStarted

Reports that the current multicast receive request started successfully. Carries the exact conference, call, and admitted multicast route.

Fields

conference_id: ConferenceId

call_id: CallId

route: MulticastMediaRoute

MulticastReceptionFailed

Reports a negative acknowledgement for the current multicast receive request. Carries the exact conference, call, and station-reported failure status.

Fields

conference_id: ConferenceId

call_id: CallId

status: MediaStatus

MulticastReceptionTimedOut

Reports expiry of the current multicast receive acknowledgement deadline. Identifies the exact conference and call whose request was retired.

Fields

conference_id: ConferenceId

call_id: CallId

MulticastTransmissionStarted

Reports that multicast transmission began for the requested route. Carries the exact conference, call, and admitted multicast destination.

Fields

conference_id: ConferenceId

call_id: CallId

route: MulticastMediaRoute

MulticastTransmissionFailed

Reports a station-declared failure of multicast audio transmission. Carries the conference, call, status, and failed multicast endpoint.

Fields

conference_id: ConferenceId

call_id: CallId

status: MediaStatus

address: IpAddr

port: u16

ConnectionStatisticsCollected

Reports a correlated media-statistics response retained by the server. Carries the complete snapshot for the exact call and media generation.

Fields

snapshot: MediaStatisticsSnapshot

Alarm

Reports a decoded fixed-layout station alarm and optional parameters. Carries the station-provided severity and bounded human-readable text.

Fields

severity: AlarmSeverity

text: String

parameters: Option<[u32; 2]>

XmlAlarm

Reports a typed alarm decoded from a station XML telemetry document. The parsed telemetry exposes only the validated alarm schema and values.

Fields

telemetry: PhoneAlarmTelemetry

LocationInformation

Reports typed station location data decoded from an XML document. The telemetry retains validated address and location fields in wire order.

Fields

telemetry: PhoneLocationTelemetry

HeadsetStatusChanged

Reports that the station headset-enabled state changed. Carries the newly reported boolean state for integration-side handling.

Fields

enabled: bool

MediaPathChanged

Reports a state transition on a station media path or accessory. Carries the typed path identity and the event reported for that path.

Fields

path: MediaPathId

event: MediaPathEvent

UnhandledMessage

Reports a valid client message with no implemented server-side behavior. Preserves the decoded message so integrations can observe or log it.

Fields

message: ClientMessage

Trait Implementations

impl Clone for DeviceEventKind

fn clone(&self) -> DeviceEventKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceEventKind

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

Formats the value using the given formatter.

impl Eq for DeviceEventKind

impl PartialEq for DeviceEventKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DeviceEventKind