Class FullHashRequestBuilder

Full Hash Request Builder.

Inheritance

System.Object

FullHashRequestBuilder

Inherited Members

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: Gee.External.Browsing.Clients

Assembly: Gee.External.Browsing.dll

Syntax

public sealed class FullHashRequestBuilder

Methods

AddQuery(FullHashQuery)

Add a Query.

Declaration

public FullHashRequestBuilder AddQuery(FullHashQuery value)

Parameters

Type	Name	Description
FullHashQuery	value	A FullHashQuery indicating a ThreatList to query.

Returns

Type	Description
FullHashRequestBuilder	This full hash request builder.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown if value is a null reference.

AddQuery(ThreatListDescriptor, String)

Add a Query.

Declaration

public FullHashRequestBuilder AddQuery(ThreatListDescriptor threatListDescriptor, string threatListState)

Parameters

Type	Name	Description
ThreatListDescriptor	threatListDescriptor	A ThreatListDescriptor identifying the ThreatList to query.
System.String	threatListState	The state, formatted as a hexadecimal encoded string, of the ThreatList identified by threatListDescriptor.

Returns

Type	Description
FullHashRequestBuilder	This full hash request builder.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown if threatListDescriptor is a null reference, or if threatListState is a null reference.
System.FormatException	Thrown if threatListState is not hexadecimal encoded.

AddQuery(ThreatType, PlatformType, ThreatEntryType, String)

Add Query.

Declaration

public FullHashRequestBuilder AddQuery(ThreatType threatType, PlatformType platformType, ThreatEntryType threatEntryType, string threatListState)

Parameters

Type	Name	Description
ThreatType	threatType	A ThreatType identifying the ThreatList to query.
PlatformType	platformType	A PlatformType identifying the ThreatList to query.
ThreatEntryType	threatEntryType	A ThreatEntryType identifying the ThreatList to query.
System.String	threatListState	The state, formatted as a hexadecimal encoded string, of the ThreatList identified by threatType, platformType, and threatEntryType.

Returns

Type	Description
FullHashRequestBuilder	This full hash request builder.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown if threatListState is a null reference.
System.FormatException	Thrown if threatListState is not hexadecimal encoded.

AddSha256HashPrefix(String)

Add a SHA256 Hash Prefix.

Declaration

public FullHashRequestBuilder AddSha256HashPrefix(string value)

Parameters

Type	Name	Description
System.String	value	A SHA256 hash prefix, formatted as hexadecimal encoded string, identifying a threat to query.

Returns

Type	Description
FullHashRequestBuilder	This full hash request builder.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown if value is a null reference.
System.FormatException	Thrown if value is not hexadecimal encoded.

Build()

Build a Full Hash Request.

Declaration

public FullHashRequest Build()

Returns

Type	Description
FullHashRequest	A FullHashRequest.

SetClientMetadata(ClientMetadata)

Set Client Metadata.

Declaration

public FullHashRequestBuilder SetClientMetadata(ClientMetadata value)

Parameters

Type	Name	Description
ClientMetadata	value	The ClientMetadata of the client making the full hash request. A null reference indicates the metadata of the client is unknown.

Returns

Type	Description
FullHashRequestBuilder	This full hash request builder.

SetClientMetadata(String, Int32, Int32, Int32)

Set Client Metadata.

Declaration

public FullHashRequestBuilder SetClientMetadata(string id, int majorVersion, int minorVersion, int patchVersion)

Parameters

Type	Name	Description
System.String	id	A unique identifier identifying the client.
System.Int32	majorVersion	The client's major version.
System.Int32	minorVersion	The client's minor version.
System.Int32	patchVersion	The client's patch version.

Returns

Type	Description
FullHashRequestBuilder	This full hash request builder.

Exceptions

Type	Condition
System.ArgumentException	Thrown if id consists exclusively of whitespace characters.
System.ArgumentNullException	Thrown if id is a null reference.
System.ArgumentOutOfRangeException	Thrown if majorVersion is less than 0, or if minorVersion is less than 0, or if patchVersion is less than 0.