Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

Object Interface


Detailed Description

Abstract interface for VoiceXML object functionality that allows integrators to define VoiceXML language extensions that can be executed by applications through the VoiceXML object element.

These objects can provide almost any extended functionality that is desired.


Classes

struct  VXIobjectInterface
 Abstract interface for VoiceXML object functionality that allows integrators to define VoiceXML language extensions that can be executed by applications through the VoiceXML object element. More...

Object Properties

Keys identifying properties in VXIMap for Execute( ) and Validate( )

Note that VXIinet properties should also be included, these are simply passed through to VXIinet for fetches as-is.

#define OBJECT_CLASS_ID   L"classid"
#define OBJECT_CODE_BASE   L"codebase"
#define OBJECT_CODE_TYPE   L"codetype"
#define OBJECT_DATA   L"data"
#define OBJECT_ARCHIVE   L"archive"

<param> keys

Keys identifying properties in the VXIMap for an individual parameter (<param> element) in cases where "valuetype" is not "data".

#define OBJECT_TYPE   L"type"
#define OBJECT_TYPE   L"type"
#define OBJECT_VALUE   L"value"
#define OBJECT_VALUETYPE   L"valuetype"

Defines

#define OBJECT_CLASS_ID_DEFAULT   L""
#define OBJECT_CODE_BASE_DEFAULT   L""
#define OBJECT_CODE_TYPE_DEFAULT   L""
#define OBJECT_DATA_DEFAULT   L""
#define OBJECT_TYPE_DEFAULT   L""
#define OBJECT_ARCHIVE_DEFAULT   L""

Typedefs

typedef enum VXIobjResult VXIobjResult
typedef VXIobjectInterface VXIobjectInterface
 Abstract interface for VoiceXML object functionality that allows integrators to define VoiceXML language extensions that can be executed by applications through the VoiceXML object element.

Enumerations

enum  VXIobjResult {
  VXIobj_RESULT_FATAL_ERROR = -100, VXIobj_RESULT_IO_ERROR = -8, VXIobj_RESULT_OUT_OF_MEMORY = -7, VXIobj_RESULT_SYSTEM_ERROR = -6,
  VXIobj_RESULT_PLATFORM_ERROR = -5, VXIobj_RESULT_BUFFER_TOO_SMALL = -4, VXIobj_RESULT_INVALID_PROP_NAME = -3, VXIobj_RESULT_INVALID_PROP_VALUE = -2,
  VXIobj_RESULT_INVALID_ARGUMENT = -1, VXIobj_RESULT_SUCCESS = 0, VXIobj_RESULT_FAILURE = 1, VXIobj_RESULT_NON_FATAL_ERROR = 2,
  VXIobj_RESULT_UNSUPPORTED = 100
}


Define Documentation

#define OBJECT_ARCHIVE   L"archive"
 

#define OBJECT_ARCHIVE_DEFAULT   L""
 

#define OBJECT_CLASS_ID   L"classid"
 

#define OBJECT_CLASS_ID_DEFAULT   L""
 

#define OBJECT_CODE_BASE   L"codebase"
 

#define OBJECT_CODE_BASE_DEFAULT   L""
 

#define OBJECT_CODE_TYPE   L"codetype"
 

#define OBJECT_CODE_TYPE_DEFAULT   L""
 

#define OBJECT_DATA   L"data"
 

#define OBJECT_DATA_DEFAULT   L""
 

#define OBJECT_TYPE   L"type"
 

#define OBJECT_TYPE   L"type"
 

#define OBJECT_TYPE_DEFAULT   L""
 

#define OBJECT_VALUE   L"value"
 

#define OBJECT_VALUETYPE   L"valuetype"
 


Typedef Documentation

typedef struct VXIobjectInterface VXIobjectInterface
 

Abstract interface for VoiceXML object functionality that allows integrators to define VoiceXML language extensions that can be executed by applications through the VoiceXML object element.

These objects can provide almost any extended functionality that is desired.

There is one object interface per thread/line.

typedef enum VXIobjResult VXIobjResult
 


Enumeration Type Documentation

enum VXIobjResult
 

Enumeration values:
VXIobj_RESULT_FATAL_ERROR  Fatal error, terminate call.
VXIobj_RESULT_IO_ERROR  I/O error.
VXIobj_RESULT_OUT_OF_MEMORY  Out of memory.
VXIobj_RESULT_SYSTEM_ERROR  System error, out of service.
VXIobj_RESULT_PLATFORM_ERROR  Errors from platform services.
VXIobj_RESULT_BUFFER_TOO_SMALL  Return buffer too small.
VXIobj_RESULT_INVALID_PROP_NAME  Property name is not valid.
VXIobj_RESULT_INVALID_PROP_VALUE  Property value is not valid.
VXIobj_RESULT_INVALID_ARGUMENT  Invalid function argument.
VXIobj_RESULT_SUCCESS  Success.

Note that Success is defined as 0 and that all critical errors are less than 0 and all non critical errors are greater than 0.

VXIobj_RESULT_FAILURE  Normal failure, nothing logged.
VXIobj_RESULT_NON_FATAL_ERROR  Non-fatal non-specific error.
VXIobj_RESULT_UNSUPPORTED  Operation is not supported.


Generated on Wed Jun 1 12:50:19 2005 for OpenVXI by  doxygen 1.4.2