Class CandidateInfo

Candidate information.

Inheritance

System.Object

Info

CandidateInfo

Inherited Members

Info.Id

Info.ProcessBoolean(Boolean, Boolean)

Info.ProcessShort(Int16, Int16)

Info.ProcessInteger(Int32, Int32)

Info.ProcessLong(Int64, Int64)

Info.ProcessFloat(Single, Single)

Info.ProcessDouble(Double, Double)

Info.ProcessString(String, String)

Info.ProcessBooleanArray(Boolean[], Boolean[])

Info.ProcessShortArray(Int16[], Int16[])

Info.ProcessIntegerArray(Int32[], Int32[])

Info.ProcessLongArray(Int64[], Int64[])

Info.ProcessFloatArray(Single[], Single[])

Info.ProcessFloatArray(Double[], Double[])

Info.ProcessObject<T>(T, T)

Info.ProcessArray<T>(T[], T[])

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: FM.LiveSwitch

Assembly: FM.LiveSwitch.dll

Syntax

public class CandidateInfo : Info

Constructors

CandidateInfo()

Initializes a new instance of the CandidateInfo class.

Declaration

public CandidateInfo()

Properties

IPAddress

Gets or sets the candidate IP address.

Declaration

public string IPAddress { get; set; }

Property Value

Type	Description
System.String

Port

Gets or sets the candidate port.

Declaration

public int? Port { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Priority

Gets or sets the candidate priority.

Declaration

public long? Priority { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

Protocol

Gets or sets the candidate protocol.

Declaration

public string Protocol { get; set; }

Property Value

Type	Description
System.String

RelatedIPAddress

Gets or sets the candidate related IP address.

Declaration

public string RelatedIPAddress { get; set; }

Property Value

Type	Description
System.String

RelatedPort

Gets or sets the candidate related port.

Declaration

public int? RelatedPort { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

RelayProtocol

Gets or sets the candidate relay protocol.

Declaration

public string RelayProtocol { get; set; }

Property Value

Type	Description
System.String

Type

Gets or sets the candidate type.

Declaration

public string Type { get; set; }

Property Value

Type	Description
System.String

Methods

DeserializeProperties(String, String)

Deserializes the properties.

Declaration

protected override void DeserializeProperties(string key, string valueJson)

Parameters

Type	Name	Description
System.String	key	The key.
System.String	valueJson	The value in JSON format.

Overrides

Info.DeserializeProperties(String, String)

FromJson(String)

Deserializes an instance from JSON.

Declaration

public static CandidateInfo FromJson(string candidateReportJson)

Parameters

Type	Name	Description
System.String	candidateReportJson	The JSON.

Returns

Type	Description
CandidateInfo	The deserialized instance.

FromJsonArray(String)

Deserializes an array from JSON.

Declaration

public static CandidateInfo[] FromJsonArray(string candidateReportsJson)

Parameters

Type	Name	Description
System.String	candidateReportsJson	The JSON.

Returns

Type	Description
CandidateInfo[]	The deserialized array.

SerializeProperties(Dictionary<String, String>)

Serializes the properties.

Declaration

protected override void SerializeProperties(Dictionary<string, string> jsonObject)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary<System.String, System.String>	jsonObject	The JSON object.

Overrides

Info.SerializeProperties(Dictionary<String, String>)

ToJson()

Serializes this instance to JSON.

Declaration

public string ToJson()

Returns

Type	Description
System.String

ToJson(CandidateInfo)

Serializes an instance to JSON.

Declaration

public static string ToJson(CandidateInfo candidateReport)

Parameters

Type	Name	Description
CandidateInfo	candidateReport	The instance.

Returns

Type	Description
System.String	The serialized JSON.

ToJsonArray(CandidateInfo[])

Serializes an array to JSON.

Declaration

public static string ToJsonArray(CandidateInfo[] candidateReports)

Parameters

Type	Name	Description
CandidateInfo[]	candidateReports	The array.

Returns

Type	Description
System.String	The serialized JSON.