![]() |
GPAL - Generally Positive Automation Library v1.0
GPAL The Fluent Automation LIbrary
|
Public Member Functions | |
| IAllowGPALSettings | AppCallIfFound (Application.Application.CallIfDelegate callIfFound) |
| IAllowGPALSettings | AppCallIfNotFound (Application.Application.CallIfDelegate callIfNotFound) |
| IAllowGPALSettings | CallIfFound (Browser.Browser.CallIfDelegate callIfFound) |
| IAllowGPALSettings | CallIfNotFound (Browser.Browser.CallIfDelegate callIfNotFound) |
| IAllowGPALSettings | WithDriverLocation (string driverPath) |
| IAllowGPALSettings | WithTempDirectory (string tempPath) |
| IAllowGPALSettings | WithPublishToConsole (GPALEventType eventType=GPALEventType.INFO|GPALEventType.WARNING|GPALEventType.ERROR|GPALEventType.EXCEPTION|GPALEventType.NOTICE|GPALEventType.CAUTION|GPALEventType.FAILURE) |
| Print the published information or exception messages to the console. | |
| IAllowGPALSettings | WithPublishToControl (GPALTextArea control) |
| Write GPAL events to a text area on a form, the way WithPublishToConsole writes them to a console. | |
| IAllowGPALSettings | WithControlEvents (GPALEventType eventTypes) |
| Which event types reach the control given to WithPublishToControl. Defaults to all of them. | |
| IAllowGPALSettings | WithInformationHandlerEvents (GPALEventType eventTypes) |
| Which event types reach the information handler. Defaults to all of them. | |
| IAllowGPALSettings | WithExceptionHandlerEvents (GPALEventType eventTypes) |
| Which event types reach the exception handler. Defaults to all of them. | |
| IAllowGPALSettings | WithHandlerEvents (GPALEventType eventTypes) |
| Which event types reach an attached exception or information handler. Defaults to all of them. | |
| IAllowGPALSettings | WithPublishToDebug (GPALEventType eventType) |
| Indicate which event types to print to the console. Default is none. | |
| IAllowGPALSettings | WithPublishToLogger (IGPALLogger logger) |
| IAllowGPALSettings | RemoveLogger (IGPALLogger logger) |
| Stops publishing events to a logger, for a workflow that logged a stretch of work to its own place and is done with it. | |
| IAllowGPALSettings | WithPublishStackTrace (bool trueFalse=true) |
| IAllowGPALSettings | CallOnFail (Browser.Browser.CallOnFailDelegate callOnFail) |
| IAllowGPALSettings | WithTypingDelay (int delayInTicks) |
| IAllowGPALSettings | WithImageMatchingPercentage (int matchPercent) |
| IAllowGPALSettings | WithYamlAliasLimit (int nodeLimit) |
| IAllowGPALSettings | WithExceptionHandler (EventHandler< GPALEventArgs > eventHandler) |
| IAllowGPALSettings | WithInformationHandler (EventHandler< GPALEventArgs > eventHandler) |
| IAllowGPALSettings | WithSimulateMouseMovement (bool trueFalse=true) |
| IAllowGPALSettings | WithStopOnNotFound (bool trueFalse=true) |
| IAllowGPALSettings | WithDefaultErrorPlaceholder (string message="##UNABLE TO GET##") |
| IAllowGPALSettings | WithTempProfileParentDirectory (string tempProfileDirectory) |
| IAllowGPALSettings | WithDownloadTimeoutInSec (int seconds) |
| Set the default timeout time in seconds to wait for a download to start The default is 60 seconds. | |
| IAllowGPALSettings | WithAutomationEngine (AutomationEngine automationEngine) |
| Set the automation type to use for all browsers. NOTE: can be overridden at the selector level (to choose javascript or hardware). | |
| IAllowGPALSettings | WithAutoUpdateWebDriver (bool trueFalse=true) |
| IAllowGPALSettings | WithPromptBeforeUnexpectedExit (bool trueFalse=true) |
| IAllowGPALSettings | WithWaitFor (int waitForInTicks) |
| Global setting to wait for time in ticks for an element to show up. Applied to every element in every workflow. Override in a unit of work using this pattern .WithSelector(select0or) .WaitFor(waitForInTicks) .LeftClick() NOTE: shortcut actions like LeftClick{selector) will not waitfor and no syntax will make them wait except this global setting. | |
| void | Initialize () |
| Inintialize with default values. | |
| void | Clear () |
| Clear all settings - for testing. | |
| IAllowGPALSettings | WithNoFallbackActions (bool trueFalse=true) |
| Public Member Functions inherited from GenerallyPositive.IAllowGPALSettings | |
| IAllowGPALSettings | WithDriverLocation ([Directory(Description="Global location for browser drivers. [./ (default)(same dir as exe)]")] string driverPath="./") |
| IAllowGPALSettings | WithTempDirectory ([Directory(Description="Where GPAL writes files it created itself and nobody asked to keep. [GPALfilesSafeToDelete beside the exe (default)]")] string tempPath) |
| IAllowGPALSettings | WithTempProfileParentDirectory ([Directory(Description="Global location for temp profiles. [c:\\profiles (default)(saved in GPAL.yaml that is loaded on startup)]")] string tempProfileDirectory) |
Properties | |
| int | TypingDelay = 0 [get, set] |
| int | MatchingPercentage [get, set] |
| int | YamlAliasLimit = 5000 [get, set] |
| int | DownloadTimeoutInSec = 10 [get, set] |
| string | Version = Assembly.GetExecutingAssembly().GetName().Version.ToString() [get, set] |
| bool | SimulateMouse [get, set] |
| bool | StopOnNotFound [get, set] |
| string | ErrorPlaceholder [get, set] |
| bool | PublishToConsole = false [get, set] |
| GPALEventType | ConsoleEvents = GPALEventType.GPALALL [get, set] |
| GPALEventType | InformationHandlerEvents = GPALEventType.All [get, set] |
| GPALEventType | ExceptionHandlerEvents = GPALEventType.All [get, set] |
| bool | PublishToDebug = false [get, set] |
| GPALEventType | DebugEvents = GPALEventType.NONE [get, set] |
| GPALEventType | ControlEvents = GPALEventType.GPALALL [get, set] |
| GPALTextArea | PublishControl = null [get, set] |
| bool | PublishStackTrace [get, set] |
| string | UserAgent [get, set] |
| bool | AutoUpdateWebDriver [get, set] |
| bool | PromptBeforeUnexpectedExit [get, set] |
| bool | NoFallbackRecoveryActions [get, set] |
| WaitTime | WaitForInMs = WaitTime.Never [get, set] |
| int | WithAllThatMatch = int.MaxValue [get, set] |
| bool | TakeEventScreenshot = false [get, set] |
| string | ChromeDriverUpdateURL [get, set] |
| string | ChromeDriverZipFilename [get, set] |
| string | ChromeDriverFilename [get, set] |
| string | ChromeDriverXpathExpression [get, set] |
| string | ChromeVersionRegistry [get, set] |
| string | EdgeDriverUpdateURL [get, set] |
| string | EdgeDriverZipFilename [get, set] |
| string | EdgeDriverFilename [get, set] |
| string | EdgeDriverSelectorDynamicPart [get, set] |
| string | EdgeDriverXpathExpression [get, set] |
| string | EdgeVersionRegistry [get, set] |
| string | FirefoxDriverUpdateURL [get, set] |
| string | FirefoxDriverZipFilename [get, set] |
| string | FirefoxDriverFilename [get, set] |
| string | FirefoxDriverShowAllXpath [get, set] |
| string | FirefoxDriverXpath [get, set] |
| string | FirefoxBinaryPathRegistry [get, set] |
| string | FirefoxVersionRegistry [get, set] |
| string | FirefoxVersionRegistry2 [get, set] |
| string | FirefoxDirectDownloadMimeTypes [get, set] |
| string | ChromeUserAgentTemplate [get, set] |
| string | EdgeUserAgentTemplate [get, set] |
| string | FirefoxUserAgentTemplate [get, set] |
| string | TempProfileDirectory = @"C:\Profiles\" [get, set] |
Definition at line 32 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.AppCallIfFound | ( | Application.Application.CallIfDelegate | callIfFound | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 158 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.AppCallIfNotFound | ( | Application.Application.CallIfDelegate | callIfNotFound | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 163 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.CallIfFound | ( | Browser.Browser.CallIfDelegate | callIfFound | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 168 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.CallIfNotFound | ( | Browser.Browser.CallIfDelegate | callIfNotFound | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 173 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.CallOnFail | ( | Browser.Browser.CallOnFailDelegate | callOnFail | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 313 of file GPALSettings.cs.
| void GenerallyPositive.GPALSettings.Clear | ( | ) |
Clear all settings - for testing.
Definition at line 466 of file GPALSettings.cs.
| void GenerallyPositive.GPALSettings.Initialize | ( | ) |
Inintialize with default values.
Definition at line 422 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.RemoveLogger | ( | IGPALLogger | logger | ) |
Stops publishing events to a logger, for a workflow that logged a stretch of work to its own place and is done with it.
| logger | The logger to stop publishing to |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 300 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithAutomationEngine | ( | AutomationEngine | automationEngine | ) |
Set the automation type to use for all browsers. NOTE: can be overridden at the selector level (to choose javascript or hardware).
| automationEngine |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 385 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithAutoUpdateWebDriver | ( | bool | trueFalse = true | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 390 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithControlEvents | ( | GPALEventType | eventTypes | ) |
Which event types reach the control given to WithPublishToControl. Defaults to all of them.
| eventTypes | The events to write to the control |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 222 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithDefaultErrorPlaceholder | ( | string | message = "##UNABLE TO GET##" | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 356 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithDownloadTimeoutInSec | ( | int | seconds | ) |
Set the default timeout time in seconds to wait for a download to start The default is 60 seconds.
| seconds |
Definition at line 374 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithDriverLocation | ( | string | driverPath | ) |
Definition at line 178 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithExceptionHandler | ( | EventHandler< GPALEventArgs > | eventHandler | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 333 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithExceptionHandlerEvents | ( | GPALEventType | eventTypes | ) |
Which event types reach the exception handler. Defaults to all of them.
| eventTypes | The events to hand to the exception handler |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 246 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithHandlerEvents | ( | GPALEventType | eventTypes | ) |
Which event types reach an attached exception or information handler. Defaults to all of them.
| eventTypes | The events to hand to a handler |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 258 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithImageMatchingPercentage | ( | int | matchPercent | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 323 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithInformationHandler | ( | EventHandler< GPALEventArgs > | eventHandler | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 340 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithInformationHandlerEvents | ( | GPALEventType | eventTypes | ) |
Which event types reach the information handler. Defaults to all of them.
| eventTypes | The events to hand to the information handler |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 234 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithNoFallbackActions | ( | bool | trueFalse = true | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 508 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithPromptBeforeUnexpectedExit | ( | bool | trueFalse = true | ) |
Definition at line 395 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithPublishStackTrace | ( | bool | trueFalse = true | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 308 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithPublishToConsole | ( | GPALEventType | eventType = GPALEventType::INFO | GPALEventType::WARNING | GPALEventType::ERROR | GPALEventType::EXCEPTION | GPALEventType::NOTICE | GPALEventType::CAUTION | GPALEventType::FAILURE | ) |
Print the published information or exception messages to the console.
| publishToConsole | true - print message to the console false [default] - do not print messages to the console |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 194 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithPublishToControl | ( | GPALTextArea | control | ) |
Write GPAL events to a text area on a form, the way WithPublishToConsole writes them to a console.
| control | The text area to write to, or null to stop writing to one |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 210 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithPublishToDebug | ( | GPALEventType | eventType | ) |
Indicate which event types to print to the console. Default is none.
| publishToDebug | true - print message to debug false [default] - do not print messages to debug |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 270 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithPublishToLogger | ( | IGPALLogger | logger | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 281 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithSimulateMouseMovement | ( | bool | trueFalse = true | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 346 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithStopOnNotFound | ( | bool | trueFalse = true | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 351 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithTempDirectory | ( | string | tempPath | ) |
Definition at line 183 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithTempProfileParentDirectory | ( | string | tempProfileDirectory | ) |
Definition at line 361 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithTypingDelay | ( | int | delayInTicks | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 318 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithWaitFor | ( | int | waitForInTicks | ) |
Global setting to wait for time in ticks for an element to show up. Applied to every element in every workflow. Override in a unit of work using this pattern .WithSelector(select0or) .WaitFor(waitForInTicks) .LeftClick() NOTE: shortcut actions like LeftClick{selector) will not waitfor and no syntax will make them wait except this global setting.
| waitForInTicks |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 412 of file GPALSettings.cs.
| IAllowGPALSettings GenerallyPositive.GPALSettings.WithYamlAliasLimit | ( | int | nodeLimit | ) |
Implements GenerallyPositive.IAllowGPALSettings.
Definition at line 328 of file GPALSettings.cs.
|
getset |
Definition at line 77 of file GPALSettings.cs.
|
getset |
Definition at line 86 of file GPALSettings.cs.
|
getset |
Definition at line 84 of file GPALSettings.cs.
|
getset |
Definition at line 87 of file GPALSettings.cs.
|
getset |
Definition at line 85 of file GPALSettings.cs.
|
getset |
Definition at line 107 of file GPALSettings.cs.
|
getset |
Definition at line 88 of file GPALSettings.cs.
|
getset |
Definition at line 45 of file GPALSettings.cs.
|
getset |
Definition at line 63 of file GPALSettings.cs.
|
getset |
Definition at line 59 of file GPALSettings.cs.
|
getset |
Definition at line 39 of file GPALSettings.cs.
|
getset |
Definition at line 92 of file GPALSettings.cs.
|
getset |
Definition at line 93 of file GPALSettings.cs.
|
getset |
Definition at line 90 of file GPALSettings.cs.
|
getset |
Definition at line 94 of file GPALSettings.cs.
|
getset |
Definition at line 91 of file GPALSettings.cs.
|
getset |
Definition at line 108 of file GPALSettings.cs.
|
getset |
Definition at line 95 of file GPALSettings.cs.
|
getset |
Definition at line 43 of file GPALSettings.cs.
|
getset |
Definition at line 54 of file GPALSettings.cs.
|
getset |
Definition at line 103 of file GPALSettings.cs.
|
getset |
Definition at line 106 of file GPALSettings.cs.
|
getset |
Definition at line 99 of file GPALSettings.cs.
|
getset |
Definition at line 100 of file GPALSettings.cs.
|
getset |
Definition at line 97 of file GPALSettings.cs.
|
getset |
Definition at line 101 of file GPALSettings.cs.
|
getset |
Definition at line 98 of file GPALSettings.cs.
|
getset |
Definition at line 109 of file GPALSettings.cs.
|
getset |
Definition at line 104 of file GPALSettings.cs.
|
getset |
Definition at line 105 of file GPALSettings.cs.
|
getset |
Definition at line 52 of file GPALSettings.cs.
|
getset |
Definition at line 35 of file GPALSettings.cs.
|
getset |
Definition at line 79 of file GPALSettings.cs.
|
getset |
Definition at line 78 of file GPALSettings.cs.
|
getset |
Definition at line 65 of file GPALSettings.cs.
|
getset |
Definition at line 66 of file GPALSettings.cs.
|
getset |
Definition at line 44 of file GPALSettings.cs.
|
getset |
Definition at line 58 of file GPALSettings.cs.
|
getset |
Definition at line 41 of file GPALSettings.cs.
|
getset |
Definition at line 42 of file GPALSettings.cs.
|
getset |
Definition at line 82 of file GPALSettings.cs.
|
getset |
Definition at line 111 of file GPALSettings.cs.
|
getset |
Definition at line 34 of file GPALSettings.cs.
|
getset |
Definition at line 76 of file GPALSettings.cs.
|
getset |
Definition at line 40 of file GPALSettings.cs.
|
getset |
Definition at line 80 of file GPALSettings.cs.
|
getset |
Definition at line 81 of file GPALSettings.cs.
|
getset |
Definition at line 38 of file GPALSettings.cs.