Native
Synchronous
No Custom Parameters
AddSoftKeyItem adds a softkey item with any already-initialized XML object except the Status or Execute type.
AddSoftKeyItem adds a softkey to an XML object, giving the user a button at the bottom of the display on the Cisco IP 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 |
|---|---|---|---|
| Name | System.String | The display name of the softkey item. | |
| Position | System.Int16 | The 1-indexed position of the softkey item. | |
| URL | System.String | The URL that the phone will request if this softkey item is selected. | |
| 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. Does not apply to 'URLDown' parameter. |
| URLDown | System.String | The command that the phone should execute when the softkey button is depressed. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ResultData | Metreos.Types.CiscoIpPhone.CiscoIPPhoneSoftKeyType | One must always save this result data into one of the following: a Text, Menu, Directory, Image, Input, ImageFile, IconMenu, IconFileMenu, GraphicMenu, or GraphicFileMenu XML type variable. |
Branch Conditions
No description.
No description.