META-INF.apidocs.nl.hsac.fitnesse.fixture.slim.web.Ng2BrowserTest.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hsac-fitnesse-fixtures Show documentation
Show all versions of hsac-fitnesse-fixtures Show documentation
Fixtures to assist in testing via FitNesse
{
"constructors" : [ {
"readableName" : "ng 2 browser test",
"usage" : "| ng 2 browser test |",
"name" : "Ng2BrowserTest",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ]
}, {
"readableName" : "ng 2 browser test",
"usage" : "| ng 2 browser test | [secondsBeforeTimeout] |",
"name" : "Ng2BrowserTest",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "secondsBeforeTimeout",
"type" : "int"
} ],
"exceptions" : [ ]
} ],
"qualifiedName" : "nl.hsac.fitnesse.fixture.slim.web.Ng2BrowserTest",
"publicMethods" : [ {
"readableName" : "open",
"usage" : "| open | [address] | ",
"contexthelp" : "open <address>",
"name" : "open",
"docString" : "",
"annotations" : [ "Override" ],
"parameters" : [ {
"name" : "address",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait for angular requests to finish",
"usage" : "| wait for angular requests to finish |",
"contexthelp" : "wait for angular requests to finish",
"name" : "waitForAngularRequestsToFinish",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "get angular root",
"usage" : "| get angular root |",
"contexthelp" : "get angular root",
"name" : "getAngularRoot",
"docString" : "@return CSS selector expression used to find root of application.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "set angular root",
"usage" : "| set angular root | [anAngularRoot] | ",
"contexthelp" : "set angular root <anAngularRoot>",
"name" : "setAngularRoot",
"docString" : "Defines which CSS selector to use to find the application root.\n@param anAngularRoot CSS selector expression.",
"annotations" : [ ],
"parameters" : [ {
"name" : "anAngularRoot",
"description" : "CSS selector expression.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "open",
"usage" : "| open | [address] | ",
"contexthelp" : "open <address>",
"name" : "open",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "address",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "location",
"usage" : "| location |",
"contexthelp" : "location",
"name" : "location",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "back",
"usage" : "| back |",
"contexthelp" : "back",
"name" : "back",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "forward",
"usage" : "| forward |",
"contexthelp" : "forward",
"name" : "forward",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "refresh",
"usage" : "| refresh |",
"contexthelp" : "refresh",
"name" : "refresh",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "alert text",
"usage" : "| alert text |",
"contexthelp" : "alert text",
"name" : "alertText",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "confirm alert",
"usage" : "| confirm alert |",
"contexthelp" : "confirm alert",
"name" : "confirmAlert",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "confirm alert if available",
"usage" : "| confirm alert if available |",
"contexthelp" : "confirm alert if available",
"name" : "confirmAlertIfAvailable",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "dismiss alert",
"usage" : "| dismiss alert |",
"contexthelp" : "dismiss alert",
"name" : "dismissAlert",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "dismiss alert if available",
"usage" : "| dismiss alert if available |",
"contexthelp" : "dismiss alert if available",
"name" : "dismissAlertIfAvailable",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "open in new tab",
"usage" : "| open in new tab | [url] | ",
"contexthelp" : "open in new tab <url>",
"name" : "openInNewTab",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "url",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "switch to next tab",
"usage" : "| switch to next tab |",
"contexthelp" : "switch to next tab",
"name" : "switchToNextTab",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "switch to previous tab",
"usage" : "| switch to previous tab |",
"contexthelp" : "switch to previous tab",
"name" : "switchToPreviousTab",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "close tab",
"usage" : "| close tab |",
"contexthelp" : "close tab",
"name" : "closeTab",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "ensure only one tab",
"usage" : "| ensure only one tab |",
"contexthelp" : "ensure only one tab",
"name" : "ensureOnlyOneTab",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "ensure active tab is not closed",
"usage" : "| ensure active tab is not closed |",
"contexthelp" : "ensure active tab is not closed",
"name" : "ensureActiveTabIsNotClosed",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "tab count",
"usage" : "| tab count |",
"contexthelp" : "tab count",
"name" : "tabCount",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "current tab index",
"usage" : "| current tab index |",
"contexthelp" : "current tab index",
"name" : "currentTabIndex",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "switch to default content",
"usage" : "| switch to default content |",
"contexthelp" : "switch to default content",
"name" : "switchToDefaultContent",
"docString" : "Activates main/top-level iframe (i.e. makes it the current frame).",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "switch to frame",
"usage" : "| switch to frame | [technicalSelector] | ",
"contexthelp" : "switch to frame <technicalSelector>",
"name" : "switchToFrame",
"docString" : "Activates specified child frame of current iframe.\n@param technicalSelector selector to find iframe.\n@return true if iframe was found.",
"annotations" : [ ],
"parameters" : [ {
"name" : "technicalSelector",
"description" : "selector to find iframe.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "switch to parent frame",
"usage" : "| switch to parent frame |",
"contexthelp" : "switch to parent frame",
"name" : "switchToParentFrame",
"docString" : "Activates parent frame of current iframe.\n Does nothing if when current frame is the main/top-level one.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "page title",
"usage" : "| page title |",
"contexthelp" : "page title",
"name" : "pageTitle",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "page content type",
"usage" : "| page content type |",
"contexthelp" : "page content type",
"name" : "pageContentType",
"docString" : "@return current page's content type.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "enter as",
"usage" : "| enter | [value] | as | [place] | ",
"contexthelp" : "enter <value> as <place>",
"name" : "enterAs",
"docString" : "Replaces content at place by value.\n@param value value to set.\n@param place element to set value on.\n@return true, if element was found.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to set.",
"type" : "String"
}, {
"name" : "place",
"description" : "element to set value on.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as left of",
"usage" : "| enter | [value] | as | [technicalLocator] | left of | [referencePlace] |",
"contexthelp" : "enter <value> as <technicalLocator> left of <referencePlace>",
"name" : "enterAsLeftOf",
"docString" : "Replace content of given (technical) locator, found left of a reference element\n Usage: | enter | [value] | as | [technicalLocator] | left of | [referencePlace] |\n@param value value to enter\n@param technicalLocator element to find to find (i.e. css=input)\n@param referencePlace the element to us as a reference to search from\n@return true if the element was found and the value was sent",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to enter",
"type" : "String"
}, {
"name" : "technicalLocator",
"description" : "element to find to find (i.e. css=input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "the element to us as a reference to search from",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as left of in",
"usage" : "| enter | [value] | as | [technicalLocator] | left of | [referencePlace] | in | [container] |",
"contexthelp" : "enter <value> as <technicalLocator> left of <referencePlace> in <container>",
"name" : "enterAsLeftOfIn",
"docString" : "Replace content of given (technical) locator, found left of a reference element\n Usage: | enter | [value] | as | [technicalLocator] | left of | [referencePlace] | in | [container] |\n@param value value to enter\n@param technicalLocator element to find to find (i.e. css=input)\n@param referencePlace the element to us as a reference to search from\n@param container the container to search in\n@return true if the element was found and the value was sent",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to enter",
"type" : "String"
}, {
"name" : "technicalLocator",
"description" : "element to find to find (i.e. css=input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "the element to us as a reference to search from",
"type" : "String"
}, {
"name" : "container",
"description" : "the container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as right of",
"usage" : "| enter | [value] | as | [technicalLocator] | right of | [referencePlace] |",
"contexthelp" : "enter <value> as <technicalLocator> right of <referencePlace>",
"name" : "enterAsRightOf",
"docString" : "Replace content of given tag, found right of a reference element\n Usage: | enter | [value] | as | [technicalLocator] | right of | [referencePlace] |\n@param value value to enter\n@param technicalLocator tag to find (i.e. input)\n@param referencePlace the element to us as a reference to search from\n@return true if the element was found and the value was sent",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to enter",
"type" : "String"
}, {
"name" : "technicalLocator",
"description" : "tag to find (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "the element to us as a reference to search from",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as right of in",
"usage" : "| enter | [value] | as | [technicalLocator] | right of | [referencePlace] | in | [container] |",
"contexthelp" : "enter <value> as <technicalLocator> right of <referencePlace> in <container>",
"name" : "enterAsRightOfIn",
"docString" : "Replace content of given tag, found right of a reference element\n Usage: | enter | [value] | as | [technicalLocator] | right of | [referencePlace] | in | [container] |\n@param value value to enter\n@param technicalLocator tag to find (i.e. input)\n@param referencePlace the element to us as a reference to search from\n@param container the container to search in\n@return true if the element was found and the value was sent",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to enter",
"type" : "String"
}, {
"name" : "technicalLocator",
"description" : "tag to find (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "the element to us as a reference to search from",
"type" : "String"
}, {
"name" : "container",
"description" : "the container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as above",
"usage" : "| enter | [value] | as | [technicalLocator] | above | [referencePlace] | ",
"contexthelp" : "enter <value> as <technicalLocator> above <referencePlace>",
"name" : "enterAsAbove",
"docString" : "Replace content of given tag, found above a reference element\n@param value value to enter\n@param technicalLocator tag to find (i.e. input)\n@param referencePlace the element to us as a reference to search from\n@return true if the element was found and the value was sent",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to enter",
"type" : "String"
}, {
"name" : "technicalLocator",
"description" : "tag to find (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "the element to us as a reference to search from",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as above in",
"usage" : "| enter | [value] | as | [technicalLocator] | above | [referencePlace] | in | [container] | ",
"contexthelp" : "enter <value> as <technicalLocator> above <referencePlace> in <container>",
"name" : "enterAsAboveIn",
"docString" : "Replace content of given tag, found above a reference element, in a container\n@param value value to enter\n@param technicalLocator tag to find (i.e. input)\n@param referencePlace the element to us as a reference to search from\n@param container the container to search in\n@return true if the element was found and the value was sent",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to enter",
"type" : "String"
}, {
"name" : "technicalLocator",
"description" : "tag to find (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "the element to us as a reference to search from",
"type" : "String"
}, {
"name" : "container",
"description" : "the container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as below",
"usage" : "| enter | [value] | as | [technicalLocator] | below | [referencePlace] | ",
"contexthelp" : "enter <value> as <technicalLocator> below <referencePlace>",
"name" : "enterAsBelow",
"docString" : "Replace content of given tag, found below a reference element\n@param value value to enter\n@param technicalLocator tag to find (i.e. input)\n@param referencePlace the element to us as a reference to search from\n@return true if the element was found and the value was sent",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to enter",
"type" : "String"
}, {
"name" : "technicalLocator",
"description" : "tag to find (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "the element to us as a reference to search from",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as below in",
"usage" : "| enter | [value] | as | [technicalLocator] | below | [referencePlace] | in | [container] | ",
"contexthelp" : "enter <value> as <technicalLocator> below <referencePlace> in <container>",
"name" : "enterAsBelowIn",
"docString" : "Replace content of given tag, found below a reference element, in a container\n@param value value to enter\n@param technicalLocator tag to find (i.e. input)\n@param referencePlace the element to us as a reference to search from\n@param container the container to search in\n@return true if the element was found and the value was sent",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to enter",
"type" : "String"
}, {
"name" : "technicalLocator",
"description" : "tag to find (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "the element to us as a reference to search from",
"type" : "String"
}, {
"name" : "container",
"description" : "the container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as near",
"usage" : "| enter | [value] | as | [technicalLocator] | near | [referencePlace] | ",
"contexthelp" : "enter <value> as <technicalLocator> near <referencePlace>",
"name" : "enterAsNear",
"docString" : "Replace content of given tag, found near (within 50px of) a reference element\n@param value value to enter\n@param technicalLocator tag to find (i.e. input)\n@param referencePlace the element to us as a reference to search from\n@return true if the element was found and the value was sent",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to enter",
"type" : "String"
}, {
"name" : "technicalLocator",
"description" : "tag to find (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "the element to us as a reference to search from",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as near in",
"usage" : "| enter | [value] | as | [technicalLocator] | near | [referencePlace] | in | [container] | ",
"contexthelp" : "enter <value> as <technicalLocator> near <referencePlace> in <container>",
"name" : "enterAsNearIn",
"docString" : "Replace content of given tag, found near (within 50px of) a reference element, in a container\n@param value value to enter\n@param technicalLocator tag to find (i.e. input)\n@param referencePlace the element to us as a reference to search from\n@param container the container to search in\n@return true if the element was found and the value was sent",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to enter",
"type" : "String"
}, {
"name" : "technicalLocator",
"description" : "tag to find (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "the element to us as a reference to search from",
"type" : "String"
}, {
"name" : "container",
"description" : "the container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter relative imp",
"usage" : "| enter relative imp | value, technicalLocator, referencePlace, relativeMethod, container, |",
"contexthelp" : "enter relative imp value, technicalLocator, referencePlace, relativeMethod, container,",
"name" : "enterRelativeImp",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "value",
"type" : "String"
}, {
"name" : "technicalLocator",
"type" : "String"
}, {
"name" : "referencePlace",
"type" : "String"
}, {
"name" : "relativeMethod",
"type" : "RelativeMethod"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as in",
"usage" : "| enter | [value] | as | [place] | in | [container] | ",
"contexthelp" : "enter <value> as <place> in <container>",
"name" : "enterAsIn",
"docString" : "Replaces content at place by value.\n@param value value to set.\n@param place element to set value on.\n@param container element containing place.\n@return true, if element was found.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to set.",
"type" : "String"
}, {
"name" : "place",
"description" : "element to set value on.",
"type" : "String"
}, {
"name" : "container",
"description" : "element containing place.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter for",
"usage" : "| enter | [value] | for | [place] | ",
"contexthelp" : "enter <value> for <place>",
"name" : "enterFor",
"docString" : "Adds content to place.\n@param value value to add.\n@param place element to add value to.\n@return true, if element was found.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to add.",
"type" : "String"
}, {
"name" : "place",
"description" : "element to add value to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter for in",
"usage" : "| enter | [value] | for | [place] | in | [container] | ",
"contexthelp" : "enter <value> for <place> in <container>",
"name" : "enterForIn",
"docString" : "Adds content to place.\n@param value value to add.\n@param place element to add value to.\n@param container element containing place.\n@return true, if element was found.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"description" : "value to add.",
"type" : "String"
}, {
"name" : "place",
"description" : "element to add value to.",
"type" : "String"
}, {
"name" : "container",
"description" : "element containing place.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter date as",
"usage" : "| enter date | [date] | as | [place] | ",
"contexthelp" : "enter date <date> as <place>",
"name" : "enterDateAs",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "date",
"type" : "String"
}, {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "press tab",
"usage" : "| press tab |",
"contexthelp" : "press tab",
"name" : "pressTab",
"docString" : "Simulates pressing the 'Tab' key.\n@return true, if an element was active the key could be sent to.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "press enter",
"usage" : "| press enter |",
"contexthelp" : "press enter",
"name" : "pressEnter",
"docString" : "Simulates pressing the 'Enter' key.\n@return true, if an element was active the key could be sent to.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "press esc",
"usage" : "| press esc |",
"contexthelp" : "press esc",
"name" : "pressEsc",
"docString" : "Simulates pressing the 'Esc' key.\n@return true, if an element was active the key could be sent to.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "type",
"usage" : "| type | [text] | ",
"contexthelp" : "type <text>",
"name" : "type",
"docString" : "Simulates typing a text to the current active element.\n@param text text to type.\n@return true, if an element was active the text could be sent to.",
"annotations" : [ ],
"parameters" : [ {
"name" : "text",
"description" : "text to type.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "press",
"usage" : "| press | [key] | ",
"contexthelp" : "press <key>",
"name" : "press",
"docString" : "Simulates pressing a key (or a combination of keys).\n (Unfortunately not all combinations seem to be accepted by all drivers, e.g.\n Chrome on OSX seems to ignore Command+A or Command+T; https://code.google.com/p/selenium/issues/detail?id=5919).\n@param key key to press, can be a normal letter (e.g. 'M') or a special key (e.g. 'down').\n Combinations can be passed by separating the keys to send with '+' (e.g. Command + T).\n@return true, if an element was active the key could be sent to.",
"annotations" : [ ],
"parameters" : [ {
"name" : "key",
"description" : "key to press, can be a normal letter (e.g. 'M') or a special key (e.g. 'down').\n Combinations can be passed by separating the keys to send with '+' (e.g. Command + T).",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "select as",
"usage" : "| select | [value] | as | [place] | ",
"contexthelp" : "select <value> as <place>",
"name" : "selectAs",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"type" : "String"
}, {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "select as in",
"usage" : "| select | [value] | as | [place] | in | [container] | ",
"contexthelp" : "select <value> as <place> in <container>",
"name" : "selectAsIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"type" : "String"
}, {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "select for",
"usage" : "| select | [value] | for | [place] | ",
"contexthelp" : "select <value> for <place>",
"name" : "selectFor",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"type" : "String"
}, {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "select for in",
"usage" : "| select | [value] | for | [place] | in | [container] | ",
"contexthelp" : "select <value> for <place> in <container>",
"name" : "selectForIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"type" : "String"
}, {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter for hidden",
"usage" : "| enter for | [value] | hidden | [idOrName] | ",
"contexthelp" : "enter for <value> hidden <idOrName>",
"name" : "enterForHidden",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"type" : "String"
}, {
"name" : "idOrName",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click",
"usage" : "| click | [place] | ",
"contexthelp" : "click <place>",
"name" : "click",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click at offset xy",
"usage" : "| click at | [place] | offset | [xOffset] | xy | [yOffset] | ",
"contexthelp" : "click at <place> offset <xOffset> xy <yOffset>",
"name" : "clickAtOffsetXY",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "xOffset",
"type" : "Integer"
}, {
"name" : "yOffset",
"type" : "Integer"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "double click at offset xy",
"usage" : "| double click at | [place] | offset | [xOffset] | xy | [yOffset] | ",
"contexthelp" : "double click at <place> offset <xOffset> xy <yOffset>",
"name" : "doubleClickAtOffsetXY",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "xOffset",
"type" : "Integer"
}, {
"name" : "yOffset",
"type" : "Integer"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "right click at offset xy",
"usage" : "| right click at | [place] | offset | [xOffset] | xy | [yOffset] | ",
"contexthelp" : "right click at <place> offset <xOffset> xy <yOffset>",
"name" : "rightClickAtOffsetXY",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "xOffset",
"type" : "Integer"
}, {
"name" : "yOffset",
"type" : "Integer"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "drag and drop to offset xy",
"usage" : "| drag and drop to | [place] | offset | [xOffset] | xy | [yOffset] | ",
"contexthelp" : "drag and drop to <place> offset <xOffset> xy <yOffset>",
"name" : "dragAndDropToOffsetXY",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "xOffset",
"type" : "Integer"
}, {
"name" : "yOffset",
"type" : "Integer"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "click if available",
"usage" : "| click if available | [place] | ",
"contexthelp" : "click if available <place>",
"name" : "clickIfAvailable",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click if available in",
"usage" : "| click if available | [place] | in | [container] | ",
"contexthelp" : "click if available <place> in <container>",
"name" : "clickIfAvailableIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click in",
"usage" : "| click | [place] | in | [container] | ",
"contexthelp" : "click <place> in <container>",
"name" : "clickIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click below",
"usage" : "| click | [technicalLocator] | below | [referencePlace] | ",
"contexthelp" : "click <technicalLocator> below <referencePlace>",
"name" : "clickBelow",
"docString" : "Click an element found by it's technicalLocator, below its reference place\n@param technicalLocator The technicalLocator to look for (i.e. css=input)\n@param referencePlace The element to use as a reference\n@return true if the element was found and clicked",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. css=input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click below in",
"usage" : "| click | [technicalLocator] | below | [referencePlace] | in | [container] | ",
"contexthelp" : "click <technicalLocator> below <referencePlace> in <container>",
"name" : "clickBelowIn",
"docString" : "Click an element found by it's technicalLocator, below its reference place, in a container\n@param technicalLocator The technicalLocator to look for (i.e. css=input)\n@param referencePlace The element to use as a reference\n@param container A reference to the container to search in\n@return true if the element was found and clicked",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. css=input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
}, {
"name" : "container",
"description" : "A reference to the container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click above",
"usage" : "| click | [technicalLocator] | above | [referencePlace] | ",
"contexthelp" : "click <technicalLocator> above <referencePlace>",
"name" : "clickAbove",
"docString" : "Click an element found by it's technicalLocator name, above its reference place\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@return true if the element was found and clicked",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click above in",
"usage" : "| click | [technicalLocator] | above | [referencePlace] | in | [container] | ",
"contexthelp" : "click <technicalLocator> above <referencePlace> in <container>",
"name" : "clickAboveIn",
"docString" : "Click an element found by it's technicalLocator name, above its reference place, in a container\n@param technicalLocator The technicalLocator to look for (i.e. css=input)\n@param referencePlace The element to use as a reference\n@param container A reference to the container to search in\n@return true if the element was found and clicked",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. css=input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
}, {
"name" : "container",
"description" : "A reference to the container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click right of",
"usage" : "| click | [technicalLocator] | right of | [referencePlace] |",
"contexthelp" : "click <technicalLocator> right of <referencePlace>",
"name" : "clickRightOf",
"docString" : "Click an element found by it's technicalLocator name, left of its reference place\n Usage: | click | [technicalLocator] | right of | [referencePlace] |\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@return true if the element was found and clicked",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click right of in",
"usage" : "| click | [technicalLocator] | right of | [referencePlace] | in | [container] |",
"contexthelp" : "click <technicalLocator> right of <referencePlace> in <container>",
"name" : "clickRightOfIn",
"docString" : "Click an element found by it's technicalLocator name, left of its reference place, in a container\n Usage: | click | [technicalLocator] | right of | [referencePlace] | in | [container] |\n@param technicalLocator The technicalLocator to look for (i.e. css= input)\n@param referencePlace The element to use as a reference\n@param container A reference to the container to search in\n@return true if the element was found and clicked",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. css= input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
}, {
"name" : "container",
"description" : "A reference to the container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click left of",
"usage" : "| click | [technicalLocator] | left of | [referencePlace] |",
"contexthelp" : "click <technicalLocator> left of <referencePlace>",
"name" : "clickLeftOf",
"docString" : "Click an element found by it's technicalLocator name, right of its reference place\n Usage: | click | [technicalLocator] | left of | [referencePlace] |\n@param technicalLocator The technicalLocator to look for (i.e. css=input)\n@param referencePlace The element to use as a reference\n@return true if the element was found and clicked",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. css=input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click left of in",
"usage" : "| click | [technicalLocator] | left of | [referencePlace] | in | [container] |",
"contexthelp" : "click <technicalLocator> left of <referencePlace> in <container>",
"name" : "clickLeftOfIn",
"docString" : "Click an element found by it's technicalLocator name, right of its reference place, in a container\n Usage: | click | [technicalLocator] | left of | [referencePlace] | in | [container] |\n@param technicalLocator The technicalLocator to look for (i.e. css=input)\n@param referencePlace The element to use as a reference\n@param container A reference to the container to search in\n@return true if the element was found and clicked",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. css=input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
}, {
"name" : "container",
"description" : "A reference to the container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click near",
"usage" : "| click | [technicalLocator] | near | [referencePlace] | ",
"contexthelp" : "click <technicalLocator> near <referencePlace>",
"name" : "clickNear",
"docString" : "Click an element found by it's technicalLocator name, near (within 50px of) its reference place\n@param technicalLocator The technicalLocator to look for (i.e. css=input)\n@param referencePlace The element to use as a reference\n@return true if the element was found and clicked",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. css=input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click near in",
"usage" : "| click | [technicalLocator] | near | [referencePlace] | in | [container] | ",
"contexthelp" : "click <technicalLocator> near <referencePlace> in <container>",
"name" : "clickNearIn",
"docString" : "Click an element found by it's technicalLocator name, near (within 50px of) its reference place, in a container\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@param container A reference to the container to search in\n@return true if the element was found and clicked",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
}, {
"name" : "container",
"description" : "A reference to the container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "double click",
"usage" : "| double click | [place] | ",
"contexthelp" : "double click <place>",
"name" : "doubleClick",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "double click in",
"usage" : "| double click | [place] | in | [container] | ",
"contexthelp" : "double click <place> in <container>",
"name" : "doubleClickIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "right click",
"usage" : "| right click | [place] | ",
"contexthelp" : "right click <place>",
"name" : "rightClick",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "right click in",
"usage" : "| right click | [place] | in | [container] | ",
"contexthelp" : "right click <place> in <container>",
"name" : "rightClickIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "shift click",
"usage" : "| shift click | [place] | ",
"contexthelp" : "shift click <place>",
"name" : "shiftClick",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "shift click in",
"usage" : "| shift click | [place] | in | [container] | ",
"contexthelp" : "shift click <place> in <container>",
"name" : "shiftClickIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "control click",
"usage" : "| control click | [place] | ",
"contexthelp" : "control click <place>",
"name" : "controlClick",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "control click in",
"usage" : "| control click | [place] | in | [container] | ",
"contexthelp" : "control click <place> in <container>",
"name" : "controlClickIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set send command for control on mac to",
"usage" : "| set send command for control on mac to | [sendCommand] | ",
"contexthelp" : "set send command for control on mac to <sendCommand>",
"name" : "setSendCommandForControlOnMacTo",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "sendCommand",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "send command for control on mac",
"usage" : "| send command for control on mac |",
"contexthelp" : "send command for control on mac",
"name" : "sendCommandForControlOnMac",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set drag distance",
"usage" : "| set drag distance | [dragDistance] | ",
"contexthelp" : "set drag distance <dragDistance>",
"name" : "setDragDistance",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "dragDistance",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set drag press delay",
"usage" : "| set drag press delay | [dragPressDelay] | ",
"contexthelp" : "set drag press delay <dragPressDelay>",
"name" : "setDragPressDelay",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "dragPressDelay",
"type" : "long"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "clear drag setup",
"usage" : "| clear drag setup |",
"contexthelp" : "clear drag setup",
"name" : "clearDragSetup",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "drag and drop to",
"usage" : "| drag and drop | [source] | to | [destination] | ",
"contexthelp" : "drag and drop <source> to <destination>",
"name" : "dragAndDropTo",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "source",
"type" : "String"
}, {
"name" : "destination",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "html 5 drag and drop to",
"usage" : "| html 5 drag and drop | [source] | to | [destination] | ",
"contexthelp" : "html 5 drag and drop <source> to <destination>",
"name" : "html5DragAndDropTo",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "source",
"type" : "String"
}, {
"name" : "destination",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set search context to",
"usage" : "| set search context to | [container] | ",
"contexthelp" : "set search context to <container>",
"name" : "setSearchContextTo",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "clear search context",
"usage" : "| clear search context |",
"contexthelp" : "clear search context",
"name" : "clearSearchContext",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "wait for page",
"usage" : "| wait for page | [pageName] | ",
"contexthelp" : "wait for page <pageName>",
"name" : "waitForPage",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "pageName",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait for tag with text",
"usage" : "| wait for tag with | [tagName] | text | [expectedText] | ",
"contexthelp" : "wait for tag with <tagName> text <expectedText>",
"name" : "waitForTagWithText",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "tagName",
"type" : "String"
}, {
"name" : "expectedText",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait for class with text",
"usage" : "| wait for class with | [cssClassName] | text | [expectedText] | ",
"contexthelp" : "wait for class with <cssClassName> text <expectedText>",
"name" : "waitForClassWithText",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "cssClassName",
"type" : "String"
}, {
"name" : "expectedText",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait for class",
"usage" : "| wait for class | [cssClassName] | ",
"contexthelp" : "wait for class <cssClassName>",
"name" : "waitForClass",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "cssClassName",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait for visible",
"usage" : "| wait for visible | [place] | ",
"contexthelp" : "wait for visible <place>",
"name" : "waitForVisible",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait for visible in",
"usage" : "| wait for visible | [place] | in | [container] | ",
"contexthelp" : "wait for visible <place> in <container>",
"name" : "waitForVisibleIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait for x path visible",
"usage" : "| wait for x path visible | [xPath] | ",
"contexthelp" : "wait for x path visible <xPath>",
"name" : "waitForXPathVisible",
"docString" : "@deprecated use #waitForVisible(xpath=) instead",
"annotations" : [ "Deprecated" ],
"parameters" : [ {
"name" : "xPath",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "value of",
"usage" : "| value of | [place] | ",
"contexthelp" : "value of <place>",
"name" : "valueOf",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of left of",
"usage" : "| value of | [technicalLocator] | left of | [referencePlace] |",
"contexthelp" : "value of <technicalLocator> left of <referencePlace>",
"name" : "valueOfLeftOf",
"docString" : "Get the value of an element found by it's technicalLocator, to the left of its reference place\n Usage: | value of | [technicalLocator] | left of | [referencePlace] |\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@return the value of the element if found",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of left of in",
"usage" : "| value of | [technicalLocator] | left of | [referencePlace] | in | [container] |",
"contexthelp" : "value of <technicalLocator> left of <referencePlace> in <container>",
"name" : "valueOfLeftOfIn",
"docString" : "Get the value of an element found by it's technicalLocator, to the left of its reference place, in a container\n Usage: | value of | [technicalLocator] | left of | [referencePlace] | in | [container] |\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@param container The container to search inside of\n@return the value of the element if found",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
}, {
"name" : "container",
"description" : "The container to search inside of",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of right of",
"usage" : "| value of | [technicalLocator] | right of | [referencePlace] |",
"contexthelp" : "value of <technicalLocator> right of <referencePlace>",
"name" : "valueOfRightOf",
"docString" : "Get the value of an element found by it's technicalLocator, to the right of its reference place\n Usage: | value of | [technicalLocator] | right of | [referencePlace] |\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@return the value of the element if found",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of right of in",
"usage" : "| value of | [technicalLocator] | right of | [referencePlace] | in | [container] |",
"contexthelp" : "value of <technicalLocator> right of <referencePlace> in <container>",
"name" : "valueOfRightOfIn",
"docString" : "Get the value of an element found by it's technicalLocator, to the right of its reference place, in a container\n Usage: | value of | [technicalLocator] | right of | [referencePlace] | in | [container] |\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@param container The container to search inside of\n@return the value of the element if found",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
}, {
"name" : "container",
"description" : "The container to search inside of",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of above",
"usage" : "| value of | [technicalLocator] | above | [referencePlace] | ",
"contexthelp" : "value of <technicalLocator> above <referencePlace>",
"name" : "valueOfAbove",
"docString" : "Get the value of an element found by it's technicalLocator, above its reference place\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@return the value of the element if found",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of above in",
"usage" : "| value of | [technicalLocator] | above | [referencePlace] | in | [container] | ",
"contexthelp" : "value of <technicalLocator> above <referencePlace> in <container>",
"name" : "valueOfAboveIn",
"docString" : "Get the value of an element found by it's technicalLocator, above its reference place, in a container\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@param container The container to search in\n@return the value of the element if found",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
}, {
"name" : "container",
"description" : "The container to search in",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of below",
"usage" : "| value of | [technicalLocator] | below | [referencePlace] | ",
"contexthelp" : "value of <technicalLocator> below <referencePlace>",
"name" : "valueOfBelow",
"docString" : "Get the value of an element found by it's technicalLocator, below its reference place\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@return the value of the element if found",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of below in",
"usage" : "| value of | [technicalLocator] | below | [referencePlace] | in | [container] | ",
"contexthelp" : "value of <technicalLocator> below <referencePlace> in <container>",
"name" : "valueOfBelowIn",
"docString" : "Get the value of an element found by it's technicalLocator, below its reference place, in a container\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@param container The container to search inside of\n@return the value of the element if found",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
}, {
"name" : "container",
"description" : "The container to search inside of",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of near",
"usage" : "| value of | [technicalLocator] | near | [referencePlace] | ",
"contexthelp" : "value of <technicalLocator> near <referencePlace>",
"name" : "valueOfNear",
"docString" : "Get the value of an element found by it's technicalLocator, near (within 50px of) its reference place\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@return the value of the element if found",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of near in",
"usage" : "| value of | [technicalLocator] | near | [referencePlace] | in | [container] | ",
"contexthelp" : "value of <technicalLocator> near <referencePlace> in <container>",
"name" : "valueOfNearIn",
"docString" : "Get the value of an element found by it's technicalLocator, near (within 50px of) its reference place, in a container\n@param technicalLocator The technicalLocator to look for (i.e. input)\n@param referencePlace The element to use as a reference\n@param container The container to search inside of\n@return the value of the element if found",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "technicalLocator",
"description" : "The technicalLocator to look for (i.e. input)",
"type" : "String"
}, {
"name" : "referencePlace",
"description" : "The element to use as a reference",
"type" : "String"
}, {
"name" : "container",
"description" : "The container to search inside of",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value for",
"usage" : "| value for | [place] | ",
"contexthelp" : "value for <place>",
"name" : "valueFor",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of in",
"usage" : "| value of | [place] | in | [container] | ",
"contexthelp" : "value of <place> in <container>",
"name" : "valueOfIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value for in",
"usage" : "| value for | [place] | in | [container] | ",
"contexthelp" : "value for <place> in <container>",
"name" : "valueForIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "normalized value of",
"usage" : "| normalized value of | [place] | ",
"contexthelp" : "normalized value of <place>",
"name" : "normalizedValueOf",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "normalized value for",
"usage" : "| normalized value for | [place] | ",
"contexthelp" : "normalized value for <place>",
"name" : "normalizedValueFor",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "normalized value of in",
"usage" : "| normalized value of | [place] | in | [container] | ",
"contexthelp" : "normalized value of <place> in <container>",
"name" : "normalizedValueOfIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "normalized value for in",
"usage" : "| normalized value for | [place] | in | [container] | ",
"contexthelp" : "normalized value for <place> in <container>",
"name" : "normalizedValueForIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "tooltip for",
"usage" : "| tooltip for | [place] | ",
"contexthelp" : "tooltip for <place>",
"name" : "tooltipFor",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "tooltip for in",
"usage" : "| tooltip for | [place] | in | [container] | ",
"contexthelp" : "tooltip for <place> in <container>",
"name" : "tooltipForIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "target of link",
"usage" : "| target of link | [place] | ",
"contexthelp" : "target of link <place>",
"name" : "targetOfLink",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of attribute on",
"usage" : "| value of attribute | [attribute] | on | [place] | ",
"contexthelp" : "value of attribute <attribute> on <place>",
"name" : "valueOfAttributeOn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "attribute",
"type" : "String"
}, {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of attribute on in",
"usage" : "| value of attribute | [attribute] | on | [place] | in | [container] | ",
"contexthelp" : "value of attribute <attribute> on <place> in <container>",
"name" : "valueOfAttributeOnIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "attribute",
"type" : "String"
}, {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "values of",
"usage" : "| values of | [place] | ",
"contexthelp" : "values of <place>",
"name" : "valuesOf",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "values of in",
"usage" : "| values of | [place] | in | [container] | ",
"contexthelp" : "values of <place> in <container>",
"name" : "valuesOfIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "values for",
"usage" : "| values for | [place] | ",
"contexthelp" : "values for <place>",
"name" : "valuesFor",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "values for in",
"usage" : "| values for | [place] | in | [container] | ",
"contexthelp" : "values for <place> in <container>",
"name" : "valuesForIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "normalized values of",
"usage" : "| normalized values of | [place] | ",
"contexthelp" : "normalized values of <place>",
"name" : "normalizedValuesOf",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "normalized values of in",
"usage" : "| normalized values of | [place] | in | [container] | ",
"contexthelp" : "normalized values of <place> in <container>",
"name" : "normalizedValuesOfIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "normalized values for",
"usage" : "| normalized values for | [place] | ",
"contexthelp" : "normalized values for <place>",
"name" : "normalizedValuesFor",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "normalized values for in",
"usage" : "| normalized values for | [place] | in | [container] | ",
"contexthelp" : "normalized values for <place> in <container>",
"name" : "normalizedValuesForIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "number for",
"usage" : "| number for | [place] | ",
"contexthelp" : "number for <place>",
"name" : "numberFor",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Integer"
}, {
"readableName" : "number for in",
"usage" : "| number for | [place] | in | [container] | ",
"contexthelp" : "number for <place> in <container>",
"name" : "numberForIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Integer"
}, {
"readableName" : "available options for",
"usage" : "| available options for | [place] | ",
"contexthelp" : "available options for <place>",
"name" : "availableOptionsFor",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "normalized available options for",
"usage" : "| normalized available options for | [place] | ",
"contexthelp" : "normalized available options for <place>",
"name" : "normalizedAvailableOptionsFor",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "ArrayList<String>"
}, {
"readableName" : "clear",
"usage" : "| clear | [place] | ",
"contexthelp" : "clear <place>",
"name" : "clear",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "clear in",
"usage" : "| clear | [place] | in | [container] | ",
"contexthelp" : "clear <place> in <container>",
"name" : "clearIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "enter as in row where is",
"usage" : "| enter as in | [value] | row | [requestedColumnName] | where | [selectOnColumn] | is | [selectOnValue] | ",
"contexthelp" : "enter as in <value> row <requestedColumnName> where <selectOnColumn> is <selectOnValue>",
"name" : "enterAsInRowWhereIs",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "value",
"type" : "String"
}, {
"name" : "requestedColumnName",
"type" : "String"
}, {
"name" : "selectOnColumn",
"type" : "String"
}, {
"name" : "selectOnValue",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "value of column number in row number",
"usage" : "| value of column number in row | [columnIndex] | number | [rowIndex] | ",
"contexthelp" : "value of column number in row <columnIndex> number <rowIndex>",
"name" : "valueOfColumnNumberInRowNumber",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "columnIndex",
"type" : "int"
}, {
"name" : "rowIndex",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of in row number",
"usage" : "| value of in row | [requestedColumnName] | number | [rowIndex] | ",
"contexthelp" : "value of in row <requestedColumnName> number <rowIndex>",
"name" : "valueOfInRowNumber",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "requestedColumnName",
"type" : "String"
}, {
"name" : "rowIndex",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "value of in row where is",
"usage" : "| value of in row | [requestedColumnName] | where | [selectOnColumn] | is | [selectOnValue] | ",
"contexthelp" : "value of in row <requestedColumnName> where <selectOnColumn> is <selectOnValue>",
"name" : "valueOfInRowWhereIs",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "requestedColumnName",
"type" : "String"
}, {
"name" : "selectOnColumn",
"type" : "String"
}, {
"name" : "selectOnValue",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "normalized value of column number in row number",
"usage" : "| normalized value of column number in row | [columnIndex] | number | [rowIndex] | ",
"contexthelp" : "normalized value of column number in row <columnIndex> number <rowIndex>",
"name" : "normalizedValueOfColumnNumberInRowNumber",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "columnIndex",
"type" : "int"
}, {
"name" : "rowIndex",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "normalized value of in row number",
"usage" : "| normalized value of in row | [requestedColumnName] | number | [rowIndex] | ",
"contexthelp" : "normalized value of in row <requestedColumnName> number <rowIndex>",
"name" : "normalizedValueOfInRowNumber",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "requestedColumnName",
"type" : "String"
}, {
"name" : "rowIndex",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "normalized value of in row where is",
"usage" : "| normalized value of in row | [requestedColumnName] | where | [selectOnColumn] | is | [selectOnValue] | ",
"contexthelp" : "normalized value of in row <requestedColumnName> where <selectOnColumn> is <selectOnValue>",
"name" : "normalizedValueOfInRowWhereIs",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "requestedColumnName",
"type" : "String"
}, {
"name" : "selectOnColumn",
"type" : "String"
}, {
"name" : "selectOnValue",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "row exists where is",
"usage" : "| row exists where | [selectOnColumn] | is | [selectOnValue] | ",
"contexthelp" : "row exists where <selectOnColumn> is <selectOnValue>",
"name" : "rowExistsWhereIs",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "selectOnColumn",
"type" : "String"
}, {
"name" : "selectOnValue",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click in row number",
"usage" : "| click in row | [place] | number | [rowIndex] | ",
"contexthelp" : "click in row <place> number <rowIndex>",
"name" : "clickInRowNumber",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "rowIndex",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click in row where is",
"usage" : "| click in row | [place] | where | [selectOnColumn] | is | [selectOnValue] | ",
"contexthelp" : "click in row <place> where <selectOnColumn> is <selectOnValue>",
"name" : "clickInRowWhereIs",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "selectOnColumn",
"type" : "String"
}, {
"name" : "selectOnValue",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "download from row number",
"usage" : "| download from row | [place] | number | [rowNumber] | ",
"contexthelp" : "download from row <place> number <rowNumber>",
"name" : "downloadFromRowNumber",
"docString" : "Downloads the target of a link in a grid's row.\n@param place which link to download.\n@param rowNumber (1-based) row number to retrieve link from.\n@return downloaded file if any, null otherwise.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "which link to download.",
"type" : "String"
}, {
"name" : "rowNumber",
"description" : "(1-based) row number to retrieve link from.",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "download from row where is",
"usage" : "| download from row | [place] | where | [selectOnColumn] | is | [selectOnValue] | ",
"contexthelp" : "download from row <place> where <selectOnColumn> is <selectOnValue>",
"name" : "downloadFromRowWhereIs",
"docString" : "Downloads the target of a link in a grid, finding the row based on one of the other columns' value.\n@param place which link to download.\n@param selectOnColumn column header of cell whose value must be selectOnValue.\n@param selectOnValue value to be present in selectOnColumn to find correct row.\n@return downloaded file if any, null otherwise.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "which link to download.",
"type" : "String"
}, {
"name" : "selectOnColumn",
"description" : "column header of cell whose value must be selectOnValue.",
"type" : "String"
}, {
"name" : "selectOnValue",
"description" : "value to be present in selectOnColumn to find correct row.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "click by x path",
"usage" : "| click by x path | [xPath] | ",
"contexthelp" : "click by x path <xPath>",
"name" : "clickByXPath",
"docString" : "@deprecated use #click(xpath=) instead.",
"annotations" : [ "WaitUntil", "Deprecated" ],
"parameters" : [ {
"name" : "xPath",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "text by x path",
"usage" : "| text by x path | [xPath] | ",
"contexthelp" : "text by x path <xPath>",
"name" : "textByXPath",
"docString" : "@deprecated use #valueOf(xpath=) instead.",
"annotations" : [ "WaitUntil", "Deprecated" ],
"parameters" : [ {
"name" : "xPath",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "text by class name",
"usage" : "| text by class name | [className] | ",
"contexthelp" : "text by class name <className>",
"name" : "textByClassName",
"docString" : "@deprecated use #valueOf(css=.) instead.",
"annotations" : [ "WaitUntil", "Deprecated" ],
"parameters" : [ {
"name" : "className",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "wait milli second after scroll",
"usage" : "| wait milli second after scroll | [msToWait] | ",
"contexthelp" : "wait milli second after scroll <msToWait>",
"name" : "waitMilliSecondAfterScroll",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "msToWait",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "scroll to",
"usage" : "| scroll to | [place] | ",
"contexthelp" : "scroll to <place>",
"name" : "scrollTo",
"docString" : "Scrolls browser window so top of place becomes visible.\n@param place element to scroll to.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to scroll to.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "scroll to in",
"usage" : "| scroll to | [place] | in | [container] | ",
"contexthelp" : "scroll to <place> in <container>",
"name" : "scrollToIn",
"docString" : "Scrolls browser window so top of place becomes visible.\n@param place element to scroll to.\n@param container parent of place.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to scroll to.",
"type" : "String"
}, {
"name" : "container",
"description" : "parent of place.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is enabled",
"usage" : "| is enabled | [place] | ",
"contexthelp" : "is enabled <place>",
"name" : "isEnabled",
"docString" : "Determines whether element is enabled (i.e. can be clicked).\n@param place element to check.\n@return true if element is enabled.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is enabled in",
"usage" : "| is enabled | [place] | in | [container] | ",
"contexthelp" : "is enabled <place> in <container>",
"name" : "isEnabledIn",
"docString" : "Determines whether element is enabled (i.e. can be clicked).\n@param place element to check.\n@param container parent of place.\n@return true if element is enabled.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
}, {
"name" : "container",
"description" : "parent of place.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is disabled",
"usage" : "| is disabled | [place] | ",
"contexthelp" : "is disabled <place>",
"name" : "isDisabled",
"docString" : "Determines whether element is NOT enabled (i.e. can not be clicked).\n@param place element to check.\n@return true if element is disabled.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is disabled in",
"usage" : "| is disabled | [place] | in | [container] | ",
"contexthelp" : "is disabled <place> in <container>",
"name" : "isDisabledIn",
"docString" : "Determines whether element is NOT enabled (i.e. can not be clicked).\n@param place element to check.\n@param container parent of place.\n@return true if element is disabled.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
}, {
"name" : "container",
"description" : "parent of place.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is visible",
"usage" : "| is visible | [place] | ",
"contexthelp" : "is visible <place>",
"name" : "isVisible",
"docString" : "Determines whether element can be see in browser's window.\n@param place element to check.\n@return true if element is displayed and in viewport.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is visible in",
"usage" : "| is visible | [place] | in | [container] | ",
"contexthelp" : "is visible <place> in <container>",
"name" : "isVisibleIn",
"docString" : "Determines whether element can be see in browser's window.\n@param place element to check.\n@param container parent of place.\n@return true if element is displayed and in viewport.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
}, {
"name" : "container",
"description" : "parent of place.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is visible on page",
"usage" : "| is visible on page | [place] | ",
"contexthelp" : "is visible on page <place>",
"name" : "isVisibleOnPage",
"docString" : "Determines whether element is somewhere in browser's window.\n@param place element to check.\n@return true if element is displayed.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is visible on page in",
"usage" : "| is visible on page | [place] | in | [container] | ",
"contexthelp" : "is visible on page <place> in <container>",
"name" : "isVisibleOnPageIn",
"docString" : "Determines whether element is somewhere in browser's window.\n@param place element to check.\n@param container parent of place.\n@return true if element is displayed.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
}, {
"name" : "container",
"description" : "parent of place.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is not visible",
"usage" : "| is not visible | [place] | ",
"contexthelp" : "is not visible <place>",
"name" : "isNotVisible",
"docString" : "Determines whether element is not visible (or disappears within the specified timeout)\n@param place element to check\n@return true if the element is not displayed (anymore)",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is not visible in",
"usage" : "| is not visible | [place] | in | [container] | ",
"contexthelp" : "is not visible <place> in <container>",
"name" : "isNotVisibleIn",
"docString" : "Determines whether element is not visible (or disappears within the specified timeout)\n@param place element to check.\n@param container parent of place.\n@return true if the element is not displayed (anymore)",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
}, {
"name" : "container",
"description" : "parent of place.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is not visible on page",
"usage" : "| is not visible on page | [place] | ",
"contexthelp" : "is not visible on page <place>",
"name" : "isNotVisibleOnPage",
"docString" : "Determines whether element is not on the page (or disappears within the specified timeout)\n@param place element to check.\n@return true if element is not on the page (anymore).",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "is not visible on page in",
"usage" : "| is not visible on page | [place] | in | [container] | ",
"contexthelp" : "is not visible on page <place> in <container>",
"name" : "isNotVisibleOnPageIn",
"docString" : "Determines whether element is not on the page (or disappears within the specified timeout)\n@param place element to check.\n@param container parent of place.\n@return true if the element is not on the page (anymore)",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "element to check.",
"type" : "String"
}, {
"name" : "container",
"description" : "parent of place.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "number of times is visible",
"usage" : "| number of times is visible | [text] | ",
"contexthelp" : "number of times is visible <text>",
"name" : "numberOfTimesIsVisible",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "text",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "number of times is visible on page",
"usage" : "| number of times is visible on page | [text] | ",
"contexthelp" : "number of times is visible on page <text>",
"name" : "numberOfTimesIsVisibleOnPage",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "text",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "number of times is visible in",
"usage" : "| number of times is visible | [text] | in | [container] | ",
"contexthelp" : "number of times is visible <text> in <container>",
"name" : "numberOfTimesIsVisibleIn",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "text",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "number of times is visible on page in",
"usage" : "| number of times is visible on page | [text] | in | [container] | ",
"contexthelp" : "number of times is visible on page <text> in <container>",
"name" : "numberOfTimesIsVisibleOnPageIn",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "text",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "hover over",
"usage" : "| hover over | [place] | ",
"contexthelp" : "hover over <place>",
"name" : "hoverOver",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "hover over in",
"usage" : "| hover over | [place] | in | [container] | ",
"contexthelp" : "hover over <place> in <container>",
"name" : "hoverOverIn",
"docString" : "",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "container",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "seconds before timeout",
"usage" : "| seconds before timeout | [timeout] | ",
"contexthelp" : "seconds before timeout <timeout>",
"name" : "secondsBeforeTimeout",
"docString" : "@param timeout number of seconds before waitUntil() and waitForJavascriptCallback() throw TimeOutException.",
"annotations" : [ ],
"parameters" : [ {
"name" : "timeout",
"description" : "number of seconds before waitUntil() and waitForJavascriptCallback() throw TimeOutException.",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "seconds before timeout",
"usage" : "| seconds before timeout |",
"contexthelp" : "seconds before timeout",
"name" : "secondsBeforeTimeout",
"docString" : "@return number of seconds waitUntil() will wait at most.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "seconds before page load timeout",
"usage" : "| seconds before page load timeout | [timeout] | ",
"contexthelp" : "seconds before page load timeout <timeout>",
"name" : "secondsBeforePageLoadTimeout",
"docString" : "@param timeout number of seconds before waiting for a new page to load will throw a TimeOutException.",
"annotations" : [ ],
"parameters" : [ {
"name" : "timeout",
"description" : "number of seconds before waiting for a new page to load will throw a TimeOutException.",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "seconds before page load timeout",
"usage" : "| seconds before page load timeout |",
"contexthelp" : "seconds before page load timeout",
"name" : "secondsBeforePageLoadTimeout",
"docString" : "@return number of seconds Selenium will wait at most for a request to load a page.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "clear session storage",
"usage" : "| clear session storage |",
"contexthelp" : "clear session storage",
"name" : "clearSessionStorage",
"docString" : "Clears HTML5's sessionStorage (for the domain of the current open page in the browser).",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "clear local storage",
"usage" : "| clear local storage |",
"contexthelp" : "clear local storage",
"name" : "clearLocalStorage",
"docString" : "Clears HTML5's localStorage (for the domain of the current open page in the browser).",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "delete all cookies",
"usage" : "| delete all cookies |",
"contexthelp" : "delete all cookies",
"name" : "deleteAllCookies",
"docString" : "Deletes all cookies(for the domain of the current open page in the browser).",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "screenshot base directory",
"usage" : "| screenshot base directory | [directory] | ",
"contexthelp" : "screenshot base directory <directory>",
"name" : "screenshotBaseDirectory",
"docString" : "@param directory sets base directory where screenshots will be stored.",
"annotations" : [ ],
"parameters" : [ {
"name" : "directory",
"description" : "sets base directory where screenshots will be stored.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "screenshot show height",
"usage" : "| screenshot show height | [height] | ",
"contexthelp" : "screenshot show height <height>",
"name" : "screenshotShowHeight",
"docString" : "@param height height to use to display screenshot images",
"annotations" : [ ],
"parameters" : [ {
"name" : "height",
"description" : "height to use to display screenshot images",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "page source",
"usage" : "| page source |",
"contexthelp" : "page source",
"name" : "pageSource",
"docString" : "@return (escaped) HTML content of current page.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "save page source",
"usage" : "| save page source |",
"contexthelp" : "save page source",
"name" : "savePageSource",
"docString" : "Saves current page's source to the wiki'f files section and returns a link to the\n created file.\n@return hyperlink to the file containing the page source.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "take screenshot",
"usage" : "| take screenshot | [basename] | ",
"contexthelp" : "take screenshot <basename>",
"name" : "takeScreenshot",
"docString" : "Takes screenshot from current page\n@param basename filename (below screenshot base directory).\n@return location of screenshot.",
"annotations" : [ ],
"parameters" : [ {
"name" : "basename",
"description" : "filename (below screenshot base directory).",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "take screenshot of",
"usage" : "| take screenshot | [basename] | of | [place] | ",
"contexthelp" : "take screenshot <basename> of <place>",
"name" : "takeScreenshotOf",
"docString" : "Take a screenshot and crop it to the provided element\n@param basename filename (below screenshot base directory).\n@param place The element to crop the screenshot image to\n@return location of the captured image",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "basename",
"description" : "filename (below screenshot base directory).",
"type" : "String"
}, {
"name" : "place",
"description" : "The element to crop the screenshot image to",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "take screenshot of in",
"usage" : "| take screenshot | [basename] | of | [place] | in | [container] | ",
"contexthelp" : "take screenshot <basename> of <place> in <container>",
"name" : "takeScreenshotOfIn",
"docString" : "Take a screenshot and crop it to the provided element\n@param basename filename (below screenshot base directory).\n@param place The element to crop the screenshot image to.\n@param container the elemnt to limit the search context to, when searching for place.\n@return location of the captured image",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "basename",
"description" : "filename (below screenshot base directory).",
"type" : "String"
}, {
"name" : "place",
"description" : "The element to crop the screenshot image to.",
"type" : "String"
}, {
"name" : "container",
"description" : "the elemnt to limit the search context to, when searching for place.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "refresh search context",
"usage" : "| refresh search context |",
"contexthelp" : "refresh search context",
"name" : "refreshSearchContext",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "current browser width",
"usage" : "| current browser width |",
"contexthelp" : "current browser width",
"name" : "currentBrowserWidth",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "current browser height",
"usage" : "| current browser height |",
"contexthelp" : "current browser height",
"name" : "currentBrowserHeight",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "set browser width",
"usage" : "| set browser width | [newWidth] | ",
"contexthelp" : "set browser width <newWidth>",
"name" : "setBrowserWidth",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "newWidth",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set browser height",
"usage" : "| set browser height | [newHeight] | ",
"contexthelp" : "set browser height <newHeight>",
"name" : "setBrowserHeight",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "newHeight",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set browser size to by",
"usage" : "| set browser size to | [newWidth] | by | [newHeight] | ",
"contexthelp" : "set browser size to <newWidth> by <newHeight>",
"name" : "setBrowserSizeToBy",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "newWidth",
"type" : "int"
}, {
"name" : "newHeight",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set browser size to maximum",
"usage" : "| set browser size to maximum |",
"contexthelp" : "set browser size to maximum",
"name" : "setBrowserSizeToMaximum",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "download",
"usage" : "| download | [place] | ",
"contexthelp" : "download <place>",
"name" : "download",
"docString" : "Downloads the target of the supplied link.\n@param place link to follow.\n@return downloaded file if any, null otherwise.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "link to follow.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "download in",
"usage" : "| download | [place] | in | [container] | ",
"contexthelp" : "download <place> in <container>",
"name" : "downloadIn",
"docString" : "Downloads the target of the supplied link.\n@param place link to follow.\n@param container part of screen containing link.\n@return downloaded file if any, null otherwise.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "place",
"description" : "link to follow.",
"type" : "String"
}, {
"name" : "container",
"description" : "part of screen containing link.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "find by technical selector or",
"usage" : "| find by technical selector | [place] | or | [supplierF] | ",
"contexthelp" : "find by technical selector <place> or <supplierF>",
"name" : "findByTechnicalSelectorOr",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "supplierF",
"type" : "Function<String,? extends T>"
} ],
"exceptions" : [ ],
"returnType" : "T"
}, {
"readableName" : "download content from",
"usage" : "| download content from | [urlOrLink] | ",
"contexthelp" : "download content from <urlOrLink>",
"name" : "downloadContentFrom",
"docString" : "Downloads binary content from specified url (using the browser's cookies).\n@param urlOrLink url to download from\n@return link to downloaded file",
"annotations" : [ ],
"parameters" : [ {
"name" : "urlOrLink",
"description" : "url to download from",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "select file",
"usage" : "| select file | [fileName] | ",
"contexthelp" : "select file <fileName>",
"name" : "selectFile",
"docString" : "Selects a file using the first file upload control.\n@param fileName file to upload\n@return true, if a file input was found and file existed.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "fileName",
"description" : "file to upload",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "select file for",
"usage" : "| select file | [fileName] | for | [place] | ",
"contexthelp" : "select file <fileName> for <place>",
"name" : "selectFileFor",
"docString" : "Selects a file using a file upload control.\n@param fileName file to upload\n@param place file input to select the file for\n@return true, if place was a file input and file existed.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "fileName",
"description" : "file to upload",
"type" : "String"
}, {
"name" : "place",
"description" : "file input to select the file for",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "select file for in",
"usage" : "| select file | [fileName] | for | [place] | in | [container] | ",
"contexthelp" : "select file <fileName> for <place> in <container>",
"name" : "selectFileForIn",
"docString" : "Selects a file using a file upload control.\n@param fileName file to upload\n@param place file input to select the file for\n@param container part of screen containing place\n@return true, if place was a file input and file existed.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ {
"name" : "fileName",
"description" : "file to upload",
"type" : "String"
}, {
"name" : "place",
"description" : "file input to select the file for",
"type" : "String"
}, {
"name" : "container",
"description" : "part of screen containing place",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "cookie value",
"usage" : "| cookie value | [cookieName] | ",
"contexthelp" : "cookie value <cookieName>",
"name" : "cookieValue",
"docString" : "Gets the value of the cookie with the supplied name.\n@param cookieName name of cookie to get value from.\n@return cookie's value if any.",
"annotations" : [ ],
"parameters" : [ {
"name" : "cookieName",
"description" : "name of cookie to get value from.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "refresh until value of is",
"usage" : "| refresh until value of | [place] | is | [expectedValue] | ",
"contexthelp" : "refresh until value of <place> is <expectedValue>",
"name" : "refreshUntilValueOfIs",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "expectedValue",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "refresh until value of is not",
"usage" : "| refresh until value of is | [place] | not | [expectedValue] | ",
"contexthelp" : "refresh until value of is <place> not <expectedValue>",
"name" : "refreshUntilValueOfIsNot",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "place",
"type" : "String"
}, {
"name" : "expectedValue",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "refresh until is visible on page",
"usage" : "| refresh until | [place] | is visible on page |",
"contexthelp" : "refresh until <place> is visible on page",
"name" : "refreshUntilIsVisibleOnPage",
"docString" : "Refreshes current page until 'place' is found somewhere on the page. Do not forget to set 'repeat at most times', or else the loop may run endlessly.\n Usage: | refresh until | [place] | is visible on page |\n@param place The place to find.\n@return true if place is found while repeating",
"annotations" : [ ],
"parameters" : [ {
"name" : "place",
"description" : "The place to find.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "refresh until is not visible on page",
"usage" : "| refresh until | [place] | is not visible on page |",
"contexthelp" : "refresh until <place> is not visible on page",
"name" : "refreshUntilIsNotVisibleOnPage",
"docString" : "Refreshes current page until 'place' is not found somewhere on the page. Do not forget to set 'repeat at most times', or else the loop may run endlessly.\n Usage: | refresh until | [place] | is not visible on page |\n@param place The place you would not like to find anymore.\n@return true if place is not found while repeating",
"annotations" : [ ],
"parameters" : [ {
"name" : "place",
"description" : "The place you would not like to find anymore.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click until value of is",
"usage" : "| click until value | [clickPlace] | of | [checkPlace] | is | [expectedValue] | ",
"contexthelp" : "click until value <clickPlace> of <checkPlace> is <expectedValue>",
"name" : "clickUntilValueOfIs",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "clickPlace",
"type" : "String"
}, {
"name" : "checkPlace",
"type" : "String"
}, {
"name" : "expectedValue",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "click until value of is not",
"usage" : "| click until value of | [clickPlace] | is | [checkPlace] | not | [expectedValue] | ",
"contexthelp" : "click until value of <clickPlace> is <checkPlace> not <expectedValue>",
"name" : "clickUntilValueOfIsNot",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "clickPlace",
"type" : "String"
}, {
"name" : "checkPlace",
"type" : "String"
}, {
"name" : "expectedValue",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "execute javascript until is",
"usage" : "| execute javascript | [script] | until | [place] | is | [value] | ",
"contexthelp" : "execute javascript <script> until <place> is <value>",
"name" : "executeJavascriptUntilIs",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "script",
"type" : "String"
}, {
"name" : "place",
"type" : "String"
}, {
"name" : "value",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "execute javascript until is not",
"usage" : "| execute javascript until | [script] | is | [place] | not | [value] | ",
"contexthelp" : "execute javascript until <script> is <place> not <value>",
"name" : "executeJavascriptUntilIsNot",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "script",
"type" : "String"
}, {
"name" : "place",
"type" : "String"
}, {
"name" : "value",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "get ng browser test",
"usage" : "| get ng browser test |",
"contexthelp" : "get ng browser test",
"name" : "getNgBrowserTest",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "NgBrowserTest"
}, {
"readableName" : "set ng browser test",
"usage" : "| set ng browser test | [ngBrowserTest] | ",
"contexthelp" : "set ng browser test <ngBrowserTest>",
"name" : "setNgBrowserTest",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "ngBrowserTest",
"type" : "NgBrowserTest"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "is implicit wait for angular enabled",
"usage" : "| is implicit wait for angular enabled |",
"contexthelp" : "is implicit wait for angular enabled",
"name" : "isImplicitWaitForAngularEnabled",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set implicit wait for angular to",
"usage" : "| set implicit wait for angular to | [implicitWaitForAngular] | ",
"contexthelp" : "set implicit wait for angular to <implicitWaitForAngular>",
"name" : "setImplicitWaitForAngularTo",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "implicitWaitForAngular",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set implicit find in frames to",
"usage" : "| set implicit find in frames to | [implicitFindInFrames] | ",
"contexthelp" : "set implicit find in frames to <implicitFindInFrames>",
"name" : "setImplicitFindInFramesTo",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "implicitFindInFrames",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "is continue if ready state interactive",
"usage" : "| is continue if ready state interactive |",
"contexthelp" : "is continue if ready state interactive",
"name" : "isContinueIfReadyStateInteractive",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set continue if ready state interactive",
"usage" : "| set continue if ready state interactive | [continueIfReadyStateInteractive] | ",
"contexthelp" : "set continue if ready state interactive <continueIfReadyStateInteractive>",
"name" : "setContinueIfReadyStateInteractive",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "continueIfReadyStateInteractive",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "enable shadowroot containers",
"usage" : "| enable shadowroot containers | [enableShadowrootContainers] | ",
"contexthelp" : "enable shadowroot containers <enableShadowrootContainers>",
"name" : "enableShadowrootContainers",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "enableShadowrootContainers",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "execute script",
"usage" : "| execute script | [script] | ",
"contexthelp" : "execute script <script>",
"name" : "executeScript",
"docString" : "Executes javascript in the browser.\n@param script you want to execute\n@return result from script",
"annotations" : [ ],
"parameters" : [ {
"name" : "script",
"description" : "you want to execute",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "Object"
}, {
"readableName" : "select all",
"usage" : "| select all |",
"contexthelp" : "select all",
"name" : "selectAll",
"docString" : "Simulates 'select all' (e.g. Ctrl+A on Windows) on the active element.\n@return whether an active element was found.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "copy",
"usage" : "| copy |",
"contexthelp" : "copy",
"name" : "copy",
"docString" : "Simulates 'copy' (e.g. Ctrl+C on Windows) on the active element, copying the current selection to the clipboard.\n@return whether an active element was found.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "cut",
"usage" : "| cut |",
"contexthelp" : "cut",
"name" : "cut",
"docString" : "Simulates 'cut' (e.g. Ctrl+X on Windows) on the active element, copying the current selection to the clipboard\n and removing that selection.\n@return whether an active element was found.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "paste",
"usage" : "| paste |",
"contexthelp" : "paste",
"name" : "paste",
"docString" : "Simulates 'paste' (e.g. Ctrl+V on Windows) on the active element, copying the current clipboard\n content to the currently active element.\n@return whether an active element was found.",
"annotations" : [ "WaitUntil" ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "get selection text",
"usage" : "| get selection text |",
"contexthelp" : "get selection text",
"name" : "getSelectionText",
"docString" : "@return text currently selected in browser, or empty string if no text is selected.",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "trim on normalize",
"usage" : "| trim on normalize |",
"contexthelp" : "trim on normalize",
"name" : "trimOnNormalize",
"docString" : "@return should 'normalized' functions remove starting and trailing whitespace?",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set trim on normalize",
"usage" : "| set trim on normalize | [trimOnNormalize] | ",
"contexthelp" : "set trim on normalize <trimOnNormalize>",
"name" : "setTrimOnNormalize",
"docString" : "@param trimOnNormalize should 'normalized' functions remove starting and trailing whitespace?",
"annotations" : [ ],
"parameters" : [ {
"name" : "trimOnNormalize",
"description" : "should 'normalized' functions remove starting and trailing whitespace?",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "scroll elements to center of viewport",
"usage" : "| scroll elements to center of viewport | [scrollElementsToCenterOfViewport] | ",
"contexthelp" : "scroll elements to center of viewport <scrollElementsToCenterOfViewport>",
"name" : "scrollElementsToCenterOfViewport",
"docString" : "Set the scroll into view behaviour to 'center of viewport' (true) or 'auto' (false)\n@param scrollElementsToCenterOfViewport True to scroll to center, False to use automatic scroll behaviour",
"annotations" : [ ],
"parameters" : [ {
"name" : "scrollElementsToCenterOfViewport",
"description" : "True to scroll to center, False to use automatic scroll behaviour",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "scroll elements to center of viewport",
"usage" : "| scroll elements to center of viewport |",
"contexthelp" : "scroll elements to center of viewport",
"name" : "scrollElementsToCenterOfViewport",
"docString" : "Get the current scroll behaviour. True means 'center of viewport', False means 'auto'\n@return the current boolean value of scrollElementToCenter",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "use aria table structure",
"usage" : "| use aria table structure | [waiAriaTables] | ",
"contexthelp" : "use aria table structure <waiAriaTables>",
"name" : "useAriaTableStructure",
"docString" : "Configure browser test to expect wai aria style tables made up of divs and spans with roles like table/cell/row/etc.\n@param waiAriaTables True to expect aria tables, false to expect classic <table> table tags.",
"annotations" : [ ],
"parameters" : [ {
"name" : "waiAriaTables",
"description" : "True to expect aria tables, false to expect classic ,<,table,>, table tags.",
"type" : "boolean"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set username and password for hostname",
"usage" : "| set username | [user] | and password | [password] | for hostname | [host] |",
"contexthelp" : "set username <user> and password <password> for hostname <host>",
"name" : "setUsernameAndPasswordForHostname",
"docString" : "Automatically authenticate (using basic auth or digest) for a given host\n@param user The username to authenticate with\n@param password The password to authenticate with\n@param host The (partial) hostname to authenticate for (i.e. mywebsite.com or just mywebsite)\n \n Usage: | set username | [user] | and password | [password] | for hostname | [host] |",
"annotations" : [ ],
"parameters" : [ {
"name" : "user",
"description" : "The username to authenticate with",
"type" : "String"
}, {
"name" : "password",
"description" : "The password to authenticate with",
"type" : "String"
}, {
"name" : "host",
"description" : "The (partial) hostname to authenticate for (i.e. mywebsite.com or just mywebsite)\n ,
,\n Usage: | set username | [user] | and password | [password] | for hostname | [host] |",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "set global value to",
"usage" : "| set global value | [symbolName] | to | [value] | ",
"contexthelp" : "set global value <symbolName> to <value>",
"name" : "setGlobalValueTo",
"docString" : "Stores a (global) value so it can be accessed by other fixtures/pages.\n@param symbolName name to store value under.\n@param value value to store.",
"annotations" : [ ],
"parameters" : [ {
"name" : "symbolName",
"description" : "name to store value under.",
"type" : "String"
}, {
"name" : "value",
"description" : "value to store.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "global value",
"usage" : "| global value | [symbolName] | ",
"contexthelp" : "global value <symbolName>",
"name" : "globalValue",
"docString" : "Retrieves a (global) value, which was previously stored using #setGlobalValueTo().\n@param symbolName name value was stored under.",
"annotations" : [ ],
"parameters" : [ {
"name" : "symbolName",
"description" : "name value was stored under.",
"type" : "String"
} ],
"exceptions" : [ ],
"returnType" : "String"
}, {
"readableName" : "wait seconds",
"usage" : "| wait seconds | [i] | ",
"contexthelp" : "wait seconds <i>",
"name" : "waitSeconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "i",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "wait milliseconds",
"usage" : "| wait milliseconds | [i] | ",
"contexthelp" : "wait milliseconds <i>",
"name" : "waitMilliseconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "i",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "boolean"
}, {
"readableName" : "set repeat interval to milliseconds",
"usage" : "| set repeat interval to milliseconds | [milliseconds] | ",
"contexthelp" : "set repeat interval to milliseconds <milliseconds>",
"name" : "setRepeatIntervalToMilliseconds",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "milliseconds",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat interval",
"usage" : "| repeat interval |",
"contexthelp" : "repeat interval",
"name" : "repeatInterval",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
}, {
"readableName" : "repeat at most times",
"usage" : "| repeat at most times | [maxCount] | ",
"contexthelp" : "repeat at most times <maxCount>",
"name" : "repeatAtMostTimes",
"docString" : "",
"annotations" : [ ],
"parameters" : [ {
"name" : "maxCount",
"type" : "int"
} ],
"exceptions" : [ ],
"returnType" : "void"
}, {
"readableName" : "repeat at most times",
"usage" : "| repeat at most times |",
"contexthelp" : "repeat at most times",
"name" : "repeatAtMostTimes",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "repeat count",
"usage" : "| repeat count |",
"contexthelp" : "repeat count",
"name" : "repeatCount",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "int"
}, {
"readableName" : "time spent repeating",
"usage" : "| time spent repeating |",
"contexthelp" : "time spent repeating",
"name" : "timeSpentRepeating",
"docString" : "",
"annotations" : [ ],
"parameters" : [ ],
"exceptions" : [ ],
"returnType" : "long"
} ],
"typeName" : "nl.hsac.fitnesse.fixture.slim.web.Ng2BrowserTest",
"name" : "Ng2BrowserTest",
"annotations" : [ ]
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy