Set Browser Data

Sets or removes the page's cookies, local storage or session storage items, or restores what Get Browser Data read.

Behaviour

Risk: Medium · Idempotent: Yes · Safe to retry: Yes · Recovery: Not replayed after a crash

Package UI Automation activities VeloPhex.UIAutomation.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.ui.setBrowserData

Windows · Needs an interactive desktop session

Properties#

Input#

Data type#

DataType · String · Optional · Default: Cookies

Cookies, LocalStorage or SessionStorage: what Name and Value set, and what Clear first empties.

Allowed values: Cookies, LocalStorage, SessionStorage.

Name#

Name · String · Optional · Default: Not specified in package metadata

The cookie or storage item to set or remove.

Value#

Value · String · Optional · Default: Not specified in package metadata

Its value. Empty removes the cookie or item.

Data#

Data · String · Optional · Default: Not specified in package metadata

A document Get Browser Data produced: every part it has is restored, instead of Name and Value.

Clear first#

ClearFirst · Boolean · Optional · Default: Not specified in package metadata

Empty the storage (or remove the page's cookies) that is about to be set, first.

Domain#

Domain · String · Optional · Default: Not specified in package metadata

The cookie's domain. Empty sets it for the page's host.

Shown when DataType=Cookies.

Path#

Path · String · Optional · Default: Not specified in package metadata

The cookie's path. Empty means /.

Shown when DataType=Cookies.

Secure#

Secure · Boolean · Optional · Default: Not specified in package metadata

Send the cookie over HTTPS only.

Shown when DataType=Cookies.

HTTP only#

HttpOnly · Boolean · Optional · Default: Not specified in package metadata

Hide the cookie from the page's scripts.

Shown when DataType=Cookies.

Session#

Session · String · Optional · Default: Not specified in package metadata

The session id from a Use Application/Browser scope. Empty uses the enclosing scope's session, or outside a scope the most recent matching session.

Timeout (seconds)#

TimeoutSeconds · Int32 · Optional · Default: Not specified in package metadata

How long to keep looking for the element or window. Empty or not positive means the same as the enclosing Use Application/Browser scope, or outside a scope the project default (30 seconds).

Highlight before action#

HighlightBeforeAction · Boolean · Optional · Default: Not specified in package metadata

Draw the highlight around the element before acting on it.

Rules#

  • Must be inside Use Application/Browser.
  • Set only one of: Data, Name.

Retry and risk#

This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Generated from VeloPhex.UIAutomation.Activities 0.7.1-rc.12. Category: UI Automation › Browser Data. Keywords: ui, automation, browser, cookie, cookies, local storage, session storage, storage, data, set, write, restore, clear.

Properties

Input

Rules

Retry and risk

Related activities