RunAsync Method

Microsoft Speech Platform SDK 11

previous page next page

Launches an asynchronous instance of the VoiceXML Browser, specifying the URI of the VoiceXML start page to load, and a CookieContainer parameter.

Namespace: Microsoft.Speech.VoiceXml
Assembly: Microsoft.Speech.VoiceXml (in Microsoft.Speech.VoiceXml.dll)

Syntax

C#
public void RunAsync( Uri vxmlPage, CookieContainer container )

Parameters

vxmlPage: Type: System..::..Uri
The URI of the VoiceXML start page to load.

container: Type: System.Net..::..CookieContainer
Contains state information associated with a request for a VoiceXML page. The value can be null.

Remarks

When initiated, the RunAsync method checks the value of the Browser's State property to determine if the Browser is already running. If Browser.State equals Active, then the Browser is running and the RunAsync method throws an InvalidOperationException. If Browser.State equals Idle, then the RunAsync method sets Browser.State to Active and launches the Browser instance.

You can instantiate and run multiple Browser objects simultaneously, for example Browser1, Browser2, Browser3. You cannot run the same Browser instance concurrently on multiple sessions, for example Browser1(a), Browser1(b), Browser1(c).

The Browser may raise any of the following events during an asynchronous session: Disconnecting, Disconnected, Transferring, Transferred, or SessionCompleted. The SessionCompleted event is raised at the end of an asynchronous Browser session, and represents the result of the Browser session with a VoiceXmlResult object.

Exceptions

Exception	Condition
System..::..ArgumentNullException	Thrown when the RunAsync method is called and the URI of the VoiceXML start page to load contains a null argument value.
System..::..InvalidOperationException	Thrown when the RunAsync method is called on a Browser instance that is running.