BrowserFilter

Web. BrowserFilter

new BrowserFilter(props[opt]) → {BrowserFilter}

Used to filter for the desired browser, when invoking the Attach method of the BrowserFactory.
Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes the BrowserFilter using the supplied property bag.
Returns:
the description object that was initialized.
Type
BrowserFilter

Methods

openTitle(title[opt]) → {string|Description}

The object's initial title when first opened.
Parameters:
NameTypeAttributesDescription
titlestring <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(url[opt]) → {string|Description}

The URL from which the object is first opened.
Parameters:
NameTypeAttributesDescription
urlstring <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

title(title[opt]) → {string|Description}

The browser's title.
Parameters:
NameTypeAttributesDescription
titlestring <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(browserType[opt]) → {string|Description}

The type of browser.
Parameters:
NameTypeAttributesDescription
browserTypestring <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(url[opt]) → {string|Description}

The browser's current URL.
Parameters:
NameTypeAttributesDescription
urlstring <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