cisco.uc.cuae.legacy
Class RemoteCiscoIpPhoneServer._Async

java.lang.Object
  cisco.uc.cuae.legacy.RemoteCiscoIpPhone._Async
      cisco.uc.cuae.legacy.RemoteCiscoIpPhoneServer._Async

Enclosing class:

RemoteCiscoIpPhoneServer

public final class RemoteCiscoIpPhoneServer._Async
extends RemoteCiscoIpPhone._Async

Asynchronous implementation of service methods.

Constructor Summary

RemoteCiscoIpPhoneServer._Async()

Method Summary

etch.bindings.java.support.Mailbox	_begin_addDirectoryEntry(java.lang.String sessionId, CiscoIpPhone.AddDirectoryEntryOptions options) Begins a call to addDirectoryEntry.
etch.bindings.java.support.Mailbox	_begin_addIconItemToIconFileMenu(java.lang.String sessionId, CiscoIpPhone.AddIconItemOptions options) Begins a call to addIconItemToIconFileMenu.
etch.bindings.java.support.Mailbox	_begin_addIconItemToIconMenu(java.lang.String sessionId, CiscoIpPhone.AddIconItemOptions options) Begins a call to addIconItemToIconMenu.
etch.bindings.java.support.Mailbox	_begin_addInputItem(java.lang.String sessionId, CiscoIpPhone.AddInputItemOptions options) Begins a call to addInputItem.
etch.bindings.java.support.Mailbox	_begin_addMenuItemToGraphicFileMenu(java.lang.String sessionId, CiscoIpPhone.AddMenuItemOptions options) Begins a call to addMenuItemToGraphicFileMenu.
etch.bindings.java.support.Mailbox	_begin_addMenuItemToGraphicMenu(java.lang.String sessionId, CiscoIpPhone.AddMenuItemOptions options) Begins a call to addMenuItemToGraphicMenu.
etch.bindings.java.support.Mailbox	_begin_addMenuItemToIconFileMenu(java.lang.String sessionId, CiscoIpPhone.AddMenuItemOptions options) Begins a call to addMenuItemToIconFileMenu.
etch.bindings.java.support.Mailbox	_begin_addMenuItemToIconMenu(java.lang.String sessionId, CiscoIpPhone.AddMenuItemOptions options) Begins a call to addMenuItemToIconMenu.
etch.bindings.java.support.Mailbox	_begin_addMenuItemToMenu(java.lang.String sessionId, CiscoIpPhone.AddMenuItemOptions options) Begins a call to addMenuItemToMenu.
etch.bindings.java.support.Mailbox	_begin_addSoftKeyItemToDirectory(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Begins a call to addSoftKeyItemToDirectory.
etch.bindings.java.support.Mailbox	_begin_addSoftKeyItemToGraphicFileMenu(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Begins a call to addSoftKeyItemToGraphicFileMenu.
etch.bindings.java.support.Mailbox	_begin_addSoftKeyItemToGraphicMenu(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Begins a call to addSoftKeyItemToGraphicMenu.
etch.bindings.java.support.Mailbox	_begin_addSoftKeyItemToIconFileMenu(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Begins a call to addSoftKeyItemToIconFileMenu.
etch.bindings.java.support.Mailbox	_begin_addSoftKeyItemToIconMenu(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Begins a call to addSoftKeyItemToIconMenu.
etch.bindings.java.support.Mailbox	_begin_addSoftKeyItemToImage(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Begins a call to addSoftKeyItemToImage.
etch.bindings.java.support.Mailbox	_begin_addSoftKeyItemToImageFile(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Begins a call to addSoftKeyItemToImageFile.
etch.bindings.java.support.Mailbox	_begin_addSoftKeyItemToInput(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Begins a call to addSoftKeyItemToInput.
etch.bindings.java.support.Mailbox	_begin_addSoftKeyItemToMenu(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Begins a call to addSoftKeyItemToMenu.
etch.bindings.java.support.Mailbox	_begin_addSoftKeyItemToText(java.lang.String sessionId, CiscoIpPhone.AddSoftKeyItemOptions options) Begins a call to addSoftKeyItemToText.
etch.bindings.java.support.Mailbox	_begin_constructDirectory(java.lang.String sessionId, CiscoIpPhone.ConstructDirectoryOptions options) Begins a call to constructDirectory.
etch.bindings.java.support.Mailbox	_begin_constructExecute(java.lang.String sessionId, CiscoIpPhone.ConstructExecuteOptions options) Begins a call to constructExecute.
etch.bindings.java.support.Mailbox	_begin_constructGraphicFileMenu(java.lang.String sessionId, CiscoIpPhone.ConstructGraphicFileMenuOptions options) Begins a call to constructGraphicFileMenu.
etch.bindings.java.support.Mailbox	_begin_constructGraphicMenu(java.lang.String sessionId, CiscoIpPhone.ConstructGraphicMenuOptions options) Begins a call to constructGraphicMenu.
etch.bindings.java.support.Mailbox	_begin_constructIconFileMenu(java.lang.String sessionId, CiscoIpPhone.ConstructIconFileMenuOptions options) Begins a call to constructIconFileMenu.
etch.bindings.java.support.Mailbox	_begin_constructIconMenu(java.lang.String sessionId, CiscoIpPhone.ConstructIconMenuOptions options) Begins a call to constructIconMenu.
etch.bindings.java.support.Mailbox	_begin_constructImage(java.lang.String sessionId, CiscoIpPhone.ConstructImageOptions options) Begins a call to constructImage.
etch.bindings.java.support.Mailbox	_begin_constructImageFile(java.lang.String sessionId, CiscoIpPhone.ConstructImageFileOptions options) Begins a call to constructImageFile.
etch.bindings.java.support.Mailbox	_begin_constructInput(java.lang.String sessionId, CiscoIpPhone.ConstructInputOptions options) Begins a call to constructInput.
etch.bindings.java.support.Mailbox	_begin_constructMenu(java.lang.String sessionId, CiscoIpPhone.ConstructMenuOptions options) Begins a call to constructMenu.
etch.bindings.java.support.Mailbox	_begin_constructStatus(java.lang.String sessionId, CiscoIpPhone.ConstructStatusOptions options) Begins a call to constructStatus.
etch.bindings.java.support.Mailbox	_begin_constructStatusFile(java.lang.String sessionId, CiscoIpPhone.ConstructStatusFileOptions options) Begins a call to constructStatusFile.
etch.bindings.java.support.Mailbox	_begin_constructText(java.lang.String sessionId, CiscoIpPhone.ConstructTextOptions options) Begins a call to constructText.
etch.bindings.java.support.Mailbox	_begin_createDirectory(java.lang.String sessionId, CiscoIpPhone.CreateDirectoryOptions options) Begins a call to createDirectory.
etch.bindings.java.support.Mailbox	_begin_createExecute(java.lang.String sessionId, CiscoIpPhone.CreateExecuteOptions options) Begins a call to createExecute.
etch.bindings.java.support.Mailbox	_begin_createGraphicFileMenu(java.lang.String sessionId, CiscoIpPhone.CreateGraphicFileMenuOptions options) Begins a call to createGraphicFileMenu.
etch.bindings.java.support.Mailbox	_begin_createGraphicMenu(java.lang.String sessionId, CiscoIpPhone.CreateGraphicMenuOptions options) Begins a call to createGraphicMenu.
etch.bindings.java.support.Mailbox	_begin_createIconFileMenu(java.lang.String sessionId, CiscoIpPhone.CreateIconFileMenuOptions options) Begins a call to createIconFileMenu.
etch.bindings.java.support.Mailbox	_begin_createIconMenu(java.lang.String sessionId, CiscoIpPhone.CreateIconMenuOptions options) Begins a call to createIconMenu.
etch.bindings.java.support.Mailbox	_begin_createImage(java.lang.String sessionId, CiscoIpPhone.CreateImageOptions options) Begins a call to createImage.
etch.bindings.java.support.Mailbox	_begin_createImageFile(java.lang.String sessionId, CiscoIpPhone.CreateImageFileOptions options) Begins a call to createImageFile.
etch.bindings.java.support.Mailbox	_begin_createInput(java.lang.String sessionId, CiscoIpPhone.CreateInputOptions options) Begins a call to createInput.
etch.bindings.java.support.Mailbox	_begin_createMenu(java.lang.String sessionId, CiscoIpPhone.CreateMenuOptions options) Begins a call to createMenu.
etch.bindings.java.support.Mailbox	_begin_createStatus(java.lang.String sessionId, CiscoIpPhone.CreateStatusOptions options) Begins a call to createStatus.
etch.bindings.java.support.Mailbox	_begin_createStatusFile(java.lang.String sessionId, CiscoIpPhone.CreateStatusFileOptions options) Begins a call to createStatusFile.
etch.bindings.java.support.Mailbox	_begin_createText(java.lang.String sessionId, CiscoIpPhone.CreateTextOptions options) Begins a call to createText.
etch.bindings.java.support.Mailbox	_begin_sendExecute(java.lang.String sessionId, java.lang.String message, java.lang.String uRL, CiscoIpPhone.SendExecuteOptions options) Begins a call to sendExecute.
CiscoIpPhone.AddDirectoryEntryResult	_end_addDirectoryEntry(etch.bindings.java.support.Mailbox mb) Ends a call to addDirectoryEntry.
CiscoIpPhone.AddIconItemResult	_end_addIconItemToIconFileMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addIconItemToIconFileMenu.
CiscoIpPhone.AddIconItemResult	_end_addIconItemToIconMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addIconItemToIconMenu.
CiscoIpPhone.AddInputItemResult	_end_addInputItem(etch.bindings.java.support.Mailbox mb) Ends a call to addInputItem.
CiscoIpPhone.AddMenuItemResult	_end_addMenuItemToGraphicFileMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addMenuItemToGraphicFileMenu.
CiscoIpPhone.AddMenuItemResult	_end_addMenuItemToGraphicMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addMenuItemToGraphicMenu.
CiscoIpPhone.AddMenuItemResult	_end_addMenuItemToIconFileMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addMenuItemToIconFileMenu.
CiscoIpPhone.AddMenuItemResult	_end_addMenuItemToIconMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addMenuItemToIconMenu.
CiscoIpPhone.AddMenuItemResult	_end_addMenuItemToMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addMenuItemToMenu.
CiscoIpPhone.AddSoftKeyItemResult	_end_addSoftKeyItemToDirectory(etch.bindings.java.support.Mailbox mb) Ends a call to addSoftKeyItemToDirectory.
CiscoIpPhone.AddSoftKeyItemResult	_end_addSoftKeyItemToGraphicFileMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addSoftKeyItemToGraphicFileMenu.
CiscoIpPhone.AddSoftKeyItemResult	_end_addSoftKeyItemToGraphicMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addSoftKeyItemToGraphicMenu.
CiscoIpPhone.AddSoftKeyItemResult	_end_addSoftKeyItemToIconFileMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addSoftKeyItemToIconFileMenu.
CiscoIpPhone.AddSoftKeyItemResult	_end_addSoftKeyItemToIconMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addSoftKeyItemToIconMenu.
CiscoIpPhone.AddSoftKeyItemResult	_end_addSoftKeyItemToImage(etch.bindings.java.support.Mailbox mb) Ends a call to addSoftKeyItemToImage.
CiscoIpPhone.AddSoftKeyItemResult	_end_addSoftKeyItemToImageFile(etch.bindings.java.support.Mailbox mb) Ends a call to addSoftKeyItemToImageFile.
CiscoIpPhone.AddSoftKeyItemResult	_end_addSoftKeyItemToInput(etch.bindings.java.support.Mailbox mb) Ends a call to addSoftKeyItemToInput.
CiscoIpPhone.AddSoftKeyItemResult	_end_addSoftKeyItemToMenu(etch.bindings.java.support.Mailbox mb) Ends a call to addSoftKeyItemToMenu.
CiscoIpPhone.AddSoftKeyItemResult	_end_addSoftKeyItemToText(etch.bindings.java.support.Mailbox mb) Ends a call to addSoftKeyItemToText.
CiscoIpPhone.ConstructDirectoryResult	_end_constructDirectory(etch.bindings.java.support.Mailbox mb) Ends a call to constructDirectory.
CiscoIpPhone.ConstructExecuteResult	_end_constructExecute(etch.bindings.java.support.Mailbox mb) Ends a call to constructExecute.
CiscoIpPhone.ConstructGraphicFileMenuResult	_end_constructGraphicFileMenu(etch.bindings.java.support.Mailbox mb) Ends a call to constructGraphicFileMenu.
CiscoIpPhone.ConstructGraphicMenuResult	_end_constructGraphicMenu(etch.bindings.java.support.Mailbox mb) Ends a call to constructGraphicMenu.
CiscoIpPhone.ConstructIconFileMenuResult	_end_constructIconFileMenu(etch.bindings.java.support.Mailbox mb) Ends a call to constructIconFileMenu.
CiscoIpPhone.ConstructIconMenuResult	_end_constructIconMenu(etch.bindings.java.support.Mailbox mb) Ends a call to constructIconMenu.
CiscoIpPhone.ConstructImageResult	_end_constructImage(etch.bindings.java.support.Mailbox mb) Ends a call to constructImage.
CiscoIpPhone.ConstructImageFileResult	_end_constructImageFile(etch.bindings.java.support.Mailbox mb) Ends a call to constructImageFile.
CiscoIpPhone.ConstructInputResult	_end_constructInput(etch.bindings.java.support.Mailbox mb) Ends a call to constructInput.
CiscoIpPhone.ConstructMenuResult	_end_constructMenu(etch.bindings.java.support.Mailbox mb) Ends a call to constructMenu.
CiscoIpPhone.ConstructStatusResult	_end_constructStatus(etch.bindings.java.support.Mailbox mb) Ends a call to constructStatus.
CiscoIpPhone.ConstructStatusFileResult	_end_constructStatusFile(etch.bindings.java.support.Mailbox mb) Ends a call to constructStatusFile.
CiscoIpPhone.ConstructTextResult	_end_constructText(etch.bindings.java.support.Mailbox mb) Ends a call to constructText.
CiscoIpPhone.CreateDirectoryResult	_end_createDirectory(etch.bindings.java.support.Mailbox mb) Ends a call to createDirectory.
CiscoIpPhone.CreateExecuteResult	_end_createExecute(etch.bindings.java.support.Mailbox mb) Ends a call to createExecute.
CiscoIpPhone.CreateGraphicFileMenuResult	_end_createGraphicFileMenu(etch.bindings.java.support.Mailbox mb) Ends a call to createGraphicFileMenu.
CiscoIpPhone.CreateGraphicMenuResult	_end_createGraphicMenu(etch.bindings.java.support.Mailbox mb) Ends a call to createGraphicMenu.
CiscoIpPhone.CreateIconFileMenuResult	_end_createIconFileMenu(etch.bindings.java.support.Mailbox mb) Ends a call to createIconFileMenu.
CiscoIpPhone.CreateIconMenuResult	_end_createIconMenu(etch.bindings.java.support.Mailbox mb) Ends a call to createIconMenu.
CiscoIpPhone.CreateImageResult	_end_createImage(etch.bindings.java.support.Mailbox mb) Ends a call to createImage.
CiscoIpPhone.CreateImageFileResult	_end_createImageFile(etch.bindings.java.support.Mailbox mb) Ends a call to createImageFile.
CiscoIpPhone.CreateInputResult	_end_createInput(etch.bindings.java.support.Mailbox mb) Ends a call to createInput.
CiscoIpPhone.CreateMenuResult	_end_createMenu(etch.bindings.java.support.Mailbox mb) Ends a call to createMenu.
CiscoIpPhone.CreateStatusResult	_end_createStatus(etch.bindings.java.support.Mailbox mb) Ends a call to createStatus.
CiscoIpPhone.CreateStatusFileResult	_end_createStatusFile(etch.bindings.java.support.Mailbox mb) Ends a call to createStatusFile.
CiscoIpPhone.CreateTextResult	_end_createText(etch.bindings.java.support.Mailbox mb) Ends a call to createText.
CiscoIpPhone.SendExecuteResult	_end_sendExecute(etch.bindings.java.support.Mailbox mb) Ends a call to sendExecute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteCiscoIpPhoneServer._Async

public RemoteCiscoIpPhoneServer._Async()

Method Detail

_begin_addDirectoryEntry

public final etch.bindings.java.support.Mailbox _begin_addDirectoryEntry(java.lang.String sessionId,
                                                                         CiscoIpPhone.AddDirectoryEntryOptions options)

Begins a call to addDirectoryEntry. 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

Returns:

mailbox used to retrieve the result using _end_addDirectoryEntry.

See Also:

RemoteCiscoIpPhoneServer.addDirectoryEntry(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddDirectoryEntryOptions), _end_addDirectoryEntry(etch.bindings.java.support.Mailbox)

_end_addDirectoryEntry

public final CiscoIpPhone.AddDirectoryEntryResult _end_addDirectoryEntry(etch.bindings.java.support.Mailbox mb)

Ends a call to addDirectoryEntry. 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:

mb - mailbox returned by _begin_addDirectoryEntry.

See Also:

RemoteCiscoIpPhoneServer.addDirectoryEntry(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddDirectoryEntryOptions), _begin_addDirectoryEntry(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddDirectoryEntryOptions)

_begin_addIconItemToIconMenu

public final etch.bindings.java.support.Mailbox _begin_addIconItemToIconMenu(java.lang.String sessionId,
                                                                             CiscoIpPhone.AddIconItemOptions options)

Begins a call to addIconItemToIconMenu. 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

Returns:

mailbox used to retrieve the result using _end_addIconItemToIconMenu.

See Also:

RemoteCiscoIpPhoneServer.addIconItemToIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddIconItemOptions), _end_addIconItemToIconMenu(etch.bindings.java.support.Mailbox)

_end_addIconItemToIconMenu

public final CiscoIpPhone.AddIconItemResult _end_addIconItemToIconMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addIconItemToIconMenu. 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:

mb - mailbox returned by _begin_addIconItemToIconMenu.

See Also:

RemoteCiscoIpPhoneServer.addIconItemToIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddIconItemOptions), _begin_addIconItemToIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddIconItemOptions)

_begin_addIconItemToIconFileMenu

public final etch.bindings.java.support.Mailbox _begin_addIconItemToIconFileMenu(java.lang.String sessionId,
                                                                                 CiscoIpPhone.AddIconItemOptions options)

Begins a call to addIconItemToIconFileMenu.

Returns:

mailbox used to retrieve the result using _end_addIconItemToIconFileMenu.

See Also:

RemoteCiscoIpPhoneServer.addIconItemToIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddIconItemOptions), _end_addIconItemToIconFileMenu(etch.bindings.java.support.Mailbox)

_end_addIconItemToIconFileMenu

public final CiscoIpPhone.AddIconItemResult _end_addIconItemToIconFileMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addIconItemToIconFileMenu.

Parameters:

mb - mailbox returned by _begin_addIconItemToIconFileMenu.

See Also:

RemoteCiscoIpPhoneServer.addIconItemToIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddIconItemOptions), _begin_addIconItemToIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddIconItemOptions)

_begin_addInputItem

public final etch.bindings.java.support.Mailbox _begin_addInputItem(java.lang.String sessionId,
                                                                    CiscoIpPhone.AddInputItemOptions options)

Begins a call to addInputItem. 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

Returns:

mailbox used to retrieve the result using _end_addInputItem.

See Also:

RemoteCiscoIpPhoneServer.addInputItem(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddInputItemOptions), _end_addInputItem(etch.bindings.java.support.Mailbox)

_end_addInputItem

public final CiscoIpPhone.AddInputItemResult _end_addInputItem(etch.bindings.java.support.Mailbox mb)

Ends a call to addInputItem. 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:

mb - mailbox returned by _begin_addInputItem.

See Also:

RemoteCiscoIpPhoneServer.addInputItem(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddInputItemOptions), _begin_addInputItem(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddInputItemOptions)

_begin_addMenuItemToMenu

public final etch.bindings.java.support.Mailbox _begin_addMenuItemToMenu(java.lang.String sessionId,
                                                                         CiscoIpPhone.AddMenuItemOptions options)

Begins a call to addMenuItemToMenu. 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

Returns:

mailbox used to retrieve the result using _end_addMenuItemToMenu.

See Also:

RemoteCiscoIpPhoneServer.addMenuItemToMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions), _end_addMenuItemToMenu(etch.bindings.java.support.Mailbox)

_end_addMenuItemToMenu

public final CiscoIpPhone.AddMenuItemResult _end_addMenuItemToMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addMenuItemToMenu. 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:

mb - mailbox returned by _begin_addMenuItemToMenu.

See Also:

RemoteCiscoIpPhoneServer.addMenuItemToMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions), _begin_addMenuItemToMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions)

_begin_addMenuItemToIconMenu

public final etch.bindings.java.support.Mailbox _begin_addMenuItemToIconMenu(java.lang.String sessionId,
                                                                             CiscoIpPhone.AddMenuItemOptions options)

Begins a call to addMenuItemToIconMenu.

Returns:

mailbox used to retrieve the result using _end_addMenuItemToIconMenu.

See Also:

RemoteCiscoIpPhoneServer.addMenuItemToIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions), _end_addMenuItemToIconMenu(etch.bindings.java.support.Mailbox)

_end_addMenuItemToIconMenu

public final CiscoIpPhone.AddMenuItemResult _end_addMenuItemToIconMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addMenuItemToIconMenu.

Parameters:

mb - mailbox returned by _begin_addMenuItemToIconMenu.

See Also:

RemoteCiscoIpPhoneServer.addMenuItemToIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions), _begin_addMenuItemToIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions)

_begin_addMenuItemToIconFileMenu

public final etch.bindings.java.support.Mailbox _begin_addMenuItemToIconFileMenu(java.lang.String sessionId,
                                                                                 CiscoIpPhone.AddMenuItemOptions options)

Begins a call to addMenuItemToIconFileMenu.

Returns:

mailbox used to retrieve the result using _end_addMenuItemToIconFileMenu.

See Also:

RemoteCiscoIpPhoneServer.addMenuItemToIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions), _end_addMenuItemToIconFileMenu(etch.bindings.java.support.Mailbox)

_end_addMenuItemToIconFileMenu

public final CiscoIpPhone.AddMenuItemResult _end_addMenuItemToIconFileMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addMenuItemToIconFileMenu.

Parameters:

mb - mailbox returned by _begin_addMenuItemToIconFileMenu.

See Also:

RemoteCiscoIpPhoneServer.addMenuItemToIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions), _begin_addMenuItemToIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions)

_begin_addMenuItemToGraphicMenu

public final etch.bindings.java.support.Mailbox _begin_addMenuItemToGraphicMenu(java.lang.String sessionId,
                                                                                CiscoIpPhone.AddMenuItemOptions options)

Begins a call to addMenuItemToGraphicMenu.

Returns:

mailbox used to retrieve the result using _end_addMenuItemToGraphicMenu.

See Also:

RemoteCiscoIpPhoneServer.addMenuItemToGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions), _end_addMenuItemToGraphicMenu(etch.bindings.java.support.Mailbox)

_end_addMenuItemToGraphicMenu

public final CiscoIpPhone.AddMenuItemResult _end_addMenuItemToGraphicMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addMenuItemToGraphicMenu.

Parameters:

mb - mailbox returned by _begin_addMenuItemToGraphicMenu.

See Also:

RemoteCiscoIpPhoneServer.addMenuItemToGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions), _begin_addMenuItemToGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions)

_begin_addMenuItemToGraphicFileMenu

public final etch.bindings.java.support.Mailbox _begin_addMenuItemToGraphicFileMenu(java.lang.String sessionId,
                                                                                    CiscoIpPhone.AddMenuItemOptions options)

Begins a call to addMenuItemToGraphicFileMenu.

Returns:

mailbox used to retrieve the result using _end_addMenuItemToGraphicFileMenu.

See Also:

RemoteCiscoIpPhoneServer.addMenuItemToGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions), _end_addMenuItemToGraphicFileMenu(etch.bindings.java.support.Mailbox)

_end_addMenuItemToGraphicFileMenu

public final CiscoIpPhone.AddMenuItemResult _end_addMenuItemToGraphicFileMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addMenuItemToGraphicFileMenu.

Parameters:

mb - mailbox returned by _begin_addMenuItemToGraphicFileMenu.

See Also:

RemoteCiscoIpPhoneServer.addMenuItemToGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions), _begin_addMenuItemToGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddMenuItemOptions)

_begin_addSoftKeyItemToText

public final etch.bindings.java.support.Mailbox _begin_addSoftKeyItemToText(java.lang.String sessionId,
                                                                            CiscoIpPhone.AddSoftKeyItemOptions options)

Begins a call to addSoftKeyItemToText. 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

Returns:

mailbox used to retrieve the result using _end_addSoftKeyItemToText.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToText(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _end_addSoftKeyItemToText(etch.bindings.java.support.Mailbox)

_end_addSoftKeyItemToText

public final CiscoIpPhone.AddSoftKeyItemResult _end_addSoftKeyItemToText(etch.bindings.java.support.Mailbox mb)

Ends a call to addSoftKeyItemToText. 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:

mb - mailbox returned by _begin_addSoftKeyItemToText.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToText(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _begin_addSoftKeyItemToText(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions)

_begin_addSoftKeyItemToMenu

public final etch.bindings.java.support.Mailbox _begin_addSoftKeyItemToMenu(java.lang.String sessionId,
                                                                            CiscoIpPhone.AddSoftKeyItemOptions options)

Begins a call to addSoftKeyItemToMenu.

Returns:

mailbox used to retrieve the result using _end_addSoftKeyItemToMenu.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _end_addSoftKeyItemToMenu(etch.bindings.java.support.Mailbox)

_end_addSoftKeyItemToMenu

public final CiscoIpPhone.AddSoftKeyItemResult _end_addSoftKeyItemToMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addSoftKeyItemToMenu.

Parameters:

mb - mailbox returned by _begin_addSoftKeyItemToMenu.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _begin_addSoftKeyItemToMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions)

_begin_addSoftKeyItemToDirectory

public final etch.bindings.java.support.Mailbox _begin_addSoftKeyItemToDirectory(java.lang.String sessionId,
                                                                                 CiscoIpPhone.AddSoftKeyItemOptions options)

Begins a call to addSoftKeyItemToDirectory.

Returns:

mailbox used to retrieve the result using _end_addSoftKeyItemToDirectory.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToDirectory(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _end_addSoftKeyItemToDirectory(etch.bindings.java.support.Mailbox)

_end_addSoftKeyItemToDirectory

public final CiscoIpPhone.AddSoftKeyItemResult _end_addSoftKeyItemToDirectory(etch.bindings.java.support.Mailbox mb)

Ends a call to addSoftKeyItemToDirectory.

Parameters:

mb - mailbox returned by _begin_addSoftKeyItemToDirectory.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToDirectory(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _begin_addSoftKeyItemToDirectory(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions)

_begin_addSoftKeyItemToImage

public final etch.bindings.java.support.Mailbox _begin_addSoftKeyItemToImage(java.lang.String sessionId,
                                                                             CiscoIpPhone.AddSoftKeyItemOptions options)

Begins a call to addSoftKeyItemToImage.

Returns:

mailbox used to retrieve the result using _end_addSoftKeyItemToImage.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToImage(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _end_addSoftKeyItemToImage(etch.bindings.java.support.Mailbox)

_end_addSoftKeyItemToImage

public final CiscoIpPhone.AddSoftKeyItemResult _end_addSoftKeyItemToImage(etch.bindings.java.support.Mailbox mb)

Ends a call to addSoftKeyItemToImage.

Parameters:

mb - mailbox returned by _begin_addSoftKeyItemToImage.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToImage(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _begin_addSoftKeyItemToImage(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions)

_begin_addSoftKeyItemToInput

public final etch.bindings.java.support.Mailbox _begin_addSoftKeyItemToInput(java.lang.String sessionId,
                                                                             CiscoIpPhone.AddSoftKeyItemOptions options)

Begins a call to addSoftKeyItemToInput.

Returns:

mailbox used to retrieve the result using _end_addSoftKeyItemToInput.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToInput(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _end_addSoftKeyItemToInput(etch.bindings.java.support.Mailbox)

_end_addSoftKeyItemToInput

public final CiscoIpPhone.AddSoftKeyItemResult _end_addSoftKeyItemToInput(etch.bindings.java.support.Mailbox mb)

Ends a call to addSoftKeyItemToInput.

Parameters:

mb - mailbox returned by _begin_addSoftKeyItemToInput.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToInput(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _begin_addSoftKeyItemToInput(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions)

_begin_addSoftKeyItemToImageFile

public final etch.bindings.java.support.Mailbox _begin_addSoftKeyItemToImageFile(java.lang.String sessionId,
                                                                                 CiscoIpPhone.AddSoftKeyItemOptions options)

Begins a call to addSoftKeyItemToImageFile.

Returns:

mailbox used to retrieve the result using _end_addSoftKeyItemToImageFile.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToImageFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _end_addSoftKeyItemToImageFile(etch.bindings.java.support.Mailbox)

_end_addSoftKeyItemToImageFile

public final CiscoIpPhone.AddSoftKeyItemResult _end_addSoftKeyItemToImageFile(etch.bindings.java.support.Mailbox mb)

Ends a call to addSoftKeyItemToImageFile.

Parameters:

mb - mailbox returned by _begin_addSoftKeyItemToImageFile.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToImageFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _begin_addSoftKeyItemToImageFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions)

_begin_addSoftKeyItemToIconMenu

public final etch.bindings.java.support.Mailbox _begin_addSoftKeyItemToIconMenu(java.lang.String sessionId,
                                                                                CiscoIpPhone.AddSoftKeyItemOptions options)

Begins a call to addSoftKeyItemToIconMenu.

Returns:

mailbox used to retrieve the result using _end_addSoftKeyItemToIconMenu.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _end_addSoftKeyItemToIconMenu(etch.bindings.java.support.Mailbox)

_end_addSoftKeyItemToIconMenu

public final CiscoIpPhone.AddSoftKeyItemResult _end_addSoftKeyItemToIconMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addSoftKeyItemToIconMenu.

Parameters:

mb - mailbox returned by _begin_addSoftKeyItemToIconMenu.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _begin_addSoftKeyItemToIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions)

_begin_addSoftKeyItemToIconFileMenu

public final etch.bindings.java.support.Mailbox _begin_addSoftKeyItemToIconFileMenu(java.lang.String sessionId,
                                                                                    CiscoIpPhone.AddSoftKeyItemOptions options)

Begins a call to addSoftKeyItemToIconFileMenu.

Returns:

mailbox used to retrieve the result using _end_addSoftKeyItemToIconFileMenu.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _end_addSoftKeyItemToIconFileMenu(etch.bindings.java.support.Mailbox)

_end_addSoftKeyItemToIconFileMenu

public final CiscoIpPhone.AddSoftKeyItemResult _end_addSoftKeyItemToIconFileMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addSoftKeyItemToIconFileMenu.

Parameters:

mb - mailbox returned by _begin_addSoftKeyItemToIconFileMenu.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _begin_addSoftKeyItemToIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions)

_begin_addSoftKeyItemToGraphicMenu

public final etch.bindings.java.support.Mailbox _begin_addSoftKeyItemToGraphicMenu(java.lang.String sessionId,
                                                                                   CiscoIpPhone.AddSoftKeyItemOptions options)

Begins a call to addSoftKeyItemToGraphicMenu.

Returns:

mailbox used to retrieve the result using _end_addSoftKeyItemToGraphicMenu.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _end_addSoftKeyItemToGraphicMenu(etch.bindings.java.support.Mailbox)

_end_addSoftKeyItemToGraphicMenu

public final CiscoIpPhone.AddSoftKeyItemResult _end_addSoftKeyItemToGraphicMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addSoftKeyItemToGraphicMenu.

Parameters:

mb - mailbox returned by _begin_addSoftKeyItemToGraphicMenu.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _begin_addSoftKeyItemToGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions)

_begin_addSoftKeyItemToGraphicFileMenu

public final etch.bindings.java.support.Mailbox _begin_addSoftKeyItemToGraphicFileMenu(java.lang.String sessionId,
                                                                                       CiscoIpPhone.AddSoftKeyItemOptions options)

Begins a call to addSoftKeyItemToGraphicFileMenu.

Returns:

mailbox used to retrieve the result using _end_addSoftKeyItemToGraphicFileMenu.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _end_addSoftKeyItemToGraphicFileMenu(etch.bindings.java.support.Mailbox)

_end_addSoftKeyItemToGraphicFileMenu

public final CiscoIpPhone.AddSoftKeyItemResult _end_addSoftKeyItemToGraphicFileMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to addSoftKeyItemToGraphicFileMenu.

Parameters:

mb - mailbox returned by _begin_addSoftKeyItemToGraphicFileMenu.

See Also:

RemoteCiscoIpPhoneServer.addSoftKeyItemToGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions), _begin_addSoftKeyItemToGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.AddSoftKeyItemOptions)

_begin_createDirectory

public final etch.bindings.java.support.Mailbox _begin_createDirectory(java.lang.String sessionId,
                                                                       CiscoIpPhone.CreateDirectoryOptions options)

Begins a call to createDirectory. 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

Returns:

mailbox used to retrieve the result using _end_createDirectory.

See Also:

RemoteCiscoIpPhoneServer.createDirectory(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateDirectoryOptions), _end_createDirectory(etch.bindings.java.support.Mailbox)

_end_createDirectory

public final CiscoIpPhone.CreateDirectoryResult _end_createDirectory(etch.bindings.java.support.Mailbox mb)

Ends a call to createDirectory. 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:

mb - mailbox returned by _begin_createDirectory.

See Also:

RemoteCiscoIpPhoneServer.createDirectory(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateDirectoryOptions), _begin_createDirectory(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateDirectoryOptions)

_begin_createExecute

public final etch.bindings.java.support.Mailbox _begin_createExecute(java.lang.String sessionId,
                                                                     CiscoIpPhone.CreateExecuteOptions options)

Begins a call to createExecute. 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

Returns:

mailbox used to retrieve the result using _end_createExecute.

See Also:

RemoteCiscoIpPhoneServer.createExecute(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateExecuteOptions), _end_createExecute(etch.bindings.java.support.Mailbox)

_end_createExecute

public final CiscoIpPhone.CreateExecuteResult _end_createExecute(etch.bindings.java.support.Mailbox mb)

Ends a call to createExecute. 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:

mb - mailbox returned by _begin_createExecute.

See Also:

RemoteCiscoIpPhoneServer.createExecute(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateExecuteOptions), _begin_createExecute(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateExecuteOptions)

_begin_createGraphicFileMenu

public final etch.bindings.java.support.Mailbox _begin_createGraphicFileMenu(java.lang.String sessionId,
                                                                             CiscoIpPhone.CreateGraphicFileMenuOptions options)

Begins a call to createGraphicFileMenu. 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

Returns:

mailbox used to retrieve the result using _end_createGraphicFileMenu.

See Also:

RemoteCiscoIpPhoneServer.createGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateGraphicFileMenuOptions), _end_createGraphicFileMenu(etch.bindings.java.support.Mailbox)

_end_createGraphicFileMenu

public final CiscoIpPhone.CreateGraphicFileMenuResult _end_createGraphicFileMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to createGraphicFileMenu. 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:

mb - mailbox returned by _begin_createGraphicFileMenu.

See Also:

RemoteCiscoIpPhoneServer.createGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateGraphicFileMenuOptions), _begin_createGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateGraphicFileMenuOptions)

_begin_createGraphicMenu

public final etch.bindings.java.support.Mailbox _begin_createGraphicMenu(java.lang.String sessionId,
                                                                         CiscoIpPhone.CreateGraphicMenuOptions options)

Begins a call to createGraphicMenu. 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

Returns:

mailbox used to retrieve the result using _end_createGraphicMenu.

See Also:

RemoteCiscoIpPhoneServer.createGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateGraphicMenuOptions), _end_createGraphicMenu(etch.bindings.java.support.Mailbox)

_end_createGraphicMenu

public final CiscoIpPhone.CreateGraphicMenuResult _end_createGraphicMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to createGraphicMenu. 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:

mb - mailbox returned by _begin_createGraphicMenu.

See Also:

RemoteCiscoIpPhoneServer.createGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateGraphicMenuOptions), _begin_createGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateGraphicMenuOptions)

_begin_createIconFileMenu

public final etch.bindings.java.support.Mailbox _begin_createIconFileMenu(java.lang.String sessionId,
                                                                          CiscoIpPhone.CreateIconFileMenuOptions options)

Begins a call to createIconFileMenu. 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

Returns:

mailbox used to retrieve the result using _end_createIconFileMenu.

See Also:

RemoteCiscoIpPhoneServer.createIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateIconFileMenuOptions), _end_createIconFileMenu(etch.bindings.java.support.Mailbox)

_end_createIconFileMenu

public final CiscoIpPhone.CreateIconFileMenuResult _end_createIconFileMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to createIconFileMenu. 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:

mb - mailbox returned by _begin_createIconFileMenu.

See Also:

RemoteCiscoIpPhoneServer.createIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateIconFileMenuOptions), _begin_createIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateIconFileMenuOptions)

_begin_createIconMenu

public final etch.bindings.java.support.Mailbox _begin_createIconMenu(java.lang.String sessionId,
                                                                      CiscoIpPhone.CreateIconMenuOptions options)

Begins a call to createIconMenu. 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

Returns:

mailbox used to retrieve the result using _end_createIconMenu.

See Also:

RemoteCiscoIpPhoneServer.createIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateIconMenuOptions), _end_createIconMenu(etch.bindings.java.support.Mailbox)

_end_createIconMenu

public final CiscoIpPhone.CreateIconMenuResult _end_createIconMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to createIconMenu. 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:

mb - mailbox returned by _begin_createIconMenu.

See Also:

RemoteCiscoIpPhoneServer.createIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateIconMenuOptions), _begin_createIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateIconMenuOptions)

_begin_createImage

public final etch.bindings.java.support.Mailbox _begin_createImage(java.lang.String sessionId,
                                                                   CiscoIpPhone.CreateImageOptions options)

Begins a call to createImage. 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

Returns:

mailbox used to retrieve the result using _end_createImage.

See Also:

RemoteCiscoIpPhoneServer.createImage(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateImageOptions), _end_createImage(etch.bindings.java.support.Mailbox)

_end_createImage

public final CiscoIpPhone.CreateImageResult _end_createImage(etch.bindings.java.support.Mailbox mb)

Ends a call to createImage. 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:

mb - mailbox returned by _begin_createImage.

See Also:

RemoteCiscoIpPhoneServer.createImage(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateImageOptions), _begin_createImage(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateImageOptions)

_begin_createImageFile

public final etch.bindings.java.support.Mailbox _begin_createImageFile(java.lang.String sessionId,
                                                                       CiscoIpPhone.CreateImageFileOptions options)

Begins a call to createImageFile. 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

Returns:

mailbox used to retrieve the result using _end_createImageFile.

See Also:

RemoteCiscoIpPhoneServer.createImageFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateImageFileOptions), _end_createImageFile(etch.bindings.java.support.Mailbox)

_end_createImageFile

public final CiscoIpPhone.CreateImageFileResult _end_createImageFile(etch.bindings.java.support.Mailbox mb)

Ends a call to createImageFile. 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:

mb - mailbox returned by _begin_createImageFile.

See Also:

RemoteCiscoIpPhoneServer.createImageFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateImageFileOptions), _begin_createImageFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateImageFileOptions)

_begin_createInput

public final etch.bindings.java.support.Mailbox _begin_createInput(java.lang.String sessionId,
                                                                   CiscoIpPhone.CreateInputOptions options)

Begins a call to createInput. 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

Returns:

mailbox used to retrieve the result using _end_createInput.

See Also:

RemoteCiscoIpPhoneServer.createInput(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateInputOptions), _end_createInput(etch.bindings.java.support.Mailbox)

_end_createInput

public final CiscoIpPhone.CreateInputResult _end_createInput(etch.bindings.java.support.Mailbox mb)

Ends a call to createInput. 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:

mb - mailbox returned by _begin_createInput.

See Also:

RemoteCiscoIpPhoneServer.createInput(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateInputOptions), _begin_createInput(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateInputOptions)

_begin_createMenu

public final etch.bindings.java.support.Mailbox _begin_createMenu(java.lang.String sessionId,
                                                                  CiscoIpPhone.CreateMenuOptions options)

Begins a call to createMenu. 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

Returns:

mailbox used to retrieve the result using _end_createMenu.

See Also:

RemoteCiscoIpPhoneServer.createMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateMenuOptions), _end_createMenu(etch.bindings.java.support.Mailbox)

_end_createMenu

public final CiscoIpPhone.CreateMenuResult _end_createMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to createMenu. 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:

mb - mailbox returned by _begin_createMenu.

See Also:

RemoteCiscoIpPhoneServer.createMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateMenuOptions), _begin_createMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateMenuOptions)

_begin_createStatus

public final etch.bindings.java.support.Mailbox _begin_createStatus(java.lang.String sessionId,
                                                                    CiscoIpPhone.CreateStatusOptions options)

Begins a call to createStatus. 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

Returns:

mailbox used to retrieve the result using _end_createStatus.

See Also:

RemoteCiscoIpPhoneServer.createStatus(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateStatusOptions), _end_createStatus(etch.bindings.java.support.Mailbox)

_end_createStatus

public final CiscoIpPhone.CreateStatusResult _end_createStatus(etch.bindings.java.support.Mailbox mb)

Ends a call to createStatus. 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:

mb - mailbox returned by _begin_createStatus.

See Also:

RemoteCiscoIpPhoneServer.createStatus(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateStatusOptions), _begin_createStatus(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateStatusOptions)

_begin_createStatusFile

public final etch.bindings.java.support.Mailbox _begin_createStatusFile(java.lang.String sessionId,
                                                                        CiscoIpPhone.CreateStatusFileOptions options)

Begins a call to createStatusFile. 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

Returns:

mailbox used to retrieve the result using _end_createStatusFile.

See Also:

RemoteCiscoIpPhoneServer.createStatusFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateStatusFileOptions), _end_createStatusFile(etch.bindings.java.support.Mailbox)

_end_createStatusFile

public final CiscoIpPhone.CreateStatusFileResult _end_createStatusFile(etch.bindings.java.support.Mailbox mb)

Ends a call to createStatusFile. 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:

mb - mailbox returned by _begin_createStatusFile.

See Also:

RemoteCiscoIpPhoneServer.createStatusFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateStatusFileOptions), _begin_createStatusFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateStatusFileOptions)

_begin_createText

public final etch.bindings.java.support.Mailbox _begin_createText(java.lang.String sessionId,
                                                                  CiscoIpPhone.CreateTextOptions options)

Begins a call to createText. 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

Returns:

mailbox used to retrieve the result using _end_createText.

See Also:

RemoteCiscoIpPhoneServer.createText(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateTextOptions), _end_createText(etch.bindings.java.support.Mailbox)

_end_createText

public final CiscoIpPhone.CreateTextResult _end_createText(etch.bindings.java.support.Mailbox mb)

Ends a call to createText. 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:

mb - mailbox returned by _begin_createText.

See Also:

RemoteCiscoIpPhoneServer.createText(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateTextOptions), _begin_createText(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.CreateTextOptions)

_begin_sendExecute

public final etch.bindings.java.support.Mailbox _begin_sendExecute(java.lang.String sessionId,
                                                                   java.lang.String message,
                                                                   java.lang.String uRL,
                                                                   CiscoIpPhone.SendExecuteOptions options)

Begins a call to sendExecute. 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

Returns:

mailbox used to retrieve the result using _end_sendExecute.

See Also:

RemoteCiscoIpPhoneServer.sendExecute(java.lang.String, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.SendExecuteOptions), _end_sendExecute(etch.bindings.java.support.Mailbox)

_end_sendExecute

public final CiscoIpPhone.SendExecuteResult _end_sendExecute(etch.bindings.java.support.Mailbox mb)

Ends a call to sendExecute. 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:

mb - mailbox returned by _begin_sendExecute.

See Also:

RemoteCiscoIpPhoneServer.sendExecute(java.lang.String, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.SendExecuteOptions), _begin_sendExecute(java.lang.String, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.SendExecuteOptions)

_begin_constructDirectory

public final etch.bindings.java.support.Mailbox _begin_constructDirectory(java.lang.String sessionId,
                                                                          CiscoIpPhone.ConstructDirectoryOptions options)

Begins a call to constructDirectory.

Returns:

mailbox used to retrieve the result using _end_constructDirectory.

See Also:

RemoteCiscoIpPhoneServer.constructDirectory(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructDirectoryOptions), _end_constructDirectory(etch.bindings.java.support.Mailbox)

_end_constructDirectory

public final CiscoIpPhone.ConstructDirectoryResult _end_constructDirectory(etch.bindings.java.support.Mailbox mb)

Ends a call to constructDirectory.

Parameters:

mb - mailbox returned by _begin_constructDirectory.

See Also:

RemoteCiscoIpPhoneServer.constructDirectory(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructDirectoryOptions), _begin_constructDirectory(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructDirectoryOptions)

_begin_constructExecute

public final etch.bindings.java.support.Mailbox _begin_constructExecute(java.lang.String sessionId,
                                                                        CiscoIpPhone.ConstructExecuteOptions options)

Begins a call to constructExecute.

Returns:

mailbox used to retrieve the result using _end_constructExecute.

See Also:

RemoteCiscoIpPhoneServer.constructExecute(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructExecuteOptions), _end_constructExecute(etch.bindings.java.support.Mailbox)

_end_constructExecute

public final CiscoIpPhone.ConstructExecuteResult _end_constructExecute(etch.bindings.java.support.Mailbox mb)

Ends a call to constructExecute.

Parameters:

mb - mailbox returned by _begin_constructExecute.

See Also:

RemoteCiscoIpPhoneServer.constructExecute(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructExecuteOptions), _begin_constructExecute(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructExecuteOptions)

_begin_constructGraphicFileMenu

public final etch.bindings.java.support.Mailbox _begin_constructGraphicFileMenu(java.lang.String sessionId,
                                                                                CiscoIpPhone.ConstructGraphicFileMenuOptions options)

Begins a call to constructGraphicFileMenu.

Returns:

mailbox used to retrieve the result using _end_constructGraphicFileMenu.

See Also:

RemoteCiscoIpPhoneServer.constructGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructGraphicFileMenuOptions), _end_constructGraphicFileMenu(etch.bindings.java.support.Mailbox)

_end_constructGraphicFileMenu

public final CiscoIpPhone.ConstructGraphicFileMenuResult _end_constructGraphicFileMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to constructGraphicFileMenu.

Parameters:

mb - mailbox returned by _begin_constructGraphicFileMenu.

See Also:

RemoteCiscoIpPhoneServer.constructGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructGraphicFileMenuOptions), _begin_constructGraphicFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructGraphicFileMenuOptions)

_begin_constructGraphicMenu

public final etch.bindings.java.support.Mailbox _begin_constructGraphicMenu(java.lang.String sessionId,
                                                                            CiscoIpPhone.ConstructGraphicMenuOptions options)

Begins a call to constructGraphicMenu.

Returns:

mailbox used to retrieve the result using _end_constructGraphicMenu.

See Also:

RemoteCiscoIpPhoneServer.constructGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructGraphicMenuOptions), _end_constructGraphicMenu(etch.bindings.java.support.Mailbox)

_end_constructGraphicMenu

public final CiscoIpPhone.ConstructGraphicMenuResult _end_constructGraphicMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to constructGraphicMenu.

Parameters:

mb - mailbox returned by _begin_constructGraphicMenu.

See Also:

RemoteCiscoIpPhoneServer.constructGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructGraphicMenuOptions), _begin_constructGraphicMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructGraphicMenuOptions)

_begin_constructIconFileMenu

public final etch.bindings.java.support.Mailbox _begin_constructIconFileMenu(java.lang.String sessionId,
                                                                             CiscoIpPhone.ConstructIconFileMenuOptions options)

Begins a call to constructIconFileMenu.

Returns:

mailbox used to retrieve the result using _end_constructIconFileMenu.

See Also:

RemoteCiscoIpPhoneServer.constructIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructIconFileMenuOptions), _end_constructIconFileMenu(etch.bindings.java.support.Mailbox)

_end_constructIconFileMenu

public final CiscoIpPhone.ConstructIconFileMenuResult _end_constructIconFileMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to constructIconFileMenu.

Parameters:

mb - mailbox returned by _begin_constructIconFileMenu.

See Also:

RemoteCiscoIpPhoneServer.constructIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructIconFileMenuOptions), _begin_constructIconFileMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructIconFileMenuOptions)

_begin_constructIconMenu

public final etch.bindings.java.support.Mailbox _begin_constructIconMenu(java.lang.String sessionId,
                                                                         CiscoIpPhone.ConstructIconMenuOptions options)

Begins a call to constructIconMenu.

Returns:

mailbox used to retrieve the result using _end_constructIconMenu.

See Also:

RemoteCiscoIpPhoneServer.constructIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructIconMenuOptions), _end_constructIconMenu(etch.bindings.java.support.Mailbox)

_end_constructIconMenu

public final CiscoIpPhone.ConstructIconMenuResult _end_constructIconMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to constructIconMenu.

Parameters:

mb - mailbox returned by _begin_constructIconMenu.

See Also:

RemoteCiscoIpPhoneServer.constructIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructIconMenuOptions), _begin_constructIconMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructIconMenuOptions)

_begin_constructImage

public final etch.bindings.java.support.Mailbox _begin_constructImage(java.lang.String sessionId,
                                                                      CiscoIpPhone.ConstructImageOptions options)

Begins a call to constructImage.

Returns:

mailbox used to retrieve the result using _end_constructImage.

See Also:

RemoteCiscoIpPhoneServer.constructImage(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructImageOptions), _end_constructImage(etch.bindings.java.support.Mailbox)

_end_constructImage

public final CiscoIpPhone.ConstructImageResult _end_constructImage(etch.bindings.java.support.Mailbox mb)

Ends a call to constructImage.

Parameters:

mb - mailbox returned by _begin_constructImage.

See Also:

RemoteCiscoIpPhoneServer.constructImage(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructImageOptions), _begin_constructImage(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructImageOptions)

_begin_constructImageFile

public final etch.bindings.java.support.Mailbox _begin_constructImageFile(java.lang.String sessionId,
                                                                          CiscoIpPhone.ConstructImageFileOptions options)

Begins a call to constructImageFile.

Returns:

mailbox used to retrieve the result using _end_constructImageFile.

See Also:

RemoteCiscoIpPhoneServer.constructImageFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructImageFileOptions), _end_constructImageFile(etch.bindings.java.support.Mailbox)

_end_constructImageFile

public final CiscoIpPhone.ConstructImageFileResult _end_constructImageFile(etch.bindings.java.support.Mailbox mb)

Ends a call to constructImageFile.

Parameters:

mb - mailbox returned by _begin_constructImageFile.

See Also:

RemoteCiscoIpPhoneServer.constructImageFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructImageFileOptions), _begin_constructImageFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructImageFileOptions)

_begin_constructInput

public final etch.bindings.java.support.Mailbox _begin_constructInput(java.lang.String sessionId,
                                                                      CiscoIpPhone.ConstructInputOptions options)

Begins a call to constructInput.

Returns:

mailbox used to retrieve the result using _end_constructInput.

See Also:

RemoteCiscoIpPhoneServer.constructInput(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructInputOptions), _end_constructInput(etch.bindings.java.support.Mailbox)

_end_constructInput

public final CiscoIpPhone.ConstructInputResult _end_constructInput(etch.bindings.java.support.Mailbox mb)

Ends a call to constructInput.

Parameters:

mb - mailbox returned by _begin_constructInput.

See Also:

RemoteCiscoIpPhoneServer.constructInput(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructInputOptions), _begin_constructInput(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructInputOptions)

_begin_constructMenu

public final etch.bindings.java.support.Mailbox _begin_constructMenu(java.lang.String sessionId,
                                                                     CiscoIpPhone.ConstructMenuOptions options)

Begins a call to constructMenu.

Returns:

mailbox used to retrieve the result using _end_constructMenu.

See Also:

RemoteCiscoIpPhoneServer.constructMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructMenuOptions), _end_constructMenu(etch.bindings.java.support.Mailbox)

_end_constructMenu

public final CiscoIpPhone.ConstructMenuResult _end_constructMenu(etch.bindings.java.support.Mailbox mb)

Ends a call to constructMenu.

Parameters:

mb - mailbox returned by _begin_constructMenu.

See Also:

RemoteCiscoIpPhoneServer.constructMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructMenuOptions), _begin_constructMenu(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructMenuOptions)

_begin_constructStatus

public final etch.bindings.java.support.Mailbox _begin_constructStatus(java.lang.String sessionId,
                                                                       CiscoIpPhone.ConstructStatusOptions options)

Begins a call to constructStatus.

Returns:

mailbox used to retrieve the result using _end_constructStatus.

See Also:

RemoteCiscoIpPhoneServer.constructStatus(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructStatusOptions), _end_constructStatus(etch.bindings.java.support.Mailbox)

_end_constructStatus

public final CiscoIpPhone.ConstructStatusResult _end_constructStatus(etch.bindings.java.support.Mailbox mb)

Ends a call to constructStatus.

Parameters:

mb - mailbox returned by _begin_constructStatus.

See Also:

RemoteCiscoIpPhoneServer.constructStatus(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructStatusOptions), _begin_constructStatus(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructStatusOptions)

_begin_constructStatusFile

public final etch.bindings.java.support.Mailbox _begin_constructStatusFile(java.lang.String sessionId,
                                                                           CiscoIpPhone.ConstructStatusFileOptions options)

Begins a call to constructStatusFile.

Returns:

mailbox used to retrieve the result using _end_constructStatusFile.

See Also:

RemoteCiscoIpPhoneServer.constructStatusFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructStatusFileOptions), _end_constructStatusFile(etch.bindings.java.support.Mailbox)

_end_constructStatusFile

public final CiscoIpPhone.ConstructStatusFileResult _end_constructStatusFile(etch.bindings.java.support.Mailbox mb)

Ends a call to constructStatusFile.

Parameters:

mb - mailbox returned by _begin_constructStatusFile.

See Also:

RemoteCiscoIpPhoneServer.constructStatusFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructStatusFileOptions), _begin_constructStatusFile(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructStatusFileOptions)

_begin_constructText

public final etch.bindings.java.support.Mailbox _begin_constructText(java.lang.String sessionId,
                                                                     CiscoIpPhone.ConstructTextOptions options)

Begins a call to constructText.

Returns:

mailbox used to retrieve the result using _end_constructText.

See Also:

RemoteCiscoIpPhoneServer.constructText(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructTextOptions), _end_constructText(etch.bindings.java.support.Mailbox)

_end_constructText

public final CiscoIpPhone.ConstructTextResult _end_constructText(etch.bindings.java.support.Mailbox mb)

Ends a call to constructText.

Parameters:

mb - mailbox returned by _begin_constructText.

See Also:

RemoteCiscoIpPhoneServer.constructText(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructTextOptions), _begin_constructText(java.lang.String, cisco.uc.cuae.legacy.CiscoIpPhone.ConstructTextOptions)