cisco.uc.cuae.legacy
Interface VoiceRecResultsServer

All Superinterfaces:
CuaeCommon, CuaeCommonServer, VoiceRecResults
All Known Implementing Classes:
BaseVoiceRecResultsServer, RemoteVoiceRecResultsServer

public interface VoiceRecResultsServer
extends VoiceRecResults, CuaeCommonServer

The VoiceRecResults package provides helper methods to parse voice recognition results from the XML content in the VR_XMLResult event parameter. Generated from CUAE provider package Metreos.Native.VoiceRecResults


Nested Class Summary
 
Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.VoiceRecResults
VoiceRecResults.GetAppTempDirectoryOptions, VoiceRecResults.GetAppTempDirectoryResult, VoiceRecResults.GetScriptTempDirectoryOptions, VoiceRecResults.GetScriptTempDirectoryResult, VoiceRecResults.GetWebDirectoryOptions, VoiceRecResults.GetWebDirectoryResult
 
Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CuaeCommon
CuaeCommon.CuaeResult
 
Nested classes/interfaces inherited from interface cisco.uc.cuae.legacy.CuaeCommon
CuaeCommon.CuaeResult
 
Method Summary
 VoiceRecResults.GetAppTempDirectoryResult getAppTempDirectory(java.lang.String sessionId, VoiceRecResults.GetAppTempDirectoryOptions options)
          GetAppTempDirectory is used to retrieve the Temp directory file path and URI.
 VoiceRecResults.GetScriptTempDirectoryResult getScriptTempDirectory(java.lang.String sessionId, java.lang.String routingGuid, VoiceRecResults.GetScriptTempDirectoryOptions options)
          GetScriptTempDirectory is used to retrieve a script instance's temp directory file path and URI.
 VoiceRecResults.GetWebDirectoryResult getWebDirectory(java.lang.String sessionId, VoiceRecResults.GetWebDirectoryOptions options)
          GetWebDirectory is used to retrieve the Web directory file path and URI.
 

Method Detail

getScriptTempDirectory

VoiceRecResults.GetScriptTempDirectoryResult getScriptTempDirectory(java.lang.String sessionId,
                                                                    java.lang.String routingGuid,
                                                                    VoiceRecResults.GetScriptTempDirectoryOptions options)
GetScriptTempDirectory is used to retrieve a script instance's temp directory file path and URI. Files written into a script instance's temp folder are automatically deleted, along with the script instance folder itself, when the script instance ends. A Temp folder is created under the application installation directory, and the directory and any files and directories within it are accessible via HTTP. Whenever a script instance is started, a directory is also created underneath the Temp directory with the name of that instance's RoutingGuid. The GetScriptTempDirectory action allows a developer a way to programmatically determine both the physical file system location and the HTTP-rooted URI of this script instance directory, and any contents within that directory.

Parameters:
sessionId - The session Id for this method call
routingGuid - The RoutingGuid of the the script instance.
options - An object holding all the optional parameters

getAppTempDirectory

VoiceRecResults.GetAppTempDirectoryResult getAppTempDirectory(java.lang.String sessionId,
                                                              VoiceRecResults.GetAppTempDirectoryOptions options)
GetAppTempDirectory is used to retrieve the Temp directory file path and URI. Files written into the application Temp folder are not automatically deleted from the Temp folder unless the application is reinstalled. Best practice therefore dictates that any files written to the Temp directory are deleted appropriately by the application, so that the Temp directory does not eventually grow too large in size and affect the available hard disk for the entire server. If you want files written to the temporary directory to be cleaned up as the script instance ends, use the GetScriptTempDirectory action to get a path to a folder that is deleted as the script ends. A Temp folder is created under the application installation directory, and the directory and any files and directories within it are accessible via HTTP. The GetAppTempDirectory action allows a developer a way to programmatically determine both the physical file system location and the HTTP-rooted URI of the Temp folder, and any contents within that folder.

Parameters:
sessionId - The session Id for this method call
options - An object holding all the optional parameters

getWebDirectory

VoiceRecResults.GetWebDirectoryResult getWebDirectory(java.lang.String sessionId,
                                                      VoiceRecResults.GetWebDirectoryOptions options)
GetWebDirectory is used to retrieve the Web directory file path and URI. None. The Web folder feature in the Cisco Unified Application Designer allows a developer to bundle in files and directories in the application package; these files are placed in a particular location on the Cisco Unified Application Server when the application is installed, and all Web folder-located files are also given HTTP access. The GetWebDirectory action allows a developer a way to programmatically determine both the physical file system location and the HTTP-rooted URI of the Web folder, and any contents within that folder.

Parameters:
sessionId - The session Id for this method call
options - An object holding all the optional parameters


Copyright © 2008. All Rights Reserved.