CreateStatusFile

Metreos.Native.CiscoIpPhone.CreateStatusFile

Summary

CreateStatusFile initializes a StatusFile XML object, which one can later use to display a status bar on a Cisco IP Phone in order to show an small text blurb and optionally a small, PNG-based image in the middle of the Cisco IP phone that is always present in the call plane, and unremovable by the user.

Usage

CreateStatusFile allows the developer to establish the Timer, Text, and the image properties of a Cisco IP Phone StatusFile XML object. These parameters are stored into the StatusFile XML type. This type can not be modified by any other Cisco IP Phone XML actions, such as softkeys, menu items, icons, or directory entries.

Remarks

This action does not communicate with a Cisco IP Phone; it only formats XML specific to the schema defined by the Cisco IP Phones that support Cisco IP Phone XML Services. Later in the script the XML object stored in a variable can be sent to the phone with the SendExecute action.

Action Parameters
Parameter Name.NET TypeDefaultDescription
TextSystem.StringA single line of text to show on the status XML object. This will be displayed on the Cisco IP Phone.
TimerSystem.Int16The timer seed value (in seconds). If specified, a timer will be displayed on the status bar.
LocationXSystem.Int16The X-coordinate of the image (in pixels).
LocationYSystem.Int16The Y-coordinate of the image (in pixels).
UrlSystem.StringThe URL of the PNG image to display on the status bar. This URL must be accessible to the phone.
Format URLSystem.BooleantrueIndicates that URL format validation should be performed on the URL specified. This may involve modifications being made to the URL.
Result Data
Parameter Name.NET TypeDescription
ResultDataMetreos.Types.CiscoIpPhone.CiscoIPPhoneStatusFileTypeOne must always save this result data into a StatusFile XML type variable.

Branch Conditions 

Success

No description.

Failure

No description.