The information in this topic may be out of date. The current SDK reference guide has moved here.

Open method

Class: EyesPlatform: AppiumLanguage: C# SDK:

Call this method to start a test, before calling any of the check methods.

Syntax

RemoteWebDriver outdriver = eyes.Open(driver, appName, testName);

Parameters

driver
Type:RemoteWebDriver
The web driver.
appName
Type:string
The application name. This may be any string. You can set the application name for all tests using the Configuration.SetAppName method or Eyes.AppName property. If you do so, then set this parameter to a value of null to indicate that the configuration default should be used.
testName
Type:string
The name of the test. This name must be unique within the scope of the application name. It may be any string.

Return value

Type: RemoteWebDriver
The returned web driver is a clone of the driver passed as a parameter. It is recomended that you use the web driver object returned by this method in all further calls to the web driver. This allows Eyes to record these interactions and play them back in the Eyes Test Manager.

Remarks

After making a call to this method, you must eventually terminate the test by calling Eyes.Close (in case of a normal completion) or Eyes.AbortAsync (in case of an aborted test). If you want to run another test, then it is recomended to do this with a newly created Eyes instance to avoid side effects. However, in principle, it is legal to call Eyes.Open again to start a new test on the same Eyes instance.