Class ClientSettings

Settings that are local to the current user.

Inheritance

System.Object

ClientSettings

Namespace: AppDrillCore.Session

Assembly: AppDrillCore.dll

Syntax

public class ClientSettings : object

Properties

MachineState

Declaration

public ClientSettings.EMachineState MachineState { get; set; }

Property Value

Type	Description
ClientSettings.EMachineState

ServerAddress

The server endpoint to connect to. The server holds all the models, and each troubleshooting session is conducted agains it.

Declaration

public string ServerAddress { get; set; }

Property Value

Type	Description
System.String

UserLevel

Declaration

public ClientSettings.EUserLevel UserLevel { get; set; }

Property Value

Type	Description
ClientSettings.EUserLevel

Weight

Declaration

public ClientSettings.WeightDistribution Weight { get; set; }

Property Value

Type	Description
ClientSettings.WeightDistribution

Methods

AllowMachineState(String)

Declaration

public bool AllowMachineState(string machineState)

Parameters

Type	Name	Description
System.String	machineState

Returns

Type	Description
System.Boolean

AllowUserLevel(String)

Declaration

public bool AllowUserLevel(string userLevel)

Parameters

Type	Name	Description
System.String	userLevel

Returns

Type	Description
System.Boolean

CreateDefault()

Create a default ClientSettings object.

Declaration

public static ClientSettings CreateDefault()

Returns

Type	Description
ClientSettings	A ClientSettings object with default properties

Equals(Object)

Declaration

public override bool Equals(Object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
System.Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

SetMachineState(String)

Update the current machine state.

Declaration

public bool SetMachineState(string machineState)

Parameters

Type	Name	Description
System.String	machineState	The string representation of the new state. Note: this representation needs to match one of the valid enum values of ClientSettings.EMachineState

Returns

Type	Description
System.Boolean	true if the machine state has been successfully updated, false otherwise

SetServerAddress(String)

Set the server address for this client config.

Declaration

public bool SetServerAddress(string serverAddress)

Parameters

Type	Name	Description
System.String	serverAddress	A URL or IP address of the server endpoint

Returns

Type	Description
System.Boolean	true if the server address object is valid, and if it's different than the one that is currently stored. This can be used to determine whether it's necessary to store the settings via SaveSettings(String)

SetUserLevel(String)

Update the current user level.

Declaration

public bool SetUserLevel(string userLevel)

Parameters

Type	Name	Description
System.String	userLevel	The string representation of the new level. Note: this representation needs to match one of the valid enum values of ClientSettings.EUserLevel

Returns

Type	Description
System.Boolean	true if the machine state has been successfully updated, false otherwise

SetWeight(ClientSettings.WeightDistribution)

Set the weight distribution for this client config.

Declaration

public bool SetWeight(ClientSettings.WeightDistribution weight)

Parameters

Type	Name	Description
ClientSettings.WeightDistribution	weight

Returns

Type	Description
System.Boolean	true if the weight object is valid, and if the weight data is different than the one that is currently stored. This can be used to determine whether it's necessary to store the settings via SaveSettings(String)