Class FullHashRequest

Full Hash Request.

Inheritance

System.Object

FullHashRequest

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 FullHashRequest

Constructors

FullHashRequest(IEnumerable<String>, IEnumerable<FullHashQuery>)

Create a Full Hash Request.

Declaration

public FullHashRequest(IEnumerable<string> sha256HashPrefixes, IEnumerable<FullHashQuery> queries)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	sha256HashPrefixes	A collection of SHA256 hash prefixes, formatted as hexadecimal encoded strings, identifying the threats to query.
System.Collections.Generic.IEnumerable<FullHashQuery>	queries	A collection of FullHashQuery indicating the collection of ThreatList the threats identified by sha256HashPrefixes are associated with.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown if queries is a null reference, or if sha256HashPrefixes is a null reference.
System.FormatException	Thrown if sha256HashPrefixes contains a SHA256 hash prefix that is not hexadecimal encoded.

FullHashRequest(IEnumerable<String>, IEnumerable<FullHashQuery>, ClientMetadata)

Create a Full Hash Request.

Declaration

public FullHashRequest(IEnumerable<string> sha256HashPrefixes, IEnumerable<FullHashQuery> queries, ClientMetadata clientMetadata)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	sha256HashPrefixes	A collection of SHA256 hash prefixes, formatted as hexadecimal encoded strings, identifying the threats to query.
System.Collections.Generic.IEnumerable<FullHashQuery>	queries	A collection of FullHashQuery indicating the collection of ThreatList the threats identified by sha256HashPrefixes are associated with.
ClientMetadata	clientMetadata	The ClientMetadata of the client making the full hash request. A null reference indicates the metadata of the client is unknown.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown if queries is a null reference, or if sha256HashPrefixes is a null reference.
System.FormatException	Thrown if sha256HashPrefixes contains a SHA256 hash prefix that is not hexadecimal encoded.

Properties

ClientMetadata

Get Client Metadata.

Declaration

public ClientMetadata ClientMetadata { get; }

Property Value

Type
ClientMetadata

Remarks

Represents the ClientMetadata of the client making the full hash request.

Queries

Get Queries.

Declaration

public IEnumerable<FullHashQuery> Queries { get; }

Property Value

Type
System.Collections.Generic.IEnumerable<FullHashQuery>

Remarks

Represents the collection of FullHashQuery indicating the collection of ThreatList the threats identified by Sha256HashPrefixes are associated with.

Sha256HashPrefixes

Get and Set SHA256 Hash Prefixes.

Declaration

public IEnumerable<string> Sha256HashPrefixes { get; }

Property Value

Type
System.Collections.Generic.IEnumerable<System.String>

Remarks

Represents the collection of SHA256 hash prefixes, formatted as hexadecimal encoded strings, identifying the threats to query.

Methods

Build()

Build a Full Hash Request.

Declaration

public static FullHashRequestBuilder Build()

Returns

Type	Description
FullHashRequestBuilder	A FullHashRequestBuilder to build a full hash request with.