Class ScraperResult

Information about a success or failure result, returned from scraper methods.

Inheritance

System.Object

ScraperResult

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

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

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

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Subsembly.Scraper

Assembly: Subsembly.Scraper.dll

Syntax

public sealed class ScraperResult

Remarks

A scraper method that is declared to return an instance of ScraperResult must never return null. For convenience there are two static result instances that indicate Success or Failure. The latter should rarely be used, if at all. An implementation shall always try to return as much error information as possible. As an additional convenience, the constructor ScraperResult(Exception) can be used to easily convert runtime exceptions to a ScraperResult.

Constructors

ScraperResult(ScraperResultChallengeType, String, Byte[])

Creates a ChallengeResponseNeeded result.

Declaration

public ScraperResult(ScraperResultChallengeType nChallengeType, string sDisplayText, byte[] vbChallengeData)

Parameters

Type	Name	Description
ScraperResultChallengeType	nChallengeType
System.String	sDisplayText
System.Byte[]	vbChallengeData

ScraperResult(ScraperResultChallengeType, String, Byte[], String)

Creates a ChallengeResponseNeeded result.

Declaration

public ScraperResult(ScraperResultChallengeType nChallengeType, string sDisplayText, byte[] vbChallengeData, string sChallengeMimeType)

Parameters

Type	Name	Description
ScraperResultChallengeType	nChallengeType
System.String	sDisplayText
System.Byte[]	vbChallengeData
System.String	sChallengeMimeType

ScraperResult(ScraperResultCode, String, String)

Declaration

public ScraperResult(ScraperResultCode nCode, string sDisplayText = null, string sDiagnosticTrace = null)

Parameters

Type	Name	Description
ScraperResultCode	nCode	Value for Code.
System.String	sDisplayText	Value for DisplayText.
System.String	sDiagnosticTrace	Value for DiagnosticTrace.

ScraperResult(Exception)

Declaration

public ScraperResult(Exception x)

Parameters

Type	Name	Description
System.Exception	x

Fields

Failure

Unqualified failure result.

Declaration

public static readonly ScraperResult Failure

Field Value

Type	Description
ScraperResult

NotSupported

Indicates that the requested method is not supported.

Declaration

public static readonly ScraperResult NotSupported

Field Value

Type	Description
ScraperResult

Success

Declaration

public static readonly ScraperResult Success

Field Value

Type	Description
ScraperResult

Properties

ChallengeData

If the Code is ChallengeResponseNeeded, then this property provides the optional challenge data from the service.

Declaration

public byte[] ChallengeData { get; }

Property Value

Type	Description
System.Byte[]

Remarks

The interpretation of this data blob depends on the actual ChallengeType that is in effect. For some challenge/response methods this might even be null.

ChallengeMimeType

If the Code is ChallengeResponseNeeded, then this property indicates the MIME-type of the challenge data, if any, this might even be 'null'.

Declaration

public string ChallengeMimeType { get; }

Property Value

Type	Description
System.String

ChallengeType

If the Code is ChallengeResponseNeeded, then this property indicates the type of challenge/response mechanism that is used.

Declaration

public ScraperResultChallengeType ChallengeType { get; }

Property Value

Type	Description
ScraperResultChallengeType

Code

Success or failure code.

Declaration

public ScraperResultCode Code { get; }

Property Value

Type	Description
ScraperResultCode

DiagnosticTrace

Diagnostic trace output to be captured in a log file.

Declaration

public string DiagnosticTrace { get; }

Property Value

Type	Description
System.String

Remarks

This should not be displayed to the user, but should be available for supporting problems.

DisplayText

Error text to display to the user. This should be brief and carefully worded.

Declaration

public string DisplayText { get; }

Property Value

Type	Description
System.String

Remarks

Although this is optional and may be null, it should always be set for non-successful result. For a successful result it should be null.

IsSuccess

Declaration

public bool IsSuccess { get; }

Property Value

Type	Description
System.Boolean

Methods

SetChallenge(ScraperResultChallengeType, Byte[])

Declaration

public void SetChallenge(ScraperResultChallengeType nChallengeType, byte[] vbChallengeData)

Parameters

Type	Name	Description
ScraperResultChallengeType	nChallengeType
System.Byte[]	vbChallengeData

SetChallenge(ScraperResultChallengeType, Byte[], String)

Declaration

public void SetChallenge(ScraperResultChallengeType nChallengeType, byte[] vbChallengeData, string sChallengeMimeType)

Parameters

Type	Name	Description
ScraperResultChallengeType	nChallengeType
System.Byte[]	vbChallengeData
System.String	sChallengeMimeType