initWithName method

Class: BatchInfoPlatform: ImagesLanguage: Objective-C SDK:

The constructor for the BatchInfo class.

Create the object, set it up and assign it to the batch before the test starts using the [Configuration batch] property or [Eyes batch] property. See How to group tests into batches using the SDK for more details and an example.

Syntax

Call syntax

BatchInfo* batchInfo = [[BatchInfo alloc] initWithName  : name   ];

BatchInfo* batchInfo = [[BatchInfo alloc] initWithName  : name startedAt: startedAt   ];

Declaration

(instancetype)initWithName:(NSString *)name startedAt:(NSDate *)startedAt

Parameters

name
Type:NSString*

The name of the batch. If a is passed then the name will be taken from the environment variable APPLITOOLS_BATCH_NAME. If the environment variable is not defined then the name of the first test is used as the batch name.

startedAt
Type:NSDate*

The date and time that will be displayed in the Test Manager as the batch start time. If the parameter is not passed, or a value of is passed, then the run time will be the time at which the constructor was called.

Return value

Type: BatchInfo*