Schema URL

Type: object

Properties

interface boolean

All of

1. variant
2. variant

Definitions

pageObject object

An object representing a page or a UI element in a web page

description object | string

summary of the functionality and use cases

3 nested properties
text string[] required
author string
deprecated string
root boolean
Default: false
selector object

An object that locates an element or a list of elements at run time.

One of: object object, object object, object object, object object
exposeRootElement boolean
Default: true
implements string

reference to the interface implemented by the page object

profile object[]

list of profiles that can use this page object implementation.

platform enum

Declares the page context type (WebView or native).

Default: "web"
Values: "web" "native"
beforeLoad array

The beforeLoad array sets the criteria to be satisfied before the load method completes. If you don't specify a beforeLoad array, the load method finds a root element for a regular page object, or waits for the root element to be present for a root page object), by default.

elements element[]

A nested tree of element objects.

methods composeMethod[]

An array of methods performing actions on this page object's elements.

shadow object

A shadow boundary at the root of the page object.

Default:
{
  "elements": []
}
1 nested properties
elements element[]

A nested tree of element objects.

metadata object

track miscellaneous information for the page object

2 nested properties
status string
teamOwner string
pageObjectInterface object

An interface to abstract page object APIs for page objects with similar structure and function.

interface boolean

Indicates that this page object describes an interface.

Default: false
root boolean
Default: false
exposeRootElement boolean
Default: true

An array of method declarations that page objects implementing this interface must define.

description object | string

summary of the functionality and use cases

3 nested properties
text string[] required
author string
deprecated string
metadata object

track miscellaneous information for the page object

2 nested properties
status string
teamOwner string
element object

An interface to abstract page object APIs for page objects with similar structure and function.

name string required
type string | array
selector object

An object that locates an element or a list of elements at run time.

One of: object object, object object, object object, object object
nullable boolean
shadow object
1 nested properties
elements element[]

A nested tree of element objects.

elements element[]

A nested tree of element objects.

public boolean
filter object
4 nested properties
args arg[]
apply string
matcher object
2 nested properties
type string
Values: "isTrue" "isFalse" "notNull" "stringContains" "stringEquals"
args arg[]
findFirst boolean

Return only the first match result.

Default: true
description object | string

summary at the method or element level

4 nested properties
text string[] required
return string
throws string
deprecated string
wait boolean
Default: true
load boolean
Default: true
elementsArray element[]

A nested tree of element objects.

selector object

An object that locates an element or a list of elements at run time.

pageObjectType object
type string required

URI-like type value of the page object

filter object
args arg[]
apply string
matcher object
2 nested properties
type string
Values: "isTrue" "isFalse" "notNull" "stringContains" "stringEquals"
args arg[]
findFirst boolean

Return only the first match result.

Default: true
matcher object
type string
Values: "isTrue" "isFalse" "notNull" "stringContains" "stringEquals"
args arg[]
interfaceMethod object

A declarative, interface method definition.

name string required
args arg[]
returnType string | array
returnAll boolean
Default: false
description object | string

summary at the method or element level

4 nested properties
text string[] required
return string
throws string
deprecated string
composeMethod object

A method definition, composed of element actions.

name string required
compose object[] required
args arg[]
description object | string

summary at the method or element level

4 nested properties
text string[] required
return string
throws string
deprecated string
action object

An action to be performed on an element.

element string
apply string
applyExternal object
args arg[]
matcher object
2 nested properties
type string
Values: "isTrue" "isFalse" "notNull" "stringContains" "stringEquals"
args arg[]
chain boolean
returnType string
Default: "void"
returnAll boolean
Default: false
arg object
name string
type string
Values: "string" "boolean" "number" "elementReference" "argumentReference" "function" "locator" "frame" "pageObject" "rootPageObject"
value integer | string | boolean | number | object
predicate array
args arg[]

element reference can have nested literal args (hardcoded values for its getter)

description string
predicateStatement object

An action to be performed on an element.

element string
apply string
applyExternal object
args arg[]
matcher object
2 nested properties
type string
Values: "isTrue" "isFalse" "notNull" "stringContains" "stringEquals"
args arg[]
chain boolean
returnType string
Default: "void"
returnAll boolean
Default: false
root boolean
exposeRootElement boolean
name string
type string | array
shadow object

A shadow boundary at the root of the page object.

elements element[]
elements element[]
methods array
rootDescription object | string

summary of the functionality and use cases

text string[] required
author string
deprecated string
metadata object

track miscellaneous information for the page object

status string
teamOwner string
methodDescription object | string

summary at the method or element level

text string[] required
return string
throws string
deprecated string