Native
Synchronous
No Custom Parameters
CreateImageFile initializes a ImageFile XML object, which one can later use to display a PNG-based image on certain Cisco IP Phones.
CreateImageFile allows the developer to establish the Title, Prompt, and image properties of the Cisco IP Phone ImageFile XML object. These parameters are stored into the ImageFile XML type. This type can later be manipulated further by using the AddSoftKeyItem action to add softkeys to the image file object.
The Image Builder API can help one create dynamic PNG images for the use with CreateImageFile.
If the phone supports touch-screen functionality and you wish to leverage it, instead consider using the CreateGraphicFileMenu action. CretaeImageFile does not allow you to use touch-screen functionality of the phone.
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 file 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). | |
| URL | System.String | The URL of the PNG image to display. This URL must be accessible to the phone. | |
| Format URL | System.Boolean | true | Indicates that URL format validation should be performed on the URL specified. This may involve modifications being made to the URL. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ResultData | Metreos.Types.CiscoIpPhone.CiscoIPPhoneImageFileType | One must always save this result data into a ImageFile XML type variable. |
Branch Conditions
No description.
No description.