All Downloads are FREE. Search and download functionalities are using the official Maven repository.

META-INF.apidocs.nl.hsac.fitnesse.fixture.slim.web.SeleniumDriverSetup.json Maven / Gradle / Ivy

There is a newer version: 5.3.17
Show newest version
{
  "constructors" : [ {
    "readableName" : "selenium driver setup",
    "usage" : "| selenium driver setup |",
    "name" : "SeleniumDriverSetup",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ]
  } ],
  "qualifiedName" : "nl.hsac.fitnesse.fixture.slim.web.SeleniumDriverSetup",
  "publicMethods" : [ {
    "readableName" : "set property value",
    "usage" : "| set property | [propName] | value | [value] | ",
    "contexthelp" : "set property <propName> value <value>",
    "name" : "setPropertyValue",
    "docString" : "Sets system property (needed by the WebDriver to be set up).\n@param propName name of property to set.\n@param value value to set.\n@return true.",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "propName",
      "description" : "name of property to set.",
      "type" : "String"
    }, {
      "name" : "value",
      "description" : "value to set.",
      "type" : "String"
    } ],
    "exceptions" : [ ],
    "returnType" : "boolean"
  }, {
    "readableName" : "start driver",
    "usage" : "| start | [driverClassName] | driver | [profile] | ",
    "contexthelp" : "start <driverClassName> driver <profile>",
    "name" : "startDriver",
    "docString" : "Creates an instance of the specified class an injects it into SeleniumHelper, so other fixtures can use it.\n@param driverClassName name of Java class of WebDriver to use.\n@param profile profile to use (for firefox, chrome mobile and IE only for now)\n@return true if instance was created and injected into SeleniumHelper.\n@throws Exception if no instance could be created.",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "driverClassName",
      "description" : "name of Java class of WebDriver to use.",
      "type" : "String"
    }, {
      "name" : "profile",
      "description" : "profile to use (for firefox, chrome mobile and IE only for now)",
      "type" : "Map<Object>"
    } ],
    "exceptions" : [ "java.lang.Exception" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "start driver",
    "usage" : "| start driver | [driverClassName] | ",
    "contexthelp" : "start driver <driverClassName>",
    "name" : "startDriver",
    "docString" : "Creates an instance of the specified class an injects it into SeleniumHelper, so other fixtures can use it.\n@param driverClassName name of Java class of WebDriver to use.\n@return true if instance was created and injected into SeleniumHelper.\n@throws Exception if no instance could be created.",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "driverClassName",
      "description" : "name of Java class of WebDriver to use.",
      "type" : "String"
    } ],
    "exceptions" : [ "java.lang.Exception" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "start managed driver for with profile",
    "usage" : "| start managed driver for with | [browserName] | profile | [profile] | ",
    "contexthelp" : "start managed driver for with <browserName> profile <profile>",
    "name" : "startManagedDriverForWithProfile",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "browserName",
      "type" : "String"
    }, {
      "name" : "profile",
      "type" : "Map<Object>"
    } ],
    "exceptions" : [ "java.lang.Exception" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "start managed driver for",
    "usage" : "| start managed driver for | [browserName] | ",
    "contexthelp" : "start managed driver for <browserName>",
    "name" : "startManagedDriverFor",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "browserName",
      "type" : "String"
    } ],
    "exceptions" : [ "java.lang.Exception" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "start driver for with profile",
    "usage" : "| start driver for with | [browser] | profile | [profile] | ",
    "contexthelp" : "start driver for with <browser> profile <profile>",
    "name" : "startDriverForWithProfile",
    "docString" : "Starts a local instance of the selenium driver for the specified browser\n (using defaults to determine the correct class and configuration properties).\n and injects it into SeleniumHelper, so other fixtures can use it.\n@param browser name of browser to connect to.\n@param profile setting of the browser (for firefox, chrome mobile and IE only for now)\n@return true if instance was created and injected into SeleniumHelper.\n@throws Exception if no instance could be created.",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "browser",
      "description" : "name of browser to connect to.",
      "type" : "String"
    }, {
      "name" : "profile",
      "description" : "setting of the browser (for firefox, chrome mobile and IE only for now)",
      "type" : "Map<Object>"
    } ],
    "exceptions" : [ "java.lang.Exception" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "start driver for",
    "usage" : "| start driver for | [browser] | ",
    "contexthelp" : "start driver for <browser>",
    "name" : "startDriverFor",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "browser",
      "type" : "String"
    } ],
    "exceptions" : [ "java.lang.Exception" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "connect to driver for at",
    "usage" : "| connect to driver for | [browser] | at | [url] | ",
    "contexthelp" : "connect to driver for <browser> at <url>",
    "name" : "connectToDriverForAt",
    "docString" : "Connects SeleniumHelper to a remote web driver, without specifying browser version.\n@param browser name of browser to connect to.\n@param url url to connect to browser.\n@return true.\n@throws MalformedURLException if supplied url can not be transformed to URL.",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "browser",
      "description" : "name of browser to connect to.",
      "type" : "String"
    }, {
      "name" : "url",
      "description" : "url to connect to browser.",
      "type" : "String"
    } ],
    "exceptions" : [ "java.net.MalformedURLException" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "connect to driver for on at",
    "usage" : "| connect to driver for | [browser] | on | [platformName] | at | [url] | ",
    "contexthelp" : "connect to driver for <browser> on <platformName> at <url>",
    "name" : "connectToDriverForOnAt",
    "docString" : "Connects SeleniumHelper to a remote web driver, without specifying browser version.\n@param browser name of browser to connect to.\n@param platformName platform browser must run on.\n@param url url to connect to browser.\n@return true.\n@throws MalformedURLException if supplied url can not be transformed to URL.",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "browser",
      "description" : "name of browser to connect to.",
      "type" : "String"
    }, {
      "name" : "platformName",
      "description" : "platform browser must run on.",
      "type" : "String"
    }, {
      "name" : "url",
      "description" : "url to connect to browser.",
      "type" : "String"
    } ],
    "exceptions" : [ "java.net.MalformedURLException" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "connect to driver for version on at",
    "usage" : "| connect to driver for | [browser] | version | [version] | on | [platformName] | at | [url] | ",
    "contexthelp" : "connect to driver for <browser> version <version> on <platformName> at <url>",
    "name" : "connectToDriverForVersionOnAt",
    "docString" : "Connects SeleniumHelper to a remote web driver.\n@param browser name of browser to connect to.\n@param version version of browser.\n@param platformName platform browser must run on.\n@param url url to connect to browser.\n@return true.\n@throws MalformedURLException if supplied url can not be transformed to URL.",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "browser",
      "description" : "name of browser to connect to.",
      "type" : "String"
    }, {
      "name" : "version",
      "description" : "version of browser.",
      "type" : "String"
    }, {
      "name" : "platformName",
      "description" : "platform browser must run on.",
      "type" : "String"
    }, {
      "name" : "url",
      "description" : "url to connect to browser.",
      "type" : "String"
    } ],
    "exceptions" : [ "java.net.MalformedURLException" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "connect to driver at with capabilities",
    "usage" : "| connect to driver at with | [url] | capabilities | [capabilities] | ",
    "contexthelp" : "connect to driver at with <url> capabilities <capabilities>",
    "name" : "connectToDriverAtWithCapabilities",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "url",
      "type" : "String"
    }, {
      "name" : "capabilities",
      "type" : "Map<Object>"
    } ],
    "exceptions" : [ "java.net.MalformedURLException" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "connect to firefox driver at with profile",
    "usage" : "| connect to firefox driver at with | [url] | profile | [profile] | ",
    "contexthelp" : "connect to firefox driver at with <url> profile <profile>",
    "name" : "connectToFirefoxDriverAtWithProfile",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "url",
      "type" : "String"
    }, {
      "name" : "profile",
      "type" : "Map<Object>"
    } ],
    "exceptions" : [ "java.net.MalformedURLException" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "connect to driver at with json capabilities",
    "usage" : "| connect to driver at with json | [url] | capabilities | [capabilitiesInJson] | ",
    "contexthelp" : "connect to driver at with json <url> capabilities <capabilitiesInJson>",
    "name" : "connectToDriverAtWithJsonCapabilities",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "url",
      "type" : "String"
    }, {
      "name" : "capabilitiesInJson",
      "type" : "String"
    } ],
    "exceptions" : [ "java.net.MalformedURLException" ],
    "returnType" : "boolean"
  }, {
    "readableName" : "driver description",
    "usage" : "| driver description |",
    "contexthelp" : "driver description",
    "name" : "driverDescription",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "String"
  }, {
    "readableName" : "run summary",
    "usage" : "| run summary |",
    "contexthelp" : "run summary",
    "name" : "runSummary",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "String"
  }, {
    "readableName" : "get last run summary",
    "usage" : "| get last run summary |",
    "contexthelp" : "get last run summary",
    "name" : "getLastRunSummary",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "String"
  }, {
    "readableName" : "get last remote url",
    "usage" : "| get last remote url |",
    "contexthelp" : "get last remote url",
    "name" : "getLastRemoteUrl",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "URL"
  }, {
    "readableName" : "stop driver",
    "usage" : "| stop driver |",
    "contexthelp" : "stop driver",
    "name" : "stopDriver",
    "docString" : "Stops the current driver registered in the SeleniumHelper.\n@return true.",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "boolean"
  }, {
    "readableName" : "get secret capabilities",
    "usage" : "| get secret capabilities |",
    "contexthelp" : "get secret capabilities",
    "name" : "getSecretCapabilities",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "List<String>"
  }, {
    "readableName" : "lock config",
    "usage" : "| lock config |",
    "contexthelp" : "lock config",
    "name" : "lockConfig",
    "docString" : "Prevents instances from creating new Selenium drivers.\n This can be used to control Selenium configuration independent from Wiki content.",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "void"
  }, {
    "readableName" : "unlock config",
    "usage" : "| unlock config |",
    "contexthelp" : "unlock config",
    "name" : "unlockConfig",
    "docString" : "Enables normal behavior (i.e. instances can create new Selenium drivers).",
    "annotations" : [ ],
    "parameters" : [ ],
    "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.SeleniumDriverSetup",
  "name" : "SeleniumDriverSetup",
  "annotations" : [ ]
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy