Enum ClientMessage

Source

pub enum ClientMessage {
Show 60 variants    KeepAlive,
    Register(RegistrationMessage),
    IpPort {
        rtp_port: u16,
    },
    KeypadButton {
        button: Digit,
        line_instance: u32,
        call_reference: u32,
        wire_layout: Option<KeypadButtonWireLayout>,
    },
    EnblocCall {
        called_party: String,
        line_instance: u32,
    },
    Stimulus {
        stimulus: Stimulus,
        instance: u32,
        call_reference: u32,
        status: u32,
    },
    OffHook {
        line_instance: u32,
        call_reference: u32,
    },
    OnHook {
        line_instance: u32,
        call_reference: u32,
    },
    OffHookWithCallingParty {
        calling_party_number: String,
        voice_mailbox: String,
        line_instance: u32,
    },
    LineStatRequest {
        line_instance: u32,
    },
    ConfigStatRequest,
    TimeDateRequest,
    ButtonTemplateRequest,
    VersionRequest,
    CapabilitiesResponse(Vec<MediaCapability>),
    CapabilitiesUpdate(CapabilityUpdate),
    OpenMultimediaReceiveChannelAck(OpenMultimediaReceiveChannelAck),
    ServerRequest,
    Alarm {
        severity: AlarmSeverity,
        text: String,
        parameters: Option<[u32; 2]>,
    },
    MulticastMediaReceptionAck {
        status: MediaStatus,
        passthrough_party_id: PassthroughPartyId,
        call_reference: CallReference,
    },
    OpenReceiveChannelAck {
        status: MediaStatus,
        address: IpAddr,
        port: u16,
        passthrough_party_id: u32,
        call_reference: u32,
    },
    SoftKeySetRequest,
    SoftKeyTemplateRequest,
    SoftKeyEvent {
        event: u32,
        line_instance: u32,
        call_reference: u32,
    },
    Unregister {
        reason: u32,
    },
    RegisterToken(RegisterTokenMessage),
    HookFlash {
        line_instance: u32,
        call_reference: u32,
    },
    ForwardStatusRequest {
        line_instance: u32,
    },
    SpeedDialStatusRequest {
        speed_dial_instance: u32,
    },
    ConnectionStatisticsResponse(ConnectionStatistics),
    HeadsetStatus {
        enabled: bool,
    },
    MediaResourceNotification(MediaResourceNotification),
    MediaPathEvent {
        path: MediaPathId,
        event: MediaPathEvent,
    },
    MediaPathCapability {
        path: MediaPathId,
        capability: MediaPathCapability,
    },
    MediaTransmissionFailure {
        conference_id: u32,
        passthrough_party_id: u32,
        address: IpAddr,
        port: u16,
        call_reference: u32,
        status: MediaStatus,
    },
    RegisterAvailableLines {
        lines: u32,
    },
    ServiceUrlStatusRequest {
        index: u32,
    },
    FeatureStatusRequest {
        index: u32,
        capabilities: u32,
    },
    StartMediaTransmissionAck(MediaTransmissionAck),
    StartMultimediaTransmissionAck(StartMultimediaTransmissionAck),
    ExtensionDeviceCapabilities(ExtensionDeviceCapabilities),
    DeviceToUserData(UserDataMessage),
    DeviceToUserDataResponse(UserDataMessage),
    DeviceToUserDataV1(UserDataV1Message),
    DeviceToUserDataResponseV1(UserDataV1Message),
    PortResponse(PortEndpoint),
    SubscriptionStatusRequest(SubscriptionRequest),
    SubscribeDtmfPayloadResponse(DtmfPayloadIdentity),
    UnsubscribeDtmfPayloadResponse(DtmfPayloadIdentity),
    LocationInfo {
        xml: String,
    },
    XmlAlarm(XmlAlarmMessage),
    CallCountRequest {
        value: u32,
    },
    CreateConferenceResponse(CreateConferenceResponse),
    DeleteConferenceResponse {
        conference_id: ConferenceId,
        result: DeleteConferenceResult,
    },
    ModifyConferenceResponse(ModifyConferenceResponse),
    AuditConferenceResponse(AuditConferenceResponse),
    AddParticipantResponse(AddParticipantResponse),
    AuditParticipantResponse(AuditParticipantResponse),
    KnownOpaque(KnownOpaqueMessage),
    Unknown(RawMessage),
}

Expand description

Typed messages accepted from a station connection.

Variants correspond to station-to-control identifiers in catalog::MessageId. KnownOpaque retains a known catalog entry without a typed payload, while Unknown retains an unrecognized identifier. Decode with Self::decode during registration and Self::decode_with_version after version negotiation.