Class ExtractCodesResult

Result of extracting verification codes from message content

Inheritance

object

ExtractCodesResult

Implements

IValidatableObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: mailslurp.Model

Assembly: mailslurp.dll

Syntax

[DataContract(Name = "ExtractCodesResult")]
public class ExtractCodesResult : IValidatableObject

Constructors

ExtractCodesResult()

Initializes a new instance of the ExtractCodesResult class.

Declaration

[JsonConstructor]
protected ExtractCodesResult()

ExtractCodesResult(bool, string, MethodUsedEnum?, List<CodeCandidate>, List<string>)

Initializes a new instance of the ExtractCodesResult class.

Declaration

public ExtractCodesResult(bool found = false, string code = null, ExtractCodesResult.MethodUsedEnum? methodUsed = null, List<CodeCandidate> candidates = null, List<string> warnings = null)

Parameters

Type	Name	Description
bool	found	True if at least one code candidate was found (required).
string	code	Best candidate code when found.
ExtractCodesResult.MethodUsedEnum?	methodUsed	Extraction strategy for verification codes. Unsupported strategies may fall back when allowFallback is true..
List<CodeCandidate>	candidates	Ranked code candidates (required).
List<string>	warnings	Warnings or fallback notes explaining extraction behavior for debugging and QA. (required).

Properties

Candidates

Ranked code candidates

Declaration

[DataMember(Name = "candidates", IsRequired = true, EmitDefaultValue = true)]
public List<CodeCandidate> Candidates { get; set; }

Property Value

Type	Description
List<CodeCandidate>	Ranked code candidates

Code

Best candidate code when found

Declaration

[DataMember(Name = "code", EmitDefaultValue = true)]
public string Code { get; set; }

Property Value

Type	Description
string	Best candidate code when found

Found

True if at least one code candidate was found

Declaration

[DataMember(Name = "found", IsRequired = true, EmitDefaultValue = true)]
public bool Found { get; set; }

Property Value

Type	Description
bool	True if at least one code candidate was found

MethodUsed

Extraction strategy for verification codes. Unsupported strategies may fall back when allowFallback is true.

Declaration

[DataMember(Name = "methodUsed", EmitDefaultValue = true)]
public ExtractCodesResult.MethodUsedEnum? MethodUsed { get; set; }

Property Value

Type	Description
ExtractCodesResult.MethodUsedEnum?	Extraction strategy for verification codes. Unsupported strategies may fall back when allowFallback is true.

Warnings

Warnings or fallback notes explaining extraction behavior for debugging and QA.

Declaration

[DataMember(Name = "warnings", IsRequired = true, EmitDefaultValue = true)]
public List<string> Warnings { get; set; }

Property Value

Type	Description
List<string>	Warnings or fallback notes explaining extraction behavior for debugging and QA.

Methods

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
string	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
string	String presentation of the object

Overrides

object.ToString()

Implements

IValidatableObject