Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IValueElementNode<GetType, FilterType, SetType>

This interface is implemented by ValuePageElement, ValuePageElementList, ValuePageElementMap and ValuePageElementGroup.

IValueElementNode guarantees support of the following state retrieval functions:

  • getValue
  • getHasValue
  • getHasAnyValue
  • getContainsValue

IValueElementNode guarantees support of the following state check functions:

  • hasValue
  • hasAnyValue
  • containsValue
template

GetType type of IValueElementNode's state retrieval functions (getValue)

template

FilterType type of IValueElementNode's filter mask

template

SetType type of a setter values structure used by a IValueElementNode's setter functions

Type parameters

  • GetType

  • FilterType

  • SetType

Hierarchy

Implemented by

Index

Properties

__lastDiff

__lastDiff: IDiff

Retrieves the last differences of a PageNode's check state functions.

Intended for framework-internal usage only.

__setLastDiff

__setLastDiff: function

Sets the last differences of a PageNode's check state functions.

Intended for framework-internal usage only.

Type declaration

    • Parameters

      Returns void

currently

currently: IGetValueElement<GetType, FilterType> & ICheckValueCurrently<GetType, FilterType>

defines an api for all functions of PageNode which check if a condition is currently true or which retrieve a current value from the tested application's state

eventually

eventually: ICheckValueEventually<GetType, FilterType>

defines an api for all functions of PageNode which check if a condition eventually becomes true within a specified timeout

wait

wait: ICheckWaitValue<GetType, FilterType>

defines an api for all functions of PageNode which wait for a condition to become true within a specified timeout

Methods

__getNodeId

  • __getNodeId(): string
  • Retrieves the id used to identify a PageNode in the instance cache of PageNodeStore.

    Intended for framework-internal usage only.

    Returns string

getContainsValue

  • getContainsValue(value: GetType): FilterType
  • Returns the 'containsValue' status of a ValuePageElement or of the ValuePageElements managed by ValuePageElementList, ValuePageElementMap or ValuePageElementGroup.

    A ValuePageElement's 'hasValue' status is set to true if its actual value contains the expected value.

    Parameters

    • value: GetType

      the expected value used in the comparison which sets the 'containsValue' status

    Returns FilterType

getHasAnyValue

  • getHasAnyValue(filterMask?: FilterType): FilterType
  • Returns the 'hasAnyValue' status of a ValuePageElement or of the ValuePageElements managed by ValuePageElementList, ValuePageElementMap or ValuePageElementGroup.

    Parameters

    • Optional filterMask: FilterType

      can be used to skip the invocation of the state retrieval function for some or all managed PageElements and not include the skipped results in the total result

    Returns FilterType

getHasValue

  • getHasValue(value: GetType): FilterType
  • Returns the 'hasValue' status of a ValuePageElement or of the ValuePageElements managed by ValuePageElementList, ValuePageElementMap or ValuePageElementGroup.

    A ValuePageElement's 'hasValue' status is set to true if its actual value equals the expected value.

    Parameters

    • value: GetType

      the expected value used in the comparison which sets the 'hasValue' status

    Returns FilterType

getValue

  • getValue(filterMask?: FilterType): GetType
  • Returns the value of a ValuePageElement or of the ValuePageElements managed by a ValuePageElementList, ValuePageElementMap or ValuePageElementGroup.

    Parameters

    • Optional filterMask: FilterType

      can be used to skip the invocation of the state retrieval function for some or all managed PageElements and not include the skipped results in the total result

    Returns GetType

setValue

  • Sets the value of a ValuePageElement or of all ValuePageElements managed by ValuePageElementList, ValuePageElementMap or ValuePageElementGroup.

    Parameters

    • value: SetType

    Returns IValueElementNode<GetType, FilterType, SetType>

toJSON

Generated using TypeDoc