The information in this topic may be out of date. The current SDK reference guide has moved here.
BatchInfo class
Platform: ImagesLanguage: JavaScript SDK:
Call the
Configuration.setBatch method or Eyes.setBatch method with an object of this class to configure the batch for one or more tests.
See How to group tests into batches using the SDK
for details and an example.
Require statement
const {BatchInfo} = require('@applitools/eyes-images');
Constructor
- BatchInfo()
- The constructor for the BatchInfo class.
Methods
- getId()
- Use this method to retrieve the unique id of the batch.
- getName()
- Use this method to retrieve the name of the batch.
- getNotifyOnCompletion()
- Use this method to retrieve if the SDK will inform the Eyes server that the batch has completed.
- getSequenceName()
- Use this method to retrieve the batch sequence name for a batch.
- getStartedAt()
- Use this method to retrieve the date and time that will be displayed in the Test Manager as the start time of the batch.
- setId()
- Use this method to set the unique id of the batch.
- setName()
- Use this method to set the name of the batch.
- setNotifyOnCompletion()
- Enable informing the Eyes server that the batch has completed.
- setSequenceName()
- Use this method to set the batch sequence name for a batch.
- setStartedAt()
- Use this method to set the date and time that will be displayed in the Test Manager as the start time of the batch.