Native
Synchronous
No Custom Parameters
AddIconItem adds the definition for an icon item to an already-initialized IconMenu or IconFileMenu XML object.
AddIconItem is used to define the content of an icon, but not where it is displayed on the Cisco IP Phone. The IconIndex action parameter in the AddMenuItem action refers to the index of this icon for display.
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 either SendResponse or SendExecute.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| Index | System.UInt16 | The index of the icon. | |
| Height | System.UInt16 | The height of the icon (in pixels). This value should only be specified if one is saving the ResultData to IconMenu. | |
| Width | System.UInt16 | The width of the icon (in pixels). This value should only be specified if one is saving the ResultData to IconMenu. | |
| Depth | System.UInt16 | The color depth of the image. This value should only be specified if one is saving the ResultData to IconMenu. | |
| Data | System.String | The image data to be displayed. There are no utilities to help format this data. Refer to the Cisco IP Phone Developer documentation. This value should only be specified if one is saving the ResultData to IconMenu. | |
| URL | System.String | The URL of the PNG image to display. This URL must be accessible to the phone. This value should only be specified if one is saving the ResultData to IconFileMenu. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ResultData | Metreos.Types.CiscoIpPhone.CiscoIPPhoneIconItemType | One must always save this result data into a IconMenu or IconFileMenu XML type variable. |
Branch Conditions
No description.
No description.