What is Incisor?
Tutorials
Key Concepts
Reddit
Stack Overflow
Configuration Settings
Deprecation Schedule

UrlParameterIterator()

Object housing testing functionality that enables a project to refresh itself repeatedly with different url parameters. Such functionality can help with batch testing of a project's configurations or settings. To use this functionality, first call the 'UrlParameterIteration.setup' method, passing it an array of objects where each object represents the url parameters you would like the browser to refresh with. When ready to start the iteration, call 'UrlParameterIteration.start'. Then add the desired functionality per url parameter - be sure to implement what you want conditionally based on the url params (otherwise everything will happen on every refresh). When the desired tasks (testing, screen shots, etc...) have completed for each set of url parameters, call 'UrlParameterIteration.next', this will proceed to refresh with the next set of url parameters. [NON-INSTANTIABLE] [REQUIREMENT: optional code module - 'urlParameterIterator'] [REQUIREMENT: user subscription access - 'advancedTools']

new UrlParameterIterator()
IncisorAPI.js, line 16970

METHODS

next()
IncisorAPI.js, line 16989

Proceeds to the next item in the list of url parameters, refreshing the browser with the coorespoinging url.

setup(urlParametersList, postIterationCallbackOwner, postIterationCallackName)
IncisorAPI.js, line 16978

Function that informs the UrlParameterIterator of the set of url parameters that it will iterate over. This function must be called un-conditionally upon every refresh in order for the UrlPerameterIterator to function properly.

Parameters:
Name Type Attributes Default Description
urlParametersList Array.<object>    

Array of objects where each object represents the active url parameters for a particular iteration.
postIterationCallbackOwner object    

The object owning the callback function to be called when the iteration completes.
postIterationCallackName string    

The name of the callback function to be called when the iteration completes.

start(startingIndex (opt))
IncisorAPI.js, line 16984

Starts the process of refreshing the browser, iterating through the list of url parameters provided in 'UrlParameterIterator.setup'.

Parameters:
Name Type Attributes Default Description
startingIndex number <optional>
  

Optional starting index, enabling iteration to start at a non-zero value. [DEFAULT: 0]