TaskComplete Class
TaskComplete Class
Raised by: SALT application, Speech Controls
Base Class: ApplicationTaskEvent
Derived Classes: None
TaskComplete provides a way for SALT application developers to send an event to the Trace log when an application completes a defined task.
TaskComplete has the following properties:
Property |
Type |
Description |
---|---|---|
TaskName |
String |
The name of the application task. |
CompletionState |
String |
A string provided by the developer that describes the status of the task at completion. |
Example
import Microsoft.SpeechServer.Messages; if ( TaskComplete.IsEnabled() ) { // Raise a task complete event TaskComplete.Raise( "Account update" ); }
Remarks
In the normal sequence of events, for a given TaskName, an associated TaskStart, TaskProgress, and TaskComplete event would appear in the logs.
Application developers should note that the firing of TaskComplete events is entirely the responsibility of the application. If the TaskComplete for any given task is not fired before the end of the application, the task completion will not be logged, and it may not appear in the Speech Application Report on Tasks. It will however, appear in the Errors report as an incomplete task.
See Also
Event Logging Class Hierarchy | Logging and Analyzing Events | CommonEvent | Event Filters | Filtering Logged Events