Native
Synchronous
No Custom Parameters
CreateImage initializes a Image XML object, which one can later use to display an image on certain Cisco IP Phones.
CreateImage allows the developer to establish the Title, Prompt, and image properties of the Cisco IP Phone Image XML object. These parameters are stored into the Image XML type. This type can later be manipulated further by using the AddSoftKeyItem action to add softkeys to the image object.
CreateImage and CreateGraphicMenu differ only in that, with CreateGraphicMenu, one can specify menu items in addition to the image content. The menu items do not display visually; instead, they correspond to keys on the number pad of the phone. So, practically, an image shown on a graphic menu will also provide visual cues so that the user can determine which key on the keypad to push for a particular option.
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 |
|---|---|---|---|
| Title | System.String | The title of the image XML object. This will be displayed on the Cisco IP Phone. | |
| Prompt | System.String | The prompt to the user to indicate the action that needs to be taken. This will de displayed on the Cisco IP Phone. | |
| LocationX | System.Int16 | The X-coordinate of the image (in pixels). | |
| LocationY | System.Int16 | The Y-coordinate of the image (in pixels). | |
| Height | System.UInt16 | The height of the image (in pixels). | |
| Width | System.UInt16 | The width of the image (in pixels). | |
| Depth | System.UInt16 | The color depth of the image. | |
| 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. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ResultData | Metreos.Types.CiscoIpPhone.CiscoIPPhoneImageType | One must always save this result data into a Image XML type variable. |
Branch Conditions
No description.
No description.