OpenVeo test API

API Docs for: 8.0.0
Show:

FakeField

Extends Field
Module: e2e

Summary

Defines a form fake field.

FakeField is not really a field, it is just a simple text with a label. Use Field.get method to get an instance of FakeField.

Constructor

FakeField

Syntax

FakeField

(
  • conf
)

Summary

Parameters:

  • conf Object

    A field configuration object

Example:

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

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

Methods

clear

Inherited from Field but overwritten in lib/e2e/fields/FakeField.js:67

Syntax

clear

() Promise

Summary

Clears field value.

Does not do anything as this is not a real field.

Returns:

Promise:

Promise resolving immediately

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

Inherited from Field but overwritten in lib/e2e/fields/FakeField.js:38

Syntax

getValue

() Promise

Summary

Gets fake field text.

Returns:

Promise:

Promise resolving with field text

Example:

myField.getValue().then(function(value) {
  console.log('Got text: ' + value);
});

isOnError

Inherited from Field but overwritten in lib/e2e/fields/FakeField.js:79

Syntax

isOnError

() Promise

Summary

Tests if a field is considered as on error.

Does not do anything as this is not a real field.

Returns:

Promise:

Promise resolving with false as it is not a real field, it couldn't be in error

setValue

Inherited from Field but overwritten in lib/e2e/fields/FakeField.js:54

Syntax

setValue

(
  • [value='']
)
Promise

Summary

Sets field value.

Does not do anything as this is not a real field.

Parameters:

  • [value=''] String optional

    Field's value

Returns:

Promise:

Promise resolving immediately

Properties

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.