GenerallyPositive.Browser.IAllowCallTemplate Interface Reference

What a workflow may say once .WithCallFilter has said which call it is after. Taking a template only means something when there is something to match, so this is the only place it is offered. More...

Inheritance diagram for GenerallyPositive.Browser.IAllowCallTemplate:

Public Member Functions
IAllowBrowserActionOrAnySelector	CaptureCallTemplate (out GPALRequest template)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowGoTo
IAllowBrowserActionOrAnySelector	GoTo ([URL()] GPALUrl URL)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowGet
IAllowBrowserActionOrAnySelector	Get ([URL()] GPALUrl URL)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowToGPALObject< TResult >
TResult	ToGPALObject ()
Public Member Functions inherited from GenerallyPositive.Browser.IAllowClose
void	Close (bool killWebDrivers=false)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowTabActions
IAllowBrowserActionOrAnySelector	CloseTab (dynamic URLorTabId=null)
IAllowBrowserActionOrAnySelector	GoToTab (dynamic URLorTabTuple=null)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowSizeControl
IAllowAllBrowserAndAllSelector	WithWindowSize (System.Drawing.Rectangle windowSize)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowWindowScrollBy
IAllowBrowserActionOrAnySelector	ScrollWindowByHorizontal (int scrollAmount)
IAllowBrowserActionOrAnySelector	ScrollWindowByVertical (int scrollAmount)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowExecuteJavaScript
IAllowBrowserActionOrAnySelector	ExecuteJavaScriptObj (string javascript)
IAllowBrowserActionOrAnySelector	ExecuteJavaScriptStr (string javascript)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowInjectScript
IAllowBrowserActionOrAnySelector	InjectScript (string script)
IAllowBrowserActionOrAnySelector	InjectScript (GPALFile scriptFile)
IAllowBrowserActionOrAnySelector	ClearInjectedScripts ()
Public Member Functions inherited from GenerallyPositive.Browser.IAllowGetWindowRectangle
IAllowBrowserActionOrAnySelector	GetWindowRectangle (out System.Drawing.Rectangle window)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowDialogHandling
IAllowBrowserActionOrAnySelector	WithDialogsAccepted (bool accept)
IAllowBrowserActionOrAnySelector	WithDialogText (string text)
IAllowBrowserActionOrAnySelector	ClearDialogHandling ()
Public Member Functions inherited from GenerallyPositive.Browser.IAllowSiteMapOperations
IAllowBrowserActionOrAnySelector	GetPageSource (out string sitemapXML)
IAllowBrowserActionOrAnySelector	ContinueAsRESTClient (out IRESTClient client)
IAllowBrowserActionOrAnySelector	GetSiteMap (out string sitemapXML)
IAllowBrowserActionOrAnySelector	GetSiteMapUrls (out List< string > sitemapXML)
IAllowBrowserActionOrAnySelector	SaveSiteMapUrls (GPALFile sitemapUrlsFile)
IAllowBrowserActionOrAnySelector	ClearResultCache ()
IAllowBrowserActionOrAnySelector	GetLLMDigest (out LLMDigestResult digestResult, string ruleSetName=null)
IAllowBrowserActionOrAnySelector	SaveLLMDigest (GPALFile llmDigestFile, string ruleSetName=null)
IAllowBrowserActionOrAnySelector	GetHydratedData (out NextJsHydrationResult hydrationResult)
IAllowBrowserActionOrAnySelector	SaveHydratedData (GPALFile hydrationFile)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowCasting
IAllowBrowserActionOrAnySelector	CastTab (string deviceNameOrId)
IAllowBrowserActionOrAnySelector	CastDesktop (string deviceNameOrId)
IAllowBrowserActionOrAnySelector	StopCasting ()
Public Member Functions inherited from GenerallyPositive.Browser.IAllowFetch
IAllowWithHeaderOrFileActions	Fetch (GPALRequest request)
IAllowBrowserActionOrAnySelector	CaptureCalls (bool capture=true)
IAllowBrowserActionOrAnySelector	CaptureCalls (out List< GPALCall > calls)
IAllowBrowserActionOrAnySelector	ClearCapturedCalls ()
IAllowCallTemplate	WithCallFilter (string urlFragment)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowWithTokensFrom
IAllowWithPagesAndFetch	WithTokensFrom (IGPALGrid< string > inputGrid)
IAllowWithPagesAndFetch	WithTokensFrom (GPALFile inputFile)
IAllowWithPagesAndFetch	WithTokensFrom (GPALDatabase inputDatabase)
IAllowWithPagesAndFetch	WithTokensFrom (string tokens)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowWithSelector
IAllowAfterAnySelector	WithSelector (Selector selector)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowWithData
IAllowAfterAnySelector	WithSelector (string literalData)
IAllowAfterAnySelector	WithSelector (Func< string > dataFunction)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowInSelector
IAllowAfterAnySelector	InElement (Selector selector)
IAllowAfterAnySelector	InFrame (Selector selector)
IAllowAfterAnySelector	InShadowDom (Selector shadowDomSelector)
	NOTE: can only use CSS selectors in shadow dom.
IAllowAfterAnySelector	InMainDom ()
Public Member Functions inherited from GenerallyPositive.Browser.IAllowClicks
IAllowBrowserActionOrAnySelector	LeftClick ()
IAllowBrowserActionOrAnySelector	LeftClick (Selector selector)
IAllowBrowserActionOrAnySelector	MiddleClick ()
IAllowBrowserActionOrAnySelector	SelectClick (SelectClickType selectClickType)
IAllowBrowserActionOrAnySelector	StealthLeftClick (Selector selector)
IAllowBrowserActionOrAnySelector	LeftClick (ModifierKeys modifierKeys)
IAllowBrowserActionOrAnySelector	LeftClickAndDownload (GPALFile filenames)
IAllowBrowserActionOrAnySelector	LeftClickAndUpload (GPALFile filenames)
IAllowBrowserActionOrAnySelector	LeftDoubleClick ()
IAllowBrowserActionOrAnySelector	RightClick (Selector selector=null)
IAllowBrowserActionOrAnySelector	RightClickAndDownload (GPALFile filenames)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowFillInFrom
IAllowBrowserActionOrAnySelector	SendString (string textToSend)
IAllowBrowserActionOrAnySelector	SendKey (byte VKCode)
IAllowBrowserActionOrAnySelector	PressModifierKey (ModifierKeys modifierKeys)
IAllowBrowserActionOrAnySelector	ReleaseModifierKey (ModifierKeys modifierKeys)
IAllowBrowserActionOrAnySelector	FillInFrom (string textToUse)
IAllowBrowserActionOrAnySelector	AppendFrom (string textToUse)
IAllowBrowserActionOrAnySelector	InsertFrom (string textToUse)
IAllowBrowserActionOrAnySelector	FillInFrom (GPALFile inputFile)
IAllowBrowserActionOrAnySelector	AppendFrom (GPALFile inputFile)
IAllowBrowserActionOrAnySelector	InsertFrom (GPALFile inputFile)
IAllowBrowserActionOrAnySelector	FillInFrom (GPALDatabase inpuDatabase)
IAllowBrowserActionOrAnySelector	AppendFrom (GPALDatabase inpuDatabase)
IAllowBrowserActionOrAnySelector	InsertFrom (GPALDatabase inpuDatabase)
IAllowBrowserActionOrAnySelector	FillInFrom (IGPALGrid< string > inputGrid)
IAllowBrowserActionOrAnySelector	AppendFrom (IGPALGrid< string > inputGrid)
IAllowBrowserActionOrAnySelector	InsertFrom (IGPALGrid< string > inputGrid)
IAllowBrowserActionOrAnySelector	SetRange (int rangeValue)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowFocus
IAllowBrowserActionOrAnySelector	Focus (Selector selector=null)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowHover
IAllowBrowserActionOrAnySelector	Hover (Selector selector=null)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowMoveTo
IAllowBrowserActionOrAnySelector	MoveTo (Selector selector=null)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowScrolling
IAllowBrowserActionOrAnySelector	ScrollElementHorizontalByPixels (int scrollAmountInPixels)
IAllowBrowserActionOrAnySelector	ScrollElementVerticalByPixels (int scrollAmountInPixels)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowWithGridToSave
IAllowWithHeaderOrFileActions	WithGridToSave (IGPALGrid< string > filename)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowDragAndDrop
IAllowBrowserActionOrAnySelector	DragAndDrop (Selector selector=null)
IAllowBrowserActionOrAnySelector	DragAndDrop (ModifierKeys modifierKeys)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowPrintDomElement
IAllowBrowserActionOrAnySelector	PrintToPDF (GPALFile gpalFile)
IAllowBrowserActionOrAnySelector	WithPageOrientation (PageOrientation pageOrientation)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowHideElement
IAllowBrowserActionOrAnySelector	Hide (Selector selector=null)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowWithAttribute
IAllowSetAttributeValue	WithAttribute (string attribute)
	Names the DOM attribute to set on the found element(s). Must be followed by IAllowSetAttributeValue.SetAttribute to supply the value and complete the action.
Public Member Functions inherited from GenerallyPositive.Browser.IAllowSetAttributeValue
IAllowBrowserActionOrAnySelector	SetAttribute (string value)
	Directly sets a DOM attribute on the found element(s) via element.setAttribute(attribute, value), using the attribute name given to the preceding IAllowWithAttribute.WithAttribute call. Uses OttoMagic, Puppeteer or JavaScript depending on the active engine. Hardware automation has no equivalent operation, so it falls back to whichever of Selenium/JavaScript or Puppeteer is configured.
Public Member Functions inherited from GenerallyPositive.Browser.IAllowSetValueFromElement
IAllowBrowserActionOrAnySelector	SetValueFrom (Selector selector)
	Copies the value from the element matched by selector into the element(s) matched by the preceding IAllowWithSelector.WithSelector call, i.e. destElement.value = srcElement.value. Uses OttoMagic, Puppeteer or JavaScript depending on the active engine, and fires "input"/"change" events on the destination so the page reacts to the new value.
Public Member Functions inherited from GenerallyPositive.Browser.IAllowWaitFor
IAllowAfterWaitFor	WaitFor (WaitTime waitForTimeInMs)
IAllowAfterWaitFor	WaitFor (Selector waitForSelector)
IAllowAfterWaitFor	WaitFor (ElementState elementState)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowWaitForWindow
IAllowAfterWaitForAndSizeControl	WaitForWindow (string windowName)
IAllowAfterWaitForAndSizeControl	WaitForWindowRegex (string windowNameRegex)
IAllowAfterWaitForAndSizeControl	WithWaitForWindowTimeout (int waitTimeInSeconds)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowNewTabOrWindow
IAllowBrowserActionOrAnySelector	NewTab (GPALUrl url=null)
IAllowBrowserActionOrAnySelector	OpenWindow (GPALUrl url=null)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowWorkflow
IAllowWorkflowExecution	WithWorkflow (Action< IBrowser > workflow)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowStorageOptions
IAllowStorageOptions	WithStorageDomain (string domain)
IAllowStorageOptions	WithStoragePath (string path)
IAllowStorageOptions	WithStorageKey (string key)
IAllowStorageOptions	WithStorageStoreName (string storeName)
IAllowStorageOptions	WithUserDefinedFilter (string userDefined)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowStorageAction
IAllowStorageOutData	RunGet (WebsiteStorageType storageType)
IAllowBrowserActionOrAnySelector	RunSet (WebsiteStorageType storageType)
IAllowBrowserActionOrAnySelector	RunDelete (WebsiteStorageType storageType)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowStorageData
IAllowStorageOptions	WithStorageData (string data)

Additional Inherited Members
Properties inherited from GenerallyPositive.Browser.IAllowTabActions
IAllowBrowserActionOrAnySelector	NextTab [get]
IAllowBrowserActionOrAnySelector	PreviousTab [get]
Properties inherited from GenerallyPositive.Browser.IAllowSizeControl
IAllowAllBrowserAndAllSelector	Maximize [get]
IAllowAllBrowserAndAllSelector	Minimize [get]
IAllowAllBrowserAndAllSelector	Restore [get]
IAllowAllBrowserAndAllSelector	FullScreen [get]
Properties inherited from GenerallyPositive.Browser.IAllowPageControl
IAllowBrowserActionOrAnySelector	Back [get]
IAllowBrowserActionOrAnySelector	Forward [get]
IAllowBrowserActionOrAnySelector	PageDown [get]
IAllowBrowserActionOrAnySelector	PageEnd [get]
IAllowBrowserActionOrAnySelector	PageTop [get]
IAllowBrowserActionOrAnySelector	PageUp [get]
IAllowBrowserActionOrAnySelector	Refresh [get]

Detailed Description

What a workflow may say once .WithCallFilter has said which call it is after. Taking a template only means something when there is something to match, so this is the only place it is offered.

Definition at line 710 of file Interfaces.cs.

Member Function Documentation

CaptureCallTemplate()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.IAllowCallTemplate.CaptureCallTemplate

(

out GPALRequest

template

)

Implemented in GenerallyPositive.Browser.Browser.

---

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

• Browser/Interfaces.cs