new BrowserFilter(propsopt) → {BrowserFilter}
Used to filter for the desired browser, when invoking the Attach method of the BrowserFactory.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props |
Object |
<optional> |
Initializes the BrowserFilter using the supplied property bag. |
Returns:
the description object that was initialized.
- Type
- BrowserFilter
Methods
get(capability) → {*}
Returns the current value of a browser description capability.
Parameters:
| Name | Type | Description |
|---|---|---|
capability |
string | The name of the capability whose value to return. |
Returns:
The current value of a browser description capability.
- Type
- *
openTitle(titleopt) → {string|Description}
The object's initial title when first opened.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
title |
string |
<optional> |
When provided, this method acts as a setter and sets openTitle to the specified value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored openTitle;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
openURL(urlopt) → {string|Description}
The URL from which the object is first opened.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
url |
string |
<optional> |
When provided, this method acts as a setter and sets openURL to the specified value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored openURL;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
set(capability, value) → {Web.BrowserFilter}
Sets a browser description capability to the given value.
Parameters:
| Name | Type | Description |
|---|---|---|
capability |
string | The name of the capability whose value to set. |
value |
string | The new value of the capability. |
Returns:
Returns 'this' for use with the builder pattern.
- Type
- Web.BrowserFilter
title(titleopt) → {string|Description}
The browser's title.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
title |
string |
<optional> |
When provided, this method acts as a setter and sets the title to the specified value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored title;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
type(browserTypeopt) → {string|Description}
The type of browser.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
browserType |
string |
<optional> |
When provided, this method acts as a setter and sets the type property to the specified value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored type;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description
url(urlopt) → {string|Description}
The browser's current URL.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
url |
string |
<optional> |
When provided, this method acts as a setter and sets the URL to the specified value. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored URL;
otherwise it returns 'this' for use with the builder pattern.
- Type
- string | Description