Module xml 

Bounded XML documents for interactive phone displays and telemetry. Typed XML documents exchanged with phone services.

Known document schemas go through this Serde boundary so size, encoding, and document-type policy is applied consistently before a model is used.

Structs

CiscoIpPhoneAlarm

A typed LastOutOfServiceInformation alarm document.

CiscoIpPhoneAlarmEntry

The single supported alarm entry within an alarm document.

CiscoIpPhoneAlarmEnum

One named numeric enumeration in a phone alarm parameter list.

CiscoIpPhoneAlarmParameterList

Ordered parameters carried by a supported phone alarm.

CiscoIpPhoneAlarmString

One named string value in a phone alarm parameter list.

CiscoIpPhoneBackground

Full-size and thumbnail URLs installed as the phone background.

CiscoIpPhoneDirectory

A complete, schema-ordered phone directory response.

CiscoIpPhoneDirectoryEntry

A directory entry containing an optional display name and dialable value.

CiscoIpPhoneExecute

A complete, schema-ordered execute document.

CiscoIpPhoneExecuteItem

One ordered URL action in an execute document.

CiscoIpPhoneGraphicFileMenu

A complete URL-backed graphic menu document.

CiscoIpPhoneGraphicMenu

A complete inline-bitmap graphic menu document.

CiscoIpPhoneIconFileItem

One indexed referenced icon used by an icon-file menu.

CiscoIpPhoneIconFileMenu

A complete menu whose icons are loaded from resource URLs.

CiscoIpPhoneIconItem

One indexed inline bitmap icon used by an icon menu.

CiscoIpPhoneIconMenu

A complete menu whose icons are inline hexadecimal bitmaps.

CiscoIpPhoneIconMenuItem

One optional label/action pair with an optional icon association.

CiscoIpPhoneIconTitle

Icon-bearing title used by an icon-file menu.

CiscoIpPhoneImage

A complete inline-bitmap image document.

CiscoIpPhoneImageFile

A complete URL-backed image document.

CiscoIpPhoneImageList

The ordered background choices pulled from a desktop List.xml resource.

CiscoIpPhoneImageListItem

One ordered full-size/thumbnail pair in a background image list.

CiscoIpPhoneInput

A complete, schema-ordered interactive input document.

CiscoIpPhoneInputItem

One field in a phone input-service document.

CiscoIpPhoneKeyItem

Press and optional release actions bound to one physical key.

CiscoIpPhoneLocationInformation

Typed wireless location-information document for interface one.

CiscoIpPhoneMenu

A complete plain menu with optional lifecycle and physical-key actions.

CiscoIpPhoneMenuItem

One optional label/action pair in a plain menu.

CiscoIpPhoneOffPremises

Empty marker indicating that the phone considers itself off premises.

CiscoIpPhoneSetBackground

Background-selection application document.

CiscoIpPhoneSetBackgroundPreview

Background-preview application document.

CiscoIpPhoneSetRingTone

Ringtone-selection application document.

CiscoIpPhoneSoftKeyItem

Optional label and press/release actions assigned to one soft-key slot.

CiscoIpPhoneStatus

A bitmap-backed status item displayed in the phone’s status area.

CiscoIpPhoneStatusFile

A URL-backed status item displayed in the phone’s status area.

CiscoIpPhoneText

A complete, schema-ordered text display document.

CiscoIpPhoneTouchAreaMenuItem

One optional label, action, and selection region in a graphic-file menu.

CiscoIpPhoneWifiLocation

Wireless location fields reported for the phone’s first interface.

ConferenceListEntry

Participant state needed to render conference menus and allowed actions.

OpaquePhoneAlarm

Exact bounded bytes for a syntactically valid but unsupported alarm schema.

OpaquePhoneLocation

Exact bounded bytes for a syntactically valid unsupported location schema.

PhoneAlarmSummary

Secret-safe fields selected from a known alarm document.

PhoneBackgroundHttpUrl

An HTTP URL accepted by the background selection and preview application.

PhoneBackgroundTftpUrl

A TFTP URI accepted in a background-image selection list.

PhoneBitmapData

Validated hexadecimal bitmap data used by image-service documents.

PhoneBssid

A six-octet wireless basic-service-set address with redacted diagnostics.

PhoneExecutePriority

Valid priority for one phone execute action.

PhoneExecuteUrl

A schema-bounded action in a phone execute document.

PhoneImageUrl

A schema-bounded image resource URL.

PhoneInputParameterName

A schema-bounded name used for one submitted query parameter.

PhoneLocationSummary

Secret-safe location summary without network names or addresses.

PhoneRingtoneUrl

An HTTP resource URL accepted by the ringtone-selection application.

PhoneServicePriority

Valid display priority for a phone-service application-data envelope.

PhoneSoftKeyPosition

A phone soft-key slot. -1 is the documented application/settings slot; physical rows use positions 1 through 16. Device-profile code may impose a smaller maximum without weakening the shared XML model.

PhoneTouchArea

A rectangular selection region in a graphic-file menu.

PhoneXmlRefresh

Typed HTTP refresh metadata for a pulled phone-service document.

Enums

CiscoIpPhoneAlarmParameter

An ordered, typed alarm parameter.

ConferenceListAction

Typed callback encoded into conference menu action URLs.

ConferenceListDocument

Rendered conference overview in either supported menu family.

ConferenceMenuFamily

Display schema used when rendering conference workflows.

ConferenceParticipantActionsDocument

Participant-specific conference actions in either supported menu family.

PhoneActionKind

The two execution domains understood by phone services.

PhoneAlarmKind

Allowlisted alarm family that is safe to publish without parameter data.

PhoneAlarmTelemetry

Parsed alarm telemetry or a bounded lossless unknown schema.

PhoneBackgroundControlDocument

Either application document accepted by the background-control service.

PhoneImageDocument

Any accepted image-service document family.

PhoneInputFlags

One of the input modes accepted by a phone input-service field.

PhoneKeypadTarget

The application focus that receives keypad events for a displayable phone service document.

PhoneLocationKind

Allowlisted location family that is safe to publish without location data.

PhoneLocationTelemetry

Parsed location telemetry or a bounded lossless unsupported schema.

PhoneStatusDocument

Either accepted status-service document family.

PhoneXmlError

Schema, resource-limit, and serialization failures at the XML boundary.

PhoneXmlKey

A physical key event routed by a displayable phone service document.

Constants

CONFERENCE_LIST_MAX_BYTES

Maximum encoded conference menu size, in bytes.

CONFERENCE_LIST_MAX_PARTICIPANTS

Maximum participants represented by a conference menu document.

PHONE_ALARM_MAX_BYTES

Maximum encoded alarm telemetry size, in bytes.

PHONE_BACKGROUND_APPLICATION_ID

Reserved application identifier used by background-image workflows.

PHONE_BACKGROUND_CONTROL_MAX_BYTES

Maximum encoded background-control document size, in bytes.

PHONE_BACKGROUND_LIST_MAX_BYTES

Maximum encoded background-image list size, in bytes.

PHONE_BACKGROUND_LIST_MAX_ITEMS

Maximum choices in a background-image list.

PHONE_DIRECTORY_MAX_BYTES

Maximum encoded directory document size, in bytes.

PHONE_DIRECTORY_MAX_ENTRIES

Maximum entries accepted in a directory document.

PHONE_EXECUTE_MAX_BYTES

Maximum encoded execute document size, in bytes.

PHONE_EXECUTE_MAX_ITEMS

Maximum actions in one execute document.

PHONE_GRAPHIC_FILE_MENU_MAX_ITEMS

Maximum touch entries in an image-file graphic menu.

PHONE_GRAPHIC_MENU_MAX_ITEMS

Maximum touch entries in an inline-bitmap graphic menu.

PHONE_ICON_MENU_MAX_ICONS

Maximum embedded or referenced icons in an icon menu document.

PHONE_ICON_MENU_MAX_ITEMS

Maximum selectable entries in an icon menu document.

PHONE_IMAGE_BITMAP_MAX_BYTES

Maximum decoded bitmap data in an inline image, in bytes.

PHONE_IMAGE_MAX_BYTES

Maximum encoded size shared by image document families, in bytes.

PHONE_INPUT_MAX_BYTES

Maximum encoded input document size, in bytes.

PHONE_INPUT_MAX_ITEMS

Maximum input controls in one input document.

PHONE_LOCATION_MAX_BYTES

Maximum encoded location telemetry size, in bytes.

PHONE_MENU_MAX_BYTES

Maximum encoded size shared by menu document families, in bytes.

PHONE_MENU_MAX_ITEMS

Maximum selectable entries in a plain menu document.

PHONE_RINGTONE_APPLICATION_ID

Reserved application identifier used by ringtone workflows.

PHONE_RINGTONE_MAX_BYTES

Maximum encoded ringtone-control document size, in bytes.

PHONE_STATUS_BITMAP_MAX_BYTES

Maximum decoded bitmap data in a status document, in bytes.

PHONE_STATUS_MAX_BYTES

Maximum encoded size shared by status document families, in bytes.

PHONE_TEXT_APPLICATION_ID

Reserved application identifier used by text-display workflows.

PHONE_TEXT_LEGACY_MAX_CHARS

Compatibility character bound for display profiles with smaller text capacity.

PHONE_TEXT_MAX_BYTES

Maximum encoded text document size, in bytes.

PHONE_TEXT_MAX_CHARS

Maximum Unicode character count for a text document body.

PHONE_XML_MAX_NESTING_DEPTH

Maximum element nesting accepted before deserialization.

Traits

PhoneXmlDocument

Common bounded parsing and serialization contract for a complete phone XML document.

Functions

from_bytes

Parses bounded UTF-8, US-ASCII, or ISO-8859-1 XML using the encoding named in the declaration. The XML reader, rather than an ad-hoc byte scan, owns decoding, entity policy, and nesting validation.

parse_phone_alarm

Parse one bounded alarm document without treating malformed known XML as an opaque schema.

parse_phone_location

Parse one bounded location-information document without treating a malformed supported root as an opaque schema.

to_string

Serializes a known Serde model and rejects an oversized result.

to_writer

Serializes through the bounded string boundary before touching the writer.