|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectetch.bindings.java.support.RemoteBase
cisco.uc.cuae.legacy.RemoteCiscoIpPhone
cisco.uc.cuae.legacy.RemoteCiscoIpPhoneServer
public final class RemoteCiscoIpPhoneServer
Call to message translator for CiscoIpPhoneServer.
| Nested Class Summary | |
|---|---|
class |
RemoteCiscoIpPhoneServer._Async
Asynchronous implementation of service methods. |
| Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CuaeCommon |
|---|
CuaeCommon.CuaeResult |
| Field Summary | |
|---|---|
RemoteCiscoIpPhoneServer._Async |
_async
RemoteCiscoIpPhoneServer._Async class instance used to hide asynchronous message
implementation. |
RemoteCiscoIpPhoneServer._Async |
_inner
Deprecated. |
| Constructor Summary | |
|---|---|
RemoteCiscoIpPhoneServer(etch.bindings.java.support.DeliveryService svc,
etch.bindings.java.msg.ValueFactory vf)
Constructs the RemoteCiscoIpPhoneServer. |
|
| Method Summary | |
|---|---|
CiscoIpPhone.AddDirectoryEntryResult |
addDirectoryEntry(java.lang.String sessionId,
CiscoIpPhone.AddDirectoryEntryOptions options)
Generated from CUAE Action AddDirectoryEntry Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false AddDirectoryEntry adds a directory entry to an
already-initialized Directory
XML object. |
CiscoIpPhone.AddIconItemResult |
addIconItemToIconFileMenu(java.lang.String sessionId,
CiscoIpPhone.AddIconItemOptions options)
|
CiscoIpPhone.AddIconItemResult |
addIconItemToIconMenu(java.lang.String sessionId,
CiscoIpPhone.AddIconItemOptions options)
Generated from CUAE Action AddIconItem Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false AddIconItem adds the definition for an icon item
to an already-initialized IconMenu
or IconFileMenu
XML object. |
CiscoIpPhone.AddInputItemResult |
addInputItem(java.lang.String sessionId,
CiscoIpPhone.AddInputItemOptions options)
Generated from CUAE Action AddInputItem Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false AddInputItem adds an input item to an already-initialized
Input XML
object. |
CiscoIpPhone.AddMenuItemResult |
addMenuItemToGraphicFileMenu(java.lang.String sessionId,
CiscoIpPhone.AddMenuItemOptions options)
|
CiscoIpPhone.AddMenuItemResult |
addMenuItemToGraphicMenu(java.lang.String sessionId,
CiscoIpPhone.AddMenuItemOptions options)
|
CiscoIpPhone.AddMenuItemResult |
addMenuItemToIconFileMenu(java.lang.String sessionId,
CiscoIpPhone.AddMenuItemOptions options)
|
CiscoIpPhone.AddMenuItemResult |
addMenuItemToIconMenu(java.lang.String sessionId,
CiscoIpPhone.AddMenuItemOptions options)
|
CiscoIpPhone.AddMenuItemResult |
addMenuItemToMenu(java.lang.String sessionId,
CiscoIpPhone.AddMenuItemOptions options)
Generated from CUAE Action AddMenuItem Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false AddMenuItem adds a menu item to an already-initialized
Menu, IconMenu,
IconFileMenu,
GraphicMenu,
or GraphicFileMenu
XML object. |
CiscoIpPhone.AddSoftKeyItemResult |
addSoftKeyItemToDirectory(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
|
CiscoIpPhone.AddSoftKeyItemResult |
addSoftKeyItemToGraphicFileMenu(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
|
CiscoIpPhone.AddSoftKeyItemResult |
addSoftKeyItemToGraphicMenu(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
|
CiscoIpPhone.AddSoftKeyItemResult |
addSoftKeyItemToIconFileMenu(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
|
CiscoIpPhone.AddSoftKeyItemResult |
addSoftKeyItemToIconMenu(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
|
CiscoIpPhone.AddSoftKeyItemResult |
addSoftKeyItemToImage(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
|
CiscoIpPhone.AddSoftKeyItemResult |
addSoftKeyItemToImageFile(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
|
CiscoIpPhone.AddSoftKeyItemResult |
addSoftKeyItemToInput(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
|
CiscoIpPhone.AddSoftKeyItemResult |
addSoftKeyItemToMenu(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
|
CiscoIpPhone.AddSoftKeyItemResult |
addSoftKeyItemToText(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
Generated from CUAE Action AddSoftKeyItem. |
CiscoIpPhone.ConstructDirectoryResult |
constructDirectory(java.lang.String sessionId,
CiscoIpPhone.ConstructDirectoryOptions options)
|
CiscoIpPhone.ConstructExecuteResult |
constructExecute(java.lang.String sessionId,
CiscoIpPhone.ConstructExecuteOptions options)
|
CiscoIpPhone.ConstructGraphicFileMenuResult |
constructGraphicFileMenu(java.lang.String sessionId,
CiscoIpPhone.ConstructGraphicFileMenuOptions options)
|
CiscoIpPhone.ConstructGraphicMenuResult |
constructGraphicMenu(java.lang.String sessionId,
CiscoIpPhone.ConstructGraphicMenuOptions options)
|
CiscoIpPhone.ConstructIconFileMenuResult |
constructIconFileMenu(java.lang.String sessionId,
CiscoIpPhone.ConstructIconFileMenuOptions options)
|
CiscoIpPhone.ConstructIconMenuResult |
constructIconMenu(java.lang.String sessionId,
CiscoIpPhone.ConstructIconMenuOptions options)
|
CiscoIpPhone.ConstructImageResult |
constructImage(java.lang.String sessionId,
CiscoIpPhone.ConstructImageOptions options)
|
CiscoIpPhone.ConstructImageFileResult |
constructImageFile(java.lang.String sessionId,
CiscoIpPhone.ConstructImageFileOptions options)
|
CiscoIpPhone.ConstructInputResult |
constructInput(java.lang.String sessionId,
CiscoIpPhone.ConstructInputOptions options)
|
CiscoIpPhone.ConstructMenuResult |
constructMenu(java.lang.String sessionId,
CiscoIpPhone.ConstructMenuOptions options)
|
CiscoIpPhone.ConstructStatusResult |
constructStatus(java.lang.String sessionId,
CiscoIpPhone.ConstructStatusOptions options)
|
CiscoIpPhone.ConstructStatusFileResult |
constructStatusFile(java.lang.String sessionId,
CiscoIpPhone.ConstructStatusFileOptions options)
|
CiscoIpPhone.ConstructTextResult |
constructText(java.lang.String sessionId,
CiscoIpPhone.ConstructTextOptions options)
|
CiscoIpPhone.CreateDirectoryResult |
createDirectory(java.lang.String sessionId,
CiscoIpPhone.CreateDirectoryOptions options)
Generated from CUAE Action CreateDirectory Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateDirectory initializes a Directory
XML object, which one can later use to display a directory on a Cisco IP Phone
in order to allow on to cause their phone to dial the number of a selected directory
entry on the phone screen. |
CiscoIpPhone.CreateExecuteResult |
createExecute(java.lang.String sessionId,
CiscoIpPhone.CreateExecuteOptions options)
Generated from CUAE Action CreateExecute Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateExecute initializes a Execute
XML object, so that one later push the XML execute command object to a Cisco
IP Phone. |
CiscoIpPhone.CreateGraphicFileMenuResult |
createGraphicFileMenu(java.lang.String sessionId,
CiscoIpPhone.CreateGraphicFileMenuOptions options)
Generated from CUAE Action CreateGraphicFileMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateGraphicFileMenu initializes a GraphicFileMenu
XML object, which one can later use to display a PNG-based menu on a Cisco IP
Phone. |
CiscoIpPhone.CreateGraphicMenuResult |
createGraphicMenu(java.lang.String sessionId,
CiscoIpPhone.CreateGraphicMenuOptions options)
Generated from CUAE Action CreateGraphicMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateGraphicMenu initializes a GraphicMenu
XML object, which one can later use to display a graphical menu on a Cisco IP
Phone, in which the number keys on the Cisco IP phone can be used to trigger
phone activity. |
CiscoIpPhone.CreateIconFileMenuResult |
createIconFileMenu(java.lang.String sessionId,
CiscoIpPhone.CreateIconFileMenuOptions options)
Generated from CUAE Action CreateIconFileMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateIconFileMenu initializes a IconFileMenu
XML object, which one can later use to display an icon menu on a Cisco IP Phone. |
CiscoIpPhone.CreateIconMenuResult |
createIconMenu(java.lang.String sessionId,
CiscoIpPhone.CreateIconMenuOptions options)
Generated from CUAE Action CreateIconMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateIconMenu initializes a IconMenu
XML object, which one can later use to display an icon menu on a Cisco IP Phone. |
CiscoIpPhone.CreateImageResult |
createImage(java.lang.String sessionId,
CiscoIpPhone.CreateImageOptions options)
Generated from CUAE Action CreateImage Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateImage initializes a Image
XML object, which one can later use to display an image on certain Cisco IP
Phones. |
CiscoIpPhone.CreateImageFileResult |
createImageFile(java.lang.String sessionId,
CiscoIpPhone.CreateImageFileOptions options)
Generated from CUAE Action CreateImageFile Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateImageFile initializes a ImageFile
XML object, which one can later use to display a PNG-based image on certain
Cisco IP Phones. |
CiscoIpPhone.CreateInputResult |
createInput(java.lang.String sessionId,
CiscoIpPhone.CreateInputOptions options)
Generated from CUAE Action CreateInput Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateInput initializes a Input
XML object, which one can later use to display an input form on a Cisco IP Phone
in order to allow the user to input and submit data back to the script. |
CiscoIpPhone.CreateMenuResult |
createMenu(java.lang.String sessionId,
CiscoIpPhone.CreateMenuOptions options)
Generated from CUAE Action CreateMenu Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateMenu initializes a Menu
XML object, which one can later use to display a menu on a Cisco IP Phone. |
CiscoIpPhone.CreateStatusResult |
createStatus(java.lang.String sessionId,
CiscoIpPhone.CreateStatusOptions options)
Generated from CUAE Action CreateStatus Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateStatus initializes a Status
XML object, which one can later use to display a status bar on a Cisco IP Phone
in order to show an small text blurb and optionally a small image in the middle
of the Cisco IP phone that is always present in the call plane, and unremovable
by the user. |
CiscoIpPhone.CreateStatusFileResult |
createStatusFile(java.lang.String sessionId,
CiscoIpPhone.CreateStatusFileOptions options)
Generated from CUAE Action CreateStatusFile Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateStatusFile initializes a StatusFile
XML object, which one can later use to display a status bar on a Cisco IP Phone
in order to show an small text blurb and optionally a small, PNG-based image
in the middle of the Cisco IP phone that is always present in the call plane,
and unremovable by the user. |
CiscoIpPhone.CreateTextResult |
createText(java.lang.String sessionId,
CiscoIpPhone.CreateTextOptions options)
Generated from CUAE Action CreateText Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false CreateText initializes a Text
XML object, which one can later use to display text on a Cisco IP Phone. |
CiscoIpPhone.SendExecuteResult |
sendExecute(java.lang.String sessionId,
java.lang.String message,
java.lang.String uRL,
CiscoIpPhone.SendExecuteOptions options)
Generated from CUAE Action SendExecute Sub-elements or attributes not supported by Etch: final: false; allowCustomParams: false SendExecute sends an XML object directly to the
Cisco IP Phone using an HTTP POST. |
| Methods inherited from class etch.bindings.java.support.RemoteBase |
|---|
_begincall, _endcall, _newMessage, _send, _start, _startAndWaitUp, _stop, _stopAndWaitDown, _transportControl, _transportNotify, _transportQuery, _waitDown, _waitUp, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public final RemoteCiscoIpPhoneServer._Async _async
RemoteCiscoIpPhoneServer._Async class instance used to hide asynchronous message
implementation. Use this to invoke the asynchronous message
implementations.
@Deprecated public final RemoteCiscoIpPhoneServer._Async _inner
RemoteCiscoIpPhoneServer._Async class instance used to hide asynchronous message
implementation. This is here for backwards compatibility only, use
_async instead.
| Constructor Detail |
|---|
public RemoteCiscoIpPhoneServer(etch.bindings.java.support.DeliveryService svc,
etch.bindings.java.msg.ValueFactory vf)
svc - vf - | Method Detail |
|---|
public final CiscoIpPhone.AddDirectoryEntryResult addDirectoryEntry(java.lang.String sessionId,
CiscoIpPhone.AddDirectoryEntryOptions options)
CiscoIpPhoneServerAddDirectoryEntry adds a directory entry to an
already-initialized Directory
XML object.
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.
SendResponse
or SendExecute.
addDirectoryEntry in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.AddIconItemResult addIconItemToIconMenu(java.lang.String sessionId,
CiscoIpPhone.AddIconItemOptions options)
CiscoIpPhoneServerAddIconItem adds the definition for an icon item
to an already-initialized IconMenu
or IconFileMenu
XML object.
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.
SendResponse
or SendExecute.
addIconItemToIconMenu in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.AddIconItemResult addIconItemToIconFileMenu(java.lang.String sessionId,
CiscoIpPhone.AddIconItemOptions options)
addIconItemToIconFileMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddInputItemResult addInputItem(java.lang.String sessionId,
CiscoIpPhone.AddInputItemOptions options)
CiscoIpPhoneServerAddInputItem adds an input item to an already-initialized
Input XML
object.
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.
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.
SendResponse
or SendExecute.
addInputItem in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.AddMenuItemResult addMenuItemToMenu(java.lang.String sessionId,
CiscoIpPhone.AddMenuItemOptions options)
CiscoIpPhoneServerAddMenuItem adds a menu item to an already-initialized
Menu, IconMenu,
IconFileMenu,
GraphicMenu,
or GraphicFileMenu
XML object.
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.
SendResponse
or SendExecute.
addMenuItemToMenu in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.AddMenuItemResult addMenuItemToIconMenu(java.lang.String sessionId,
CiscoIpPhone.AddMenuItemOptions options)
addMenuItemToIconMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddMenuItemResult addMenuItemToIconFileMenu(java.lang.String sessionId,
CiscoIpPhone.AddMenuItemOptions options)
addMenuItemToIconFileMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddMenuItemResult addMenuItemToGraphicMenu(java.lang.String sessionId,
CiscoIpPhone.AddMenuItemOptions options)
addMenuItemToGraphicMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddMenuItemResult addMenuItemToGraphicFileMenu(java.lang.String sessionId,
CiscoIpPhone.AddMenuItemOptions options)
addMenuItemToGraphicFileMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToText(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
CiscoIpPhoneServerAddSoftKeyItem adds a softkey item with any already-initialized
XML object except the Status
or Execute
type.
AddSoftKeyItem adds a softkey to an XML object,
giving the user a button at the bottom of the display on the Cisco IP Phone.
SendResponse
or SendExecute.
addSoftKeyItemToText in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToMenu(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
addSoftKeyItemToMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToDirectory(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
addSoftKeyItemToDirectory in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToImage(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
addSoftKeyItemToImage in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToInput(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
addSoftKeyItemToInput in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToImageFile(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
addSoftKeyItemToImageFile in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToIconMenu(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
addSoftKeyItemToIconMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToIconFileMenu(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
addSoftKeyItemToIconFileMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToGraphicMenu(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
addSoftKeyItemToGraphicMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.AddSoftKeyItemResult addSoftKeyItemToGraphicFileMenu(java.lang.String sessionId,
CiscoIpPhone.AddSoftKeyItemOptions options)
addSoftKeyItemToGraphicFileMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.CreateDirectoryResult createDirectory(java.lang.String sessionId,
CiscoIpPhone.CreateDirectoryOptions options)
CiscoIpPhoneServerCreateDirectory 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.
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.
SendResponse
or SendExecute.
createDirectory in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateExecuteResult createExecute(java.lang.String sessionId,
CiscoIpPhone.CreateExecuteOptions options)
CiscoIpPhoneServerCreateExecute initializes a Execute
XML object, so that one later push the XML execute command object to a Cisco
IP Phone.
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.
SendExecute.
createExecute in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateGraphicFileMenuResult createGraphicFileMenu(java.lang.String sessionId,
CiscoIpPhone.CreateGraphicFileMenuOptions options)
CiscoIpPhoneServerCreateGraphicFileMenu initializes a GraphicFileMenu
XML object, which one can later use to display a PNG-based menu on a Cisco IP
Phone.
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.
SendResponse
or SendExecute.
createGraphicFileMenu in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateGraphicMenuResult createGraphicMenu(java.lang.String sessionId,
CiscoIpPhone.CreateGraphicMenuOptions options)
CiscoIpPhoneServerCreateGraphicMenu 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.
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.
SendResponse
or SendExecute.
createGraphicMenu in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateIconFileMenuResult createIconFileMenu(java.lang.String sessionId,
CiscoIpPhone.CreateIconFileMenuOptions options)
CiscoIpPhoneServerCreateIconFileMenu initializes a IconFileMenu
XML object, which one can later use to display an icon menu on a Cisco IP Phone.
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.
SendResponse
or SendExecute.
createIconFileMenu in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateIconMenuResult createIconMenu(java.lang.String sessionId,
CiscoIpPhone.CreateIconMenuOptions options)
CiscoIpPhoneServerCreateIconMenu initializes a IconMenu
XML object, which one can later use to display an icon menu on a Cisco IP Phone.
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.
SendResponse
or SendExecute.
createIconMenu in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateImageResult createImage(java.lang.String sessionId,
CiscoIpPhone.CreateImageOptions options)
CiscoIpPhoneServerCreateImage initializes a Image
XML object, which one can later use to display an image on certain Cisco IP
Phones.
CreateImage allows the developer to establish the
Title, Prompt, and image properties of the Cisco IP
Phone Image XML object. These parameters are stored into the Image
XML type. This type can later be manipulated further by using the AddSoftKeyItem
action to add softkeys to the image object.
CreateImage and CreateGraphicMenu
differ only in that, with CreateGraphicMenu, one can specify menu
items in addition to the image content. The menu items do not display visually;
instead, they correspond to keys on the number pad of the phone. So, practically,
an image shown on a graphic menu will also provide visual cues so that the user
can determine which key on the keypad to push for a particular option.
SendResponse
or SendExecute.
createImage in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateImageFileResult createImageFile(java.lang.String sessionId,
CiscoIpPhone.CreateImageFileOptions options)
CiscoIpPhoneServerCreateImageFile initializes a ImageFile
XML object, which one can later use to display a PNG-based image on certain
Cisco IP Phones.
CreateImageFile allows the developer to establish
the Title, Prompt, and image properties of the Cisco
IP Phone ImageFile XML object. These parameters are stored into the ImageFile
XML type. This type can later be manipulated further by using the AddSoftKeyItem
action to add softkeys to the image file object.
CreateImageFile.
CreateGraphicFileMenu
action. CretaeImageFile does not allow you to use touch-screen
functionality of the phone.
SendResponse
or SendExecute.
createImageFile in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateInputResult createInput(java.lang.String sessionId,
CiscoIpPhone.CreateInputOptions options)
CiscoIpPhoneServerCreateInput 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.
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.
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.
SendResponse
or SendExecute.
createInput in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateMenuResult createMenu(java.lang.String sessionId,
CiscoIpPhone.CreateMenuOptions options)
CiscoIpPhoneServerCreateMenu initializes a Menu
XML object, which one can later use to display a menu on a Cisco IP Phone.
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.
SendResponse
or SendExecute.
createMenu in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateStatusResult createStatus(java.lang.String sessionId,
CiscoIpPhone.CreateStatusOptions options)
CiscoIpPhoneServerCreateStatus 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.
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.
SendExecute
action.
createStatus in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateStatusFileResult createStatusFile(java.lang.String sessionId,
CiscoIpPhone.CreateStatusFileOptions options)
CiscoIpPhoneServerCreateStatusFile 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.
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.
SendExecute
action.
createStatusFile in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.CreateTextResult createText(java.lang.String sessionId,
CiscoIpPhone.CreateTextOptions options)
CiscoIpPhoneServerCreateText initializes a Text
XML object, which one can later use to display text on a Cisco IP Phone.
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.
SendResponse
or SendExecute.
createText in interface CiscoIpPhoneServersessionId - The session Id for this method calloptions - An object holding all the optional parameters
public final CiscoIpPhone.SendExecuteResult sendExecute(java.lang.String sessionId,
java.lang.String message,
java.lang.String uRL,
CiscoIpPhone.SendExecuteOptions options)
CiscoIpPhoneServerSendExecute sends an XML object directly to the
Cisco IP Phone using an HTTP POST.
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.
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.
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.
sendExecute in interface CiscoIpPhoneServersessionId - The session Id for this method callmessage - 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
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
public final CiscoIpPhone.ConstructDirectoryResult constructDirectory(java.lang.String sessionId,
CiscoIpPhone.ConstructDirectoryOptions options)
constructDirectory in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructExecuteResult constructExecute(java.lang.String sessionId,
CiscoIpPhone.ConstructExecuteOptions options)
constructExecute in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructGraphicFileMenuResult constructGraphicFileMenu(java.lang.String sessionId,
CiscoIpPhone.ConstructGraphicFileMenuOptions options)
constructGraphicFileMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructGraphicMenuResult constructGraphicMenu(java.lang.String sessionId,
CiscoIpPhone.ConstructGraphicMenuOptions options)
constructGraphicMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructIconFileMenuResult constructIconFileMenu(java.lang.String sessionId,
CiscoIpPhone.ConstructIconFileMenuOptions options)
constructIconFileMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructIconMenuResult constructIconMenu(java.lang.String sessionId,
CiscoIpPhone.ConstructIconMenuOptions options)
constructIconMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructImageResult constructImage(java.lang.String sessionId,
CiscoIpPhone.ConstructImageOptions options)
constructImage in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructImageFileResult constructImageFile(java.lang.String sessionId,
CiscoIpPhone.ConstructImageFileOptions options)
constructImageFile in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructInputResult constructInput(java.lang.String sessionId,
CiscoIpPhone.ConstructInputOptions options)
constructInput in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructMenuResult constructMenu(java.lang.String sessionId,
CiscoIpPhone.ConstructMenuOptions options)
constructMenu in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructStatusResult constructStatus(java.lang.String sessionId,
CiscoIpPhone.ConstructStatusOptions options)
constructStatus in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructStatusFileResult constructStatusFile(java.lang.String sessionId,
CiscoIpPhone.ConstructStatusFileOptions options)
constructStatusFile in interface CiscoIpPhoneServer
public final CiscoIpPhone.ConstructTextResult constructText(java.lang.String sessionId,
CiscoIpPhone.ConstructTextOptions options)
constructText in interface CiscoIpPhoneServer
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||