Properties property

Class: BatchInfoPlatform: AppiumLanguage: C# SDK:

Set one or more user-defined properties to be associated with the batch.

A batch property is a user-defined name/value pair that you can associate with a batch. Use the Test Manger to view the properties and their values for a particular batch and you can filter for batches with specific property values. See Hide displacement diffs tool for more information.

Syntax

PropertiesCollection value; // give relevant initial value
batchInfo.Properties  = value;
value = batchInfo.Properties

Type:PropertiesCollection

Remarks

Set batch properties using the BatchInfo.AddProperty method:
  • Call this method after creating the BatchInfo object and before using the Eyes.Batch or Configuration.SetBatch method to associate the batch with the test (before the test is started).
  • Set multiple properties by calling BatchInfo.AddProperty multiple times with the same property name and different values. Alternatively, set them together using the Properties property.
  • You should not assign a given value to a property more than once in a given batch run.