cisco.uc.cuae.legacy
Interface CiscoIpPhoneServer

All Superinterfaces:

CiscoIpPhone, CuaeCommon, CuaeCommonServer

All Known Implementing Classes:

BaseCiscoIpPhoneServer, RemoteCiscoIpPhoneServer

public interface CiscoIpPhoneServer
extends CiscoIpPhone, CuaeCommonServer

Generated from CUAE provider package Metreos.Native.CiscoIPPhone The Cisco IP Phone API allows developers to easily and quickly create IP Phone XML objects. One can use this API to create textual displays, menus, directories, images and the other XML-based features that the Cisco IP Phone supports. Note that while this API simplifies interaction with the Cisco IP Phone phones, you must still read the developer documentation available on the Cisco IP Phone XML objects in order to use this API successfully.

Nested Class Summary

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CiscoIpPhone

CiscoIpPhone.AddDirectoryEntryOptions, CiscoIpPhone.AddDirectoryEntryResult, CiscoIpPhone.AddIconItemOptions, CiscoIpPhone.AddIconItemResult, CiscoIpPhone.AddInputItemOptions, CiscoIpPhone.AddInputItemResult, CiscoIpPhone.AddMenuItemOptions, CiscoIpPhone.AddMenuItemResult, CiscoIpPhone.AddSoftKeyItemOptions, CiscoIpPhone.AddSoftKeyItemResult, CiscoIpPhone.CiscoIPPhoneDirectoryEntryType, CiscoIpPhone.CiscoIPPhoneDirectoryType, CiscoIpPhone.CiscoIPPhoneErrorType, CiscoIpPhone.CiscoIPPhoneExecuteItemType, CiscoIpPhone.CiscoIPPhoneExecuteType, CiscoIpPhone.CiscoIPPhoneGraphicFileMenuType, CiscoIpPhone.CiscoIPPhoneGraphicMenuType, CiscoIpPhone.CiscoIPPhoneIconFileMenuType, CiscoIpPhone.CiscoIPPhoneIconItemType, CiscoIpPhone.CiscoIPPhoneIconMenuType, CiscoIpPhone.CiscoIPPhoneImageFileType, CiscoIpPhone.CiscoIPPhoneImageType, CiscoIpPhone.CiscoIPPhoneInputItemType, CiscoIpPhone.CiscoIPPhoneInputType, CiscoIpPhone.CiscoIPPhoneMenuItemType, CiscoIpPhone.CiscoIPPhoneMenuType, CiscoIpPhone.CiscoIPPhoneResponseItemType, CiscoIpPhone.CiscoIPPhoneResponseType, CiscoIpPhone.CiscoIPPhoneSoftKeyType, CiscoIpPhone.CiscoIPPhoneStatusFileType, CiscoIpPhone.CiscoIPPhoneStatusType, CiscoIpPhone.CiscoIPPhoneTextType, CiscoIpPhone.CiscoIPPhoneTouchAreaType, CiscoIpPhone.ConstructDirectoryOptions, CiscoIpPhone.ConstructDirectoryResult, CiscoIpPhone.ConstructExecuteOptions, CiscoIpPhone.ConstructExecuteResult, CiscoIpPhone.ConstructGraphicFileMenuOptions, CiscoIpPhone.ConstructGraphicFileMenuResult, CiscoIpPhone.ConstructGraphicMenuOptions, CiscoIpPhone.ConstructGraphicMenuResult, CiscoIpPhone.ConstructIconFileMenuOptions, CiscoIpPhone.ConstructIconFileMenuResult, CiscoIpPhone.ConstructIconMenuOptions, CiscoIpPhone.ConstructIconMenuResult, CiscoIpPhone.ConstructImageFileOptions, CiscoIpPhone.ConstructImageFileResult, CiscoIpPhone.ConstructImageOptions, CiscoIpPhone.ConstructImageResult, CiscoIpPhone.ConstructInputOptions, CiscoIpPhone.ConstructInputResult, CiscoIpPhone.ConstructMenuOptions, CiscoIpPhone.ConstructMenuResult, CiscoIpPhone.ConstructStatusFileOptions, CiscoIpPhone.ConstructStatusFileResult, CiscoIpPhone.ConstructStatusOptions, CiscoIpPhone.ConstructStatusResult, CiscoIpPhone.ConstructTextOptions, CiscoIpPhone.ConstructTextResult, CiscoIpPhone.CreateDirectoryOptions, CiscoIpPhone.CreateDirectoryResult, CiscoIpPhone.CreateExecuteOptions, CiscoIpPhone.CreateExecuteResult, CiscoIpPhone.CreateGraphicFileMenuOptions, CiscoIpPhone.CreateGraphicFileMenuResult, CiscoIpPhone.CreateGraphicMenuOptions, CiscoIpPhone.CreateGraphicMenuResult, CiscoIpPhone.CreateIconFileMenuOptions, CiscoIpPhone.CreateIconFileMenuResult, CiscoIpPhone.CreateIconMenuOptions, CiscoIpPhone.CreateIconMenuResult, CiscoIpPhone.CreateImageFileOptions, CiscoIpPhone.CreateImageFileResult, CiscoIpPhone.CreateImageOptions, CiscoIpPhone.CreateImageResult, CiscoIpPhone.CreateInputOptions, CiscoIpPhone.CreateInputResult, CiscoIpPhone.CreateMenuOptions, CiscoIpPhone.CreateMenuResult, CiscoIpPhone.CreateStatusFileOptions, CiscoIpPhone.CreateStatusFileResult, CiscoIpPhone.CreateStatusOptions, CiscoIpPhone.CreateStatusResult, CiscoIpPhone.CreateTextOptions, CiscoIpPhone.CreateTextResult, CiscoIpPhone.SendExecuteOptions, CiscoIpPhone.SendExecuteResult

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CuaeCommon

CuaeCommon.CuaeResult

Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CuaeCommon

CuaeCommon.CuaeResult

Method Summary

CiscoIpPhone.AddDirectoryEntryResult	addDirectoryEntry(java.lang.String sessionId, CiscoIpPhone.AddDirectoryEntryOptions options) Generated from CUAE Action AddDirectoryEntry Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary AddDirectoryEntry adds a directory entry to an already-initialized Directory XML object.
CiscoIpPhone.AddIconItemResult	addIconItemToIconFileMenu(java.lang.String sessionId, CiscoIpPhone.AddIconItemOptions options)
CiscoIpPhone.AddIconItemResult	addIconItemToIconMenu(java.lang.String sessionId, CiscoIpPhone.AddIconItemOptions options) Generated from CUAE Action AddIconItem Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary AddIconItem adds the definition for an icon item to an already-initialized IconMenu or IconFileMenu XML object.
CiscoIpPhone.AddInputItemResult	addInputItem(java.lang.String sessionId, CiscoIpPhone.AddInputItemOptions options) Generated from CUAE Action AddInputItem Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary AddInputItem adds an input item to an already-initialized Input XML object.
CiscoIpPhone.AddMenuItemResult	addMenuItemToGraphicFileMenu(java.lang.String sessionId, CiscoIpPhone.AddMenuItemOptions options)
CiscoIpPhone.AddMenuItemResult	addMenuItemToGraphicMenu(java.lang.String sessionId, CiscoIpPhone.AddMenuItemOptions options)
CiscoIpPhone.AddMenuItemResult	addMenuItemToIconFileMenu(java.lang.String sessionId, CiscoIpPhone.AddMenuItemOptions options)
CiscoIpPhone.AddMenuItemResult	addMenuItemToIconMenu(java.lang.String sessionId, CiscoIpPhone.AddMenuItemOptions options)
CiscoIpPhone.AddMenuItemResult	addMenuItemToMenu(java.lang.String sessionId, CiscoIpPhone.AddMenuItemOptions options) Generated from CUAE Action AddMenuItem Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary AddMenuItem adds a menu item to an already-initialized Menu, IconMenu, IconFileMenu, GraphicMenu, or GraphicFileMenu XML object.
CiscoIpPhone.AddSoftKeyItemResult	addSoftKeyItemToDirectory(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options)
CiscoIpPhone.AddSoftKeyItemResult	addSoftKeyItemToGraphicFileMenu(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options)
CiscoIpPhone.AddSoftKeyItemResult	addSoftKeyItemToGraphicMenu(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options)
CiscoIpPhone.AddSoftKeyItemResult	addSoftKeyItemToIconFileMenu(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options)
CiscoIpPhone.AddSoftKeyItemResult	addSoftKeyItemToIconMenu(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options)
CiscoIpPhone.AddSoftKeyItemResult	addSoftKeyItemToImage(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options)
CiscoIpPhone.AddSoftKeyItemResult	addSoftKeyItemToImageFile(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options)
CiscoIpPhone.AddSoftKeyItemResult	addSoftKeyItemToInput(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options)
CiscoIpPhone.AddSoftKeyItemResult	addSoftKeyItemToMenu(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options)
CiscoIpPhone.AddSoftKeyItemResult	addSoftKeyItemToText(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Generated from CUAE Action AddSoftKeyItem.
CiscoIpPhone.ConstructDirectoryResult	constructDirectory(java.lang.String sessionId, CiscoIpPhone.ConstructDirectoryOptions options)
CiscoIpPhone.ConstructExecuteResult	constructExecute(java.lang.String sessionId, CiscoIpPhone.ConstructExecuteOptions options)
CiscoIpPhone.ConstructGraphicFileMenuResult	constructGraphicFileMenu(java.lang.String sessionId, CiscoIpPhone.ConstructGraphicFileMenuOptions options)
CiscoIpPhone.ConstructGraphicMenuResult	constructGraphicMenu(java.lang.String sessionId, CiscoIpPhone.ConstructGraphicMenuOptions options)
CiscoIpPhone.ConstructIconFileMenuResult	constructIconFileMenu(java.lang.String sessionId, CiscoIpPhone.ConstructIconFileMenuOptions options)
CiscoIpPhone.ConstructIconMenuResult	constructIconMenu(java.lang.String sessionId, CiscoIpPhone.ConstructIconMenuOptions options)
CiscoIpPhone.ConstructImageResult	constructImage(java.lang.String sessionId, CiscoIpPhone.ConstructImageOptions options)
CiscoIpPhone.ConstructImageFileResult	constructImageFile(java.lang.String sessionId, CiscoIpPhone.ConstructImageFileOptions options)
CiscoIpPhone.ConstructInputResult	constructInput(java.lang.String sessionId, CiscoIpPhone.ConstructInputOptions options)
CiscoIpPhone.ConstructMenuResult	constructMenu(java.lang.String sessionId, CiscoIpPhone.ConstructMenuOptions options)
CiscoIpPhone.ConstructStatusResult	constructStatus(java.lang.String sessionId, CiscoIpPhone.ConstructStatusOptions options)
CiscoIpPhone.ConstructStatusFileResult	constructStatusFile(java.lang.String sessionId, CiscoIpPhone.ConstructStatusFileOptions options)
CiscoIpPhone.ConstructTextResult	constructText(java.lang.String sessionId, CiscoIpPhone.ConstructTextOptions options)
CiscoIpPhone.CreateDirectoryResult	createDirectory(java.lang.String sessionId, CiscoIpPhone.CreateDirectoryOptions options) Generated from CUAE Action CreateDirectory Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateDirectory initializes a Directory XML object, which one can later use to display a directory on a Cisco IP Phone in order to allow on to cause their phone to dial the number of a selected directory entry on the phone screen.
CiscoIpPhone.CreateExecuteResult	createExecute(java.lang.String sessionId, CiscoIpPhone.CreateExecuteOptions options) Generated from CUAE Action CreateExecute Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateExecute initializes a Execute XML object, so that one later push the XML execute command object to a Cisco IP Phone.
CiscoIpPhone.CreateGraphicFileMenuResult	createGraphicFileMenu(java.lang.String sessionId, CiscoIpPhone.CreateGraphicFileMenuOptions options) Generated from CUAE Action CreateGraphicFileMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateGraphicFileMenu initializes a GraphicFileMenu XML object, which one can later use to display a PNG-based menu on a Cisco IP Phone.
CiscoIpPhone.CreateGraphicMenuResult	createGraphicMenu(java.lang.String sessionId, CiscoIpPhone.CreateGraphicMenuOptions options) Generated from CUAE Action CreateGraphicMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateGraphicMenu initializes a GraphicMenu XML object, which one can later use to display a graphical menu on a Cisco IP Phone, in which the number keys on the Cisco IP phone can be used to trigger phone activity.
CiscoIpPhone.CreateIconFileMenuResult	createIconFileMenu(java.lang.String sessionId, CiscoIpPhone.CreateIconFileMenuOptions options) Generated from CUAE Action CreateIconFileMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateIconFileMenu initializes a IconFileMenu XML object, which one can later use to display an icon menu on a Cisco IP Phone.
CiscoIpPhone.CreateIconMenuResult	createIconMenu(java.lang.String sessionId, CiscoIpPhone.CreateIconMenuOptions options) Generated from CUAE Action CreateIconMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateIconMenu initializes a IconMenu XML object, which one can later use to display an icon menu on a Cisco IP Phone.
CiscoIpPhone.CreateImageResult	createImage(java.lang.String sessionId, CiscoIpPhone.CreateImageOptions options) Generated from CUAE Action CreateImage Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateImage initializes a Image XML object, which one can later use to display an image on certain Cisco IP Phones.
CiscoIpPhone.CreateImageFileResult	createImageFile(java.lang.String sessionId, CiscoIpPhone.CreateImageFileOptions options) Generated from CUAE Action CreateImageFile Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateImageFile initializes a ImageFile XML object, which one can later use to display a PNG-based image on certain Cisco IP Phones.
CiscoIpPhone.CreateInputResult	createInput(java.lang.String sessionId, CiscoIpPhone.CreateInputOptions options) Generated from CUAE Action CreateInput Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateInput initializes a Input XML object, which one can later use to display an input form on a Cisco IP Phone in order to allow the user to input and submit data back to the script.
CiscoIpPhone.CreateMenuResult	createMenu(java.lang.String sessionId, CiscoIpPhone.CreateMenuOptions options) Generated from CUAE Action CreateMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateMenu initializes a Menu XML object, which one can later use to display a menu on a Cisco IP Phone.
CiscoIpPhone.CreateStatusResult	createStatus(java.lang.String sessionId, CiscoIpPhone.CreateStatusOptions options) Generated from CUAE Action CreateStatus Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateStatus initializes a Status 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 image in the middle of the Cisco IP phone that is always present in the call plane, and unremovable by the user.
CiscoIpPhone.CreateStatusFileResult	createStatusFile(java.lang.String sessionId, CiscoIpPhone.CreateStatusFileOptions options) Generated from CUAE Action CreateStatusFile Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false 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.
CiscoIpPhone.CreateTextResult	createText(java.lang.String sessionId, CiscoIpPhone.CreateTextOptions options) Generated from CUAE Action CreateText Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateText initializes a Text XML object, which one can later use to display text on a Cisco IP Phone.
CiscoIpPhone.SendExecuteResult	sendExecute(java.lang.String sessionId, java.lang.String message, java.lang.String uRL, CiscoIpPhone.SendExecuteOptions options) Generated from CUAE Action SendExecute Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary SendExecute sends an XML object directly to the Cisco IP Phone using an HTTP POST.

Method Detail

addDirectoryEntry

CiscoIpPhone.AddDirectoryEntryResult addDirectoryEntry(java.lang.String sessionId,
                                                       CiscoIpPhone.AddDirectoryEntryOptions options)

Generated from CUAE Action AddDirectoryEntry Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary AddDirectoryEntry adds a directory entry to an already-initialized Directory XML object. Usage AddDirectoryEntry allows the developer to define a Name and Telephone number, which are formatted into a directory entry and used to augment the contents of a Cisco IP Phone Directory XML object. This directory entry is stored into the Directory XML type that was previously initialized with the CreateDirectory action. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

addIconItemToIconMenu

CiscoIpPhone.AddIconItemResult addIconItemToIconMenu(java.lang.String sessionId,
                                                     CiscoIpPhone.AddIconItemOptions options)

Generated from CUAE Action AddIconItem Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary AddIconItem adds the definition for an icon item to an already-initialized IconMenu or IconFileMenu XML object. Usage 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. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

addIconItemToIconFileMenu

CiscoIpPhone.AddIconItemResult addIconItemToIconFileMenu(java.lang.String sessionId,
                                                         CiscoIpPhone.AddIconItemOptions options)

addInputItem

CiscoIpPhone.AddInputItemResult addInputItem(java.lang.String sessionId,
                                             CiscoIpPhone.AddInputItemOptions options)

Generated from CUAE Action AddInputItem Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary AddInputItem adds an input item to an already-initialized Input XML object. Usage AddInputItem allows the developer to define the properties of a user-accessible prompt that will be added to a Cisco IP Phone Input XML object. This input item is stored into the Input XML type that was previously initialized with the CreateInput action. It is important to understand the interaction between the URL action parameter specified in CreateInput and the QueryStringParam action parameter in the AddInputItem action. The URL action parameter in CreateInput defines the base URL. Each QueryStringParam of any input items are appended to the base URL as a query parameter, with the value of the text entered by the user defined as the value of the query parameter. For example, assume we specified a URL of http://appserver:8000/myscript and a QueryStringParam with a value of userid, and also assume the user enters the value bob on the phone for that input item. When the user hits the Submit softkey on the Cisco IP Phone, the phone will generate a request to the URI http://appserver:8000/myscript?userid=bob. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

addMenuItemToMenu

CiscoIpPhone.AddMenuItemResult addMenuItemToMenu(java.lang.String sessionId,
                                                 CiscoIpPhone.AddMenuItemOptions options)

Generated from CUAE Action AddMenuItem Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary AddMenuItem adds a menu item to an already-initialized Menu, IconMenu, IconFileMenu, GraphicMenu, or GraphicFileMenu XML object. Usage AddMenuItem is a multi-purpose action which is used in different ways based on which XML object type it is being used to augment. The reason is that a MenuItem has different meaning depending on which context, and more specifically, which XML object it is being used on. The following is a list of which action parameters are of interest based on which XML object is being augmented with AddMenuItem.: Menu XML objects respect the Name and URL action parameters. IconMenu XML objects respect the Name, URL, and IconIndex action parameters. IconFileMenu XML objects respect the Name, URL, and IconIndex action parameters. GraphicMenu XML objects respect the Name and URL action parameters. GraphicFileMenu XML objects respect the Name, URL, TouchAreaX1, TouchAreaX2, TouchAreaY1, and TouchAreaY2 action parameters. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

addMenuItemToIconMenu

CiscoIpPhone.AddMenuItemResult addMenuItemToIconMenu(java.lang.String sessionId,
                                                     CiscoIpPhone.AddMenuItemOptions options)

addMenuItemToIconFileMenu

CiscoIpPhone.AddMenuItemResult addMenuItemToIconFileMenu(java.lang.String sessionId,
                                                         CiscoIpPhone.AddMenuItemOptions options)

addMenuItemToGraphicMenu

CiscoIpPhone.AddMenuItemResult addMenuItemToGraphicMenu(java.lang.String sessionId,
                                                        CiscoIpPhone.AddMenuItemOptions options)

addMenuItemToGraphicFileMenu

CiscoIpPhone.AddMenuItemResult addMenuItemToGraphicFileMenu(java.lang.String sessionId,
                                                            CiscoIpPhone.AddMenuItemOptions options)

addSoftKeyItemToText

CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToText(java.lang.String sessionId,
                                                       CiscoIpPhone.AddSoftKeyItemOptions options)

Generated from CUAE Action AddSoftKeyItem. Display name was AddSoftkeyItem Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary AddSoftKeyItem adds a softkey item with any already-initialized XML object except the Status or Execute type. Usage AddSoftKeyItem adds a softkey to an XML object, giving the user a button at the bottom of the display on the Cisco IP Phone. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

addSoftKeyItemToMenu

CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToMenu(java.lang.String sessionId,
                                                       CiscoIpPhone.AddSoftKeyItemOptions options)

addSoftKeyItemToDirectory

CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToDirectory(java.lang.String sessionId,
                                                            CiscoIpPhone.AddSoftKeyItemOptions options)

addSoftKeyItemToImage

CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToImage(java.lang.String sessionId,
                                                        CiscoIpPhone.AddSoftKeyItemOptions options)

addSoftKeyItemToInput

CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToInput(java.lang.String sessionId,
                                                        CiscoIpPhone.AddSoftKeyItemOptions options)

addSoftKeyItemToImageFile

CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToImageFile(java.lang.String sessionId,
                                                            CiscoIpPhone.AddSoftKeyItemOptions options)

addSoftKeyItemToIconMenu

CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToIconMenu(java.lang.String sessionId,
                                                           CiscoIpPhone.AddSoftKeyItemOptions options)

addSoftKeyItemToIconFileMenu

CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToIconFileMenu(java.lang.String sessionId,
                                                               CiscoIpPhone.AddSoftKeyItemOptions options)

addSoftKeyItemToGraphicMenu

CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToGraphicMenu(java.lang.String sessionId,
                                                              CiscoIpPhone.AddSoftKeyItemOptions options)

addSoftKeyItemToGraphicFileMenu

CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToGraphicFileMenu(java.lang.String sessionId,
                                                                  CiscoIpPhone.AddSoftKeyItemOptions options)

createDirectory

CiscoIpPhone.CreateDirectoryResult createDirectory(java.lang.String sessionId,
                                                   CiscoIpPhone.CreateDirectoryOptions options)

Generated from CUAE Action CreateDirectory Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateDirectory initializes a Directory XML object, which one can later use to display a directory on a Cisco IP Phone in order to allow on to cause their phone to dial the number of a selected directory entry on the phone screen. Usage CreateDirectory allows the developer to establish the Title and Prompt of a Cisco IP Phone Directory XML object. These parameters are stored into the Directory XML type. This type can later be manipulated further by using the AddDirectoryEntry action to add directory entries and the AddSoftKeyItem action to add softkeys to the directory object. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createExecute

CiscoIpPhone.CreateExecuteResult createExecute(java.lang.String sessionId,
                                               CiscoIpPhone.CreateExecuteOptions options)

Generated from CUAE Action CreateExecute Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateExecute initializes a Execute XML object, so that one later push the XML execute command object to a Cisco IP Phone. Usage CreateExecute allows the developer to establish the URL and Priority parameters of a Cisco IP Phone Execute XML object. These parameters are stored into the Execute XML type. This type can later sent to the Cisco IP Phone by using the SendExecute action. 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.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createGraphicFileMenu

CiscoIpPhone.CreateGraphicFileMenuResult createGraphicFileMenu(java.lang.String sessionId,
                                                               CiscoIpPhone.CreateGraphicFileMenuOptions options)

Generated from CUAE Action CreateGraphicFileMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateGraphicFileMenu initializes a GraphicFileMenu XML object, which one can later use to display a PNG-based menu on a Cisco IP Phone. Usage CreateGraphicFileMenu allows the developer to establish the Title, Prompt, and image properties of a Cisco IP Phone GraphicFileMenu XML object. These parameters are stored into the GraphicFileMenu XML type. This type can later be manipulated further by using the AddMenuItem action to add menu items and the AddSoftKeyItem action to add softkeys to the menu object. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createGraphicMenu

CiscoIpPhone.CreateGraphicMenuResult createGraphicMenu(java.lang.String sessionId,
                                                       CiscoIpPhone.CreateGraphicMenuOptions options)

Generated from CUAE Action CreateGraphicMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateGraphicMenu initializes a GraphicMenu XML object, which one can later use to display a graphical menu on a Cisco IP Phone, in which the number keys on the Cisco IP phone can be used to trigger phone activity. Usage CreateGraphicMenu allows the developer to establish the Title, Prompt and image display properties of a Cisco IP Phone GraphicMenu XML object. These parameters are stored into the GraphicMenu XML type. This type can later be manipulated further by using the AddMenuItem action to add menu items and the AddSoftKeyItem action to add softkeys to the graphic menu 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. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createIconFileMenu

CiscoIpPhone.CreateIconFileMenuResult createIconFileMenu(java.lang.String sessionId,
                                                         CiscoIpPhone.CreateIconFileMenuOptions options)

Generated from CUAE Action CreateIconFileMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateIconFileMenu initializes a IconFileMenu XML object, which one can later use to display an icon menu on a Cisco IP Phone. Usage CreateIconFileMenu allows the developer to establish the Title and Prompt of a Cisco IP Phone IconFileMenu XML object. These parameters are stored into the IconFileMenu XML type. This type can later be manipulated further by using the AddMenuItem action to add menu items, AddIconItem action to add icon items, and the AddSoftKeyItem action to add softkeys to the menu object. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createIconMenu

CiscoIpPhone.CreateIconMenuResult createIconMenu(java.lang.String sessionId,
                                                 CiscoIpPhone.CreateIconMenuOptions options)

Generated from CUAE Action CreateIconMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateIconMenu initializes a IconMenu XML object, which one can later use to display an icon menu on a Cisco IP Phone. Usage CreateIconMenu allows the developer to establish the Title and Prompt of a Cisco IP Phone IconMenu XML object. These parameters are stored into the IconMenu XML type. This type can later be manipulated further by using the AddMenuItem action to add menu items, AddIconItem action to add icon items, and the AddSoftKeyItem action to add softkeys to the menu object. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createImage

CiscoIpPhone.CreateImageResult createImage(java.lang.String sessionId,
                                           CiscoIpPhone.CreateImageOptions options)

Generated from CUAE Action CreateImage Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateImage initializes a Image XML object, which one can later use to display an image on certain Cisco IP Phones. Usage 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. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createImageFile

CiscoIpPhone.CreateImageFileResult createImageFile(java.lang.String sessionId,
                                                   CiscoIpPhone.CreateImageFileOptions options)

Generated from CUAE Action CreateImageFile Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateImageFile initializes a ImageFile XML object, which one can later use to display a PNG-based image on certain Cisco IP Phones. Usage 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. Remarks 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.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createInput

CiscoIpPhone.CreateInputResult createInput(java.lang.String sessionId,
                                           CiscoIpPhone.CreateInputOptions options)

Generated from CUAE Action CreateInput Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateInput initializes a Input XML object, which one can later use to display an input form on a Cisco IP Phone in order to allow the user to input and submit data back to the script. Usage CreateInput allows the developer to establish the Title, Prompt, and base URL of the Cisco IP Phone Input XML object. These parameters are stored into the Input XML type. This type can later be manipulated further by using the AddInputItem action to add input items and the AddSoftKeyItem action to add softkeys to the input object. It is important to understand the interaction between the URL action parameter specified in CreateInput and the QueryStringParam action parameter in the AddInputItem action. The URL parameter defines the base URL. Each QueryStringParam of any input items are appended to the base URL as a query parameter, with the value of the text entered by the user defined as the value of the query parameter. For example, assume we specified a URL of http://appserver:8000/myscript and a QueryStringParam with a value of userid, and also assume the user enters the value bob on the phone. When the user hits the Submit softkey on the Cisco IP Phone, the phone will generate a request to the URI http://appserver:8000/myscript?userid=bob. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createMenu

CiscoIpPhone.CreateMenuResult createMenu(java.lang.String sessionId,
                                         CiscoIpPhone.CreateMenuOptions options)

Generated from CUAE Action CreateMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateMenu initializes a Menu XML object, which one can later use to display a menu on a Cisco IP Phone. Usage CreateMenu allows the developer to establish the Title and Prompt of a Cisco IP Phone Menu XML object. These parameters are stored into the Menu XML type. This type can later be manipulated further by using the AddMenuItem action to add menu items and the AddSoftKeyItem action to add softkeys to the menu object. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createStatus

CiscoIpPhone.CreateStatusResult createStatus(java.lang.String sessionId,
                                             CiscoIpPhone.CreateStatusOptions options)

Generated from CUAE Action CreateStatus Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateStatus initializes a Status 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 image in the middle of the Cisco IP phone that is always present in the call plane, and unremovable by the user. Usage CreateStatus allows the developer to establish the Timer, Text, and the image properties of a Cisco IP Phone Status XML object. These parameters are stored into the Status 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.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createStatusFile

CiscoIpPhone.CreateStatusFileResult createStatusFile(java.lang.String sessionId,
                                                     CiscoIpPhone.CreateStatusFileOptions options)

Generated from CUAE Action CreateStatusFile Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false 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.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

createText

CiscoIpPhone.CreateTextResult createText(java.lang.String sessionId,
                                         CiscoIpPhone.CreateTextOptions options)

Generated from CUAE Action CreateText Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary CreateText initializes a Text XML object, which one can later use to display text on a Cisco IP Phone. Usage CreateText allows the developer to establish the Title, Prompt, and Text of a Cisco IP Phone Text XML object. These parameters are stored into the Text XML type. This type can later be manipulated further by using the AddSoftKeyItem to add softkeys to the text object. 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 either SendResponse or SendExecute.

Parameters:

sessionId - The session Id for this method call

options - An object holding all the optional parameters

sendExecute

CiscoIpPhone.SendExecuteResult sendExecute(java.lang.String sessionId,
                                           java.lang.String message,
                                           java.lang.String uRL,
                                           CiscoIpPhone.SendExecuteOptions options)

Generated from CUAE Action SendExecute Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false Summary SendExecute sends an XML object directly to the Cisco IP Phone using an HTTP POST. Usage SendExecute can send two distinctly different commands to the Cisco IP Phone. One is the Execute XML object, which is used to cause the phone to execute internal commands, such as RTPRx or Dial, or to cause the phone to fetch IP Phone XML from an HTTP server. SendExecute can also used to send content-based XML objects, such as a Text or Menu XML object. The Cisco IP Phones have an important limitation in that one can only push 512 bytes of content to the phone. This effectively means that pushing a Execute XML object to a phone is the more robust way to have the phone render large amounts of data, because the phone can be pushed an HTTP-based URL which the phone will subsequently request XML from, circumventing the 512 byte 'push' limitation. There is no 512 byte limitation when the phone makes a request to a HTTP-based URL. The SendExecute requires an IP address to send the XML command to using an HTTP POST. However, it is a common problem to not have the IP address of a Cisco IP phone readily available, although often one has the device name (of the form SEPXXXXXXXXXXXX) of the phone. One can use the Cisco DeviceListX cache to determine IP address of a Cisco IP Phone based on this device name. Remarks This action communicates directly with the Cisco IP Phone using an HTTP post originating from the application server.

Parameters:

sessionId - The session Id for this method call

message - use: required; allowMultiple: false; The XML object to be sent to the Cisco IP Phone. The XML object can be one of the following types: Execute Text Menu Directory Image ImageFile Input IconMenu IconFileMenu GraphicMenu GraphicFileMenu Status Note that the variable should not be passed directly into this action parameter. Instead, use c# to invoke the ToString() method invoked on the XML object variable; for instance, myXmlVar.ToString(). Also, with any content-based XML object (all types aside from Execute), the 512 byte limit will limit the practical usage of dynamic content in these types when pushed with SendExecute. If you have a variable amount of content to show, then use Execute to pass an HTTP-based URL to the phone to have it fetch the content XML object instead, thereby circumventing the 512 byte limit.

uRL - use: required; allowMultiple: false; The IP address of the Cisco IP Phone.

options - An object holding all the optional parameters

constructDirectory

CiscoIpPhone.ConstructDirectoryResult constructDirectory(java.lang.String sessionId,
                                                         CiscoIpPhone.ConstructDirectoryOptions options)

constructExecute

CiscoIpPhone.ConstructExecuteResult constructExecute(java.lang.String sessionId,
                                                     CiscoIpPhone.ConstructExecuteOptions options)

constructGraphicFileMenu

CiscoIpPhone.ConstructGraphicFileMenuResult constructGraphicFileMenu(java.lang.String sessionId,
                                                                     CiscoIpPhone.ConstructGraphicFileMenuOptions options)

constructGraphicMenu

CiscoIpPhone.ConstructGraphicMenuResult constructGraphicMenu(java.lang.String sessionId,
                                                             CiscoIpPhone.ConstructGraphicMenuOptions options)

constructIconFileMenu

CiscoIpPhone.ConstructIconFileMenuResult constructIconFileMenu(java.lang.String sessionId,
                                                               CiscoIpPhone.ConstructIconFileMenuOptions options)

constructIconMenu

CiscoIpPhone.ConstructIconMenuResult constructIconMenu(java.lang.String sessionId,
                                                       CiscoIpPhone.ConstructIconMenuOptions options)

constructImage

CiscoIpPhone.ConstructImageResult constructImage(java.lang.String sessionId,
                                                 CiscoIpPhone.ConstructImageOptions options)

constructImageFile

CiscoIpPhone.ConstructImageFileResult constructImageFile(java.lang.String sessionId,
                                                         CiscoIpPhone.ConstructImageFileOptions options)

constructInput

CiscoIpPhone.ConstructInputResult constructInput(java.lang.String sessionId,
                                                 CiscoIpPhone.ConstructInputOptions options)

constructMenu

CiscoIpPhone.ConstructMenuResult constructMenu(java.lang.String sessionId,
                                               CiscoIpPhone.ConstructMenuOptions options)

constructStatus

CiscoIpPhone.ConstructStatusResult constructStatus(java.lang.String sessionId,
                                                   CiscoIpPhone.ConstructStatusOptions options)

constructStatusFile

CiscoIpPhone.ConstructStatusFileResult constructStatusFile(java.lang.String sessionId,
                                                           CiscoIpPhone.ConstructStatusFileOptions options)

constructText

CiscoIpPhone.ConstructTextResult constructText(java.lang.String sessionId,
                                               CiscoIpPhone.ConstructTextOptions options)