Open topic with navigation

# EnvironmentDescription Class

An object describing the environment that the test requires, in capability name-value pairs.

Note: Supported in LeanFT versions 14.51 and later.

C# Syntax

                                public class EnvironmentDescription : PropertiesDescription, IDescription

Inheritance Hierarchy

System.Object
HP.LFT.SDK.PropertiesDescription
HP.LFT.SDK.EnvironmentDescription

Public Constructors

| Name | Description
--- | --- | ---
| EnvironmentDescription Constructor | Creates an instance of EnvironmentDescription. C# Syntax
                                public EnvironmentDescription()

Top
Public Methods

| Name | Description
--- | --- | ---
| Clone | Creates an exact copy of the test object. (Inherited from HP.LFT.SDK.PropertiesDescription )
| FromDictionary | Creates a new instance of EnvironmentDescription and initializes it with the specified dictionary of capabilities. For details on how to describe the capabilities, see Build an environment description in the LeanFT Help Center. C# Syntax
                                public static EnvironmentDescription FromDictionary(
       IDictionary<string,object> capabilities
    )
Parameters capabilities An IDictionary<string,object> of capabilities to initialize the EnvironmentDescription with. Return Value A new instance of EnvironmentDescription initialized with the specified capabilities.
| Get | Returns the current value of an EnvironmentDescription capability. C# Syntax
     public object Get(
       string capability
    )
Parameters capability The capability whose value to return. Return Value The current value of an EnvironmentDescription capability.
| Set | Sets an EnvironmentDescription capability to the specified value. C# Syntax
    public EnvironmentDescription Set(string capability, object value)
Parameters capability The name of the capability to set a value for. value The new value of the capability. Return Value The updated description instance (builder pattern).

Top