OpenVeo test API

API Docs for: 8.0.0
Show:

MatchField

Extends Field
Module: e2e

Summary

Defines a form match field.

Use Field.get method to get an instance of MatchField.

Constructor

MatchField

Syntax

MatchField

(
  • conf
)

Summary

Parameters:

  • conf Object

    A field configuration object

Example:

var Field = require('@openveo/test').e2e.fields.Field;

var MatchField = Field.get({
  type: 'match',
  name: 'My field',
  baseElement: element(by.css('form'))
});

Methods

clear

Syntax

clear

() Promise

Summary

Clears field value.

Returns:

Promise:

Promise resolving when the field is cleared

Example:

myField.clear().then(function() {
  console.log('Field cleared');
});

getDescription

Syntax

getDescription

() Promise

Summary

Gets field description.

Returns:

Promise:

Promise resolving with the description

Example:

myField.getDescription().then(function(description) {
  console.log('Field description is : ' + description);
});

getElement

Syntax

getElement

() Promise

Summary

Gets field element wrapper.

Look for a form element label and return its parent.

Returns:

Promise:

Promise resolving with the element

getErrorMessage

Syntax

getErrorMessage

() Promise

Summary

Gets field error message.

Returns:

Promise:

Promise resolving with the error message

Example:

myField.getErrorMessage().then(function(errorMessage) {
  console.log('Error message : ' + errorMessage);
});

getLabel

Syntax

getLabel

() Promise

Summary

Gets field label.

Returns:

Promise:

Promise resolving with the label

Example:

myField.getLabel().then(function(label) {
  console.log('Field label is : ' + label);
});

getText

Syntax

getText

() Promise

Summary

Gets field text representation in case of an inline editable field.

Returns:

Promise:

Promise resolving with field text representation

Example:

myField.getText().then(function(text) {
  console.log(text);
});

getValue

Syntax

getValue

() Promise

Summary

Gets field value.

Returns:

Promise:

Promise resolving with field value

Example:

myField.getValue().then(function(value) {
  console.log(value);
});

isOnError

Syntax

isOnError

() Promise

Summary

Tests if a field is considered as on error.

Returns:

Promise:

Promise resolving with a boolean indicating if the field is on error

Example:

myField.isOnError().then(function(isOnError) {
  console.log('Is field on error ? ' + isOnError);
});

setValue

Syntax

setValue

(
  • [value]
)
Promise

Summary

Sets field value.

Parameters:

Returns:

Promise:

Promise resolving when the value is set

Example:

myField.setValue('new value').then(function() {
  console.log('Value set');
});

Properties

availableOptions

Syntax

availableOptions

Array

Summary

The list of available options for tags.

baseElement

Syntax

baseElement

ElementFinder final

Summary

Element from where to look for the field (typically the form element).

name

Syntax

name

String final

Summary

Field label.