GenerallyPositive.GPALSettings Class Reference

Inheritance diagram for GenerallyPositive.GPALSettings:

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	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	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	WithTempProfileDirectory (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	WithTempProfileDirectory ([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	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	HandlerEvents = GPALEventType.All [get, set]
bool	PublishToDebug = false [get, set]
GPALEventType	DebugEvents = GPALEventType.NONE [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]

Detailed Description

Definition at line 31 of file GPALSettings.cs.

Member Function Documentation

AppCallIfFound()

IAllowGPALSettings GenerallyPositive.GPALSettings.AppCallIfFound

(

Application.Application.CallIfDelegate

callIfFound

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 144 of file GPALSettings.cs.

AppCallIfNotFound()

IAllowGPALSettings GenerallyPositive.GPALSettings.AppCallIfNotFound

(

Application.Application.CallIfDelegate

callIfNotFound

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 149 of file GPALSettings.cs.

CallIfFound()

IAllowGPALSettings GenerallyPositive.GPALSettings.CallIfFound

(

Browser.Browser.CallIfDelegate

callIfFound

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 154 of file GPALSettings.cs.

CallIfNotFound()

IAllowGPALSettings GenerallyPositive.GPALSettings.CallIfNotFound

(

Browser.Browser.CallIfDelegate

callIfNotFound

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 159 of file GPALSettings.cs.

CallOnFail()

IAllowGPALSettings GenerallyPositive.GPALSettings.CallOnFail

(

Browser.Browser.CallOnFailDelegate

callOnFail

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 238 of file GPALSettings.cs.

Clear()

void GenerallyPositive.GPALSettings.Clear

(

)

Clear all settings - for testing.

Definition at line 386 of file GPALSettings.cs.

Initialize()

void GenerallyPositive.GPALSettings.Initialize

(

)

Inintialize with default values.

Definition at line 342 of file GPALSettings.cs.

RemoveLogger()

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.

Parameters

logger

The logger to stop publishing to

Returns

Fluent interface to specify more global settings

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 225 of file GPALSettings.cs.

WithAutomationEngine()

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).

Parameters

automationEngine

Returns

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 305 of file GPALSettings.cs.

WithAutoUpdateWebDriver()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithAutoUpdateWebDriver

(

bool

trueFalse = true

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 310 of file GPALSettings.cs.

WithDefaultErrorPlaceholder()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithDefaultErrorPlaceholder

(

string

message = "##UNABLE TO GET##"

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 276 of file GPALSettings.cs.

WithDownloadTimeoutInSec()

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.

Parameters

seconds

Returns

Definition at line 294 of file GPALSettings.cs.

WithDriverLocation()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithDriverLocation

(

string

driverPath

)

Definition at line 164 of file GPALSettings.cs.

WithExceptionHandler()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithExceptionHandler

(

EventHandler< GPALEventArgs >

eventHandler

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 253 of file GPALSettings.cs.

WithImageMatchingPercentage()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithImageMatchingPercentage

(

int

matchPercent

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 248 of file GPALSettings.cs.

WithInformationHandler()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithInformationHandler

(

EventHandler< GPALEventArgs >

eventHandler

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 260 of file GPALSettings.cs.

WithNoFallbackActions()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithNoFallbackActions

(

bool

trueFalse = true

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 428 of file GPALSettings.cs.

WithPromptBeforeUnexpectedExit()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithPromptBeforeUnexpectedExit

(

bool

trueFalse = true

)

Definition at line 315 of file GPALSettings.cs.

WithPublishStackTrace()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithPublishStackTrace

(

bool

trueFalse = true

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 233 of file GPALSettings.cs.

WithPublishToConsole()

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.

Parameters

publishToConsole

true - print message to the console false [default] - do not print messages to the console

Returns

Fluent interface to specify more global settings

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 180 of file GPALSettings.cs.

WithPublishToDebug()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithPublishToDebug

(

GPALEventType

eventType

)

Indicate which event types to print to the console. Default is none.

Parameters

publishToDebug

true - print message to debug false [default] - do not print messages to debug

Returns

Fluent interface to specify more global settings

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 195 of file GPALSettings.cs.

WithPublishToLogger()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithPublishToLogger

(

IGPALLogger

logger

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 206 of file GPALSettings.cs.

WithSimulateMouseMovement()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithSimulateMouseMovement

(

bool

trueFalse = true

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 266 of file GPALSettings.cs.

WithStopOnNotFound()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithStopOnNotFound

(

bool

trueFalse = true

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 271 of file GPALSettings.cs.

WithTempDirectory()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithTempDirectory

(

string

tempPath

)

Definition at line 169 of file GPALSettings.cs.

WithTempProfileDirectory()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithTempProfileDirectory

(

string

tempProfileDirectory

)

Definition at line 281 of file GPALSettings.cs.

WithTypingDelay()

IAllowGPALSettings GenerallyPositive.GPALSettings.WithTypingDelay

(

int

delayInTicks

)

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 243 of file GPALSettings.cs.

WithWaitFor()

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.

Parameters

waitForInTicks

Returns

Implements GenerallyPositive.IAllowGPALSettings.

Definition at line 332 of file GPALSettings.cs.

Property Documentation

AutoUpdateWebDriver

bool GenerallyPositive.GPALSettings.AutoUpdateWebDriver

getset

Definition at line 63 of file GPALSettings.cs.

ChromeDriverFilename

string GenerallyPositive.GPALSettings.ChromeDriverFilename

getset

Definition at line 72 of file GPALSettings.cs.

ChromeDriverUpdateURL

string GenerallyPositive.GPALSettings.ChromeDriverUpdateURL

getset

Definition at line 70 of file GPALSettings.cs.

ChromeDriverXpathExpression

string GenerallyPositive.GPALSettings.ChromeDriverXpathExpression

getset

Definition at line 73 of file GPALSettings.cs.

ChromeDriverZipFilename

string GenerallyPositive.GPALSettings.ChromeDriverZipFilename

getset

Definition at line 71 of file GPALSettings.cs.

ChromeUserAgentTemplate

string GenerallyPositive.GPALSettings.ChromeUserAgentTemplate

getset

Definition at line 93 of file GPALSettings.cs.

ChromeVersionRegistry

string GenerallyPositive.GPALSettings.ChromeVersionRegistry

getset

Definition at line 74 of file GPALSettings.cs.

ConsoleEvents

GPALEventType GenerallyPositive.GPALSettings.ConsoleEvents = GPALEventType.GPALALL

getset

Definition at line 41 of file GPALSettings.cs.

DebugEvents

GPALEventType GenerallyPositive.GPALSettings.DebugEvents = GPALEventType.NONE

getset

Definition at line 51 of file GPALSettings.cs.

DownloadTimeoutInSec

int GenerallyPositive.GPALSettings.DownloadTimeoutInSec = 10

getset

Definition at line 35 of file GPALSettings.cs.

EdgeDriverFilename

string GenerallyPositive.GPALSettings.EdgeDriverFilename

getset

Definition at line 78 of file GPALSettings.cs.

EdgeDriverSelectorDynamicPart

string GenerallyPositive.GPALSettings.EdgeDriverSelectorDynamicPart

getset

Definition at line 79 of file GPALSettings.cs.

EdgeDriverUpdateURL

string GenerallyPositive.GPALSettings.EdgeDriverUpdateURL

getset

Definition at line 76 of file GPALSettings.cs.

EdgeDriverXpathExpression

string GenerallyPositive.GPALSettings.EdgeDriverXpathExpression

getset

Definition at line 80 of file GPALSettings.cs.

EdgeDriverZipFilename

string GenerallyPositive.GPALSettings.EdgeDriverZipFilename

getset

Definition at line 77 of file GPALSettings.cs.

EdgeUserAgentTemplate

string GenerallyPositive.GPALSettings.EdgeUserAgentTemplate

getset

Definition at line 94 of file GPALSettings.cs.

EdgeVersionRegistry

string GenerallyPositive.GPALSettings.EdgeVersionRegistry

getset

Definition at line 81 of file GPALSettings.cs.

ErrorPlaceholder

string GenerallyPositive.GPALSettings.ErrorPlaceholder

getset

Definition at line 39 of file GPALSettings.cs.

FirefoxBinaryPathRegistry

string GenerallyPositive.GPALSettings.FirefoxBinaryPathRegistry

getset

Definition at line 89 of file GPALSettings.cs.

FirefoxDirectDownloadMimeTypes

string GenerallyPositive.GPALSettings.FirefoxDirectDownloadMimeTypes

getset

Definition at line 92 of file GPALSettings.cs.

FirefoxDriverFilename

string GenerallyPositive.GPALSettings.FirefoxDriverFilename

getset

Definition at line 85 of file GPALSettings.cs.

FirefoxDriverShowAllXpath

string GenerallyPositive.GPALSettings.FirefoxDriverShowAllXpath

getset

Definition at line 86 of file GPALSettings.cs.

FirefoxDriverUpdateURL

string GenerallyPositive.GPALSettings.FirefoxDriverUpdateURL

getset

Definition at line 83 of file GPALSettings.cs.

FirefoxDriverXpath

string GenerallyPositive.GPALSettings.FirefoxDriverXpath

getset

Definition at line 87 of file GPALSettings.cs.

FirefoxDriverZipFilename

string GenerallyPositive.GPALSettings.FirefoxDriverZipFilename

getset

Definition at line 84 of file GPALSettings.cs.

FirefoxUserAgentTemplate

string GenerallyPositive.GPALSettings.FirefoxUserAgentTemplate

getset

Definition at line 95 of file GPALSettings.cs.

FirefoxVersionRegistry

string GenerallyPositive.GPALSettings.FirefoxVersionRegistry

getset

Definition at line 90 of file GPALSettings.cs.

FirefoxVersionRegistry2

string GenerallyPositive.GPALSettings.FirefoxVersionRegistry2

getset

Definition at line 91 of file GPALSettings.cs.

HandlerEvents

GPALEventType GenerallyPositive.GPALSettings.HandlerEvents = GPALEventType.All

getset

Definition at line 46 of file GPALSettings.cs.

MatchingPercentage

int GenerallyPositive.GPALSettings.MatchingPercentage

getset

Definition at line 34 of file GPALSettings.cs.

NoFallbackRecoveryActions

bool GenerallyPositive.GPALSettings.NoFallbackRecoveryActions

getset

Definition at line 65 of file GPALSettings.cs.

PromptBeforeUnexpectedExit

bool GenerallyPositive.GPALSettings.PromptBeforeUnexpectedExit

getset

Definition at line 64 of file GPALSettings.cs.

PublishStackTrace

bool GenerallyPositive.GPALSettings.PublishStackTrace

getset

Definition at line 52 of file GPALSettings.cs.

PublishToConsole

bool GenerallyPositive.GPALSettings.PublishToConsole = false

getset

Definition at line 40 of file GPALSettings.cs.

PublishToDebug

bool GenerallyPositive.GPALSettings.PublishToDebug = false

getset

Definition at line 50 of file GPALSettings.cs.

SimulateMouse

bool GenerallyPositive.GPALSettings.SimulateMouse

getset

Definition at line 37 of file GPALSettings.cs.

StopOnNotFound

bool GenerallyPositive.GPALSettings.StopOnNotFound

getset

Definition at line 38 of file GPALSettings.cs.

TakeEventScreenshot

bool GenerallyPositive.GPALSettings.TakeEventScreenshot = false

getset

Definition at line 68 of file GPALSettings.cs.

TempProfileDirectory

string GenerallyPositive.GPALSettings.TempProfileDirectory = @"C:\Profiles\"

getset

Definition at line 97 of file GPALSettings.cs.

TypingDelay

int GenerallyPositive.GPALSettings.TypingDelay = 0

getset

Definition at line 33 of file GPALSettings.cs.

UserAgent

string GenerallyPositive.GPALSettings.UserAgent

getset

Definition at line 62 of file GPALSettings.cs.

Version

string GenerallyPositive.GPALSettings.Version = Assembly.GetExecutingAssembly().GetName().Version.ToString()

getset

Definition at line 36 of file GPALSettings.cs.

WaitForInMs

WaitTime GenerallyPositive.GPALSettings.WaitForInMs = WaitTime.Never

getset

Definition at line 66 of file GPALSettings.cs.

WithAllThatMatch

int GenerallyPositive.GPALSettings.WithAllThatMatch = int.MaxValue

getset

Definition at line 67 of file GPALSettings.cs.

---

The documentation for this class was generated from the following file:

• Common/GPALSettings.cs