Class ThreatListUpdateResult

Threat List Update Result.

Inheritance

System.Object

ThreatListUpdateResult

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 ThreatListUpdateResult

Properties

IsFullUpdate

Determine if Threat List Was Retrieved as a Full Update.

Declaration

public bool IsFullUpdate { get; }

Property Value

Type
System.Boolean

Remarks

Determines if the RetrievedThreatList was retrieved from the Google Safe Browsing API as a Full update.

IsPartialUpdate

Determine if Threat List Was Retrieved as a Partial Update.

Declaration

public bool IsPartialUpdate { get; }

Property Value

Type
System.Boolean

Remarks

Determines if the RetrievedThreatList was retrieved from the Google Safe Browsing API as a Partial update.

Query

Get Query.

Declaration

public ThreatListUpdateQuery Query { get; }

Property Value

Type
ThreatListUpdateQuery

Remarks

Represents the ThreatListUpdateQuery made to the Google Safe Browsing API for which the threat list update result has been returned.

RetrievedThreatList

Get Retrieved Threat List.

Declaration

public ThreatList RetrievedThreatList { get; }

Property Value

Type
ThreatList

Remarks

Represents the ThreatList retrieved from the Google Safe Browsing API.

RetrievedThreatListChecksum

Get Retrieved Threat List's Checksum.

Declaration

public string RetrievedThreatListChecksum { get; }

Property Value

Type
System.String

Remarks

Represents the checksum, formatted as a hexadecimal encoded string, of the lexicographically sorted RetrievedThreatList.

ThreatsToAdd

Get Threats to Add.

Declaration

public IReadOnlyCollection<string> ThreatsToAdd { get; }

Property Value

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

Remarks

Represents the collection of SHA256 hash prefixes, formatted as hexadecimal encoded strings, identifying the threats associated with the RetrievedThreatList and should be added to the locally stored copy of the ThreatList. An empty collection indicates there are no threats to add.

ThreatsToRemove

Get Threats to Remove.

Declaration

public IReadOnlyCollection<int> ThreatsToRemove { get; }

Property Value

Type
System.Collections.Generic.IReadOnlyCollection<System.Int32>

Remarks

Represents the collection of zero-based indices identifying the threats associated with the lexicographically sorted RetrievedThreatList and should be removed from the locally stored copy of the ThreatList if, and only if, the threat list was retrieved as a Partial update. To determine if the threat list was retrieved as a partial update, call IsPartialUpdate. An empty collection indicates there are no threats to remove.

Exceptions

Type	Condition
System.InvalidOperationException	Thrown if the threat list was not retrieved as a Partial update.

UpdateType

Get Update Type.

Declaration

public ThreatListUpdateType UpdateType { get; }

Property Value

Type
ThreatListUpdateType

Remarks

Represents the ThreatListUpdateType indicating how the RetrievedThreatList was retrieved from the Google Safe Browsing API. You can also conveniently use IsFullUpdate and IsPartialUpdate.

Methods

Build()

Build a Threat List Update Result.

Declaration

public static ThreatListUpdateResultBuilder Build()

Returns

Type	Description
ThreatListUpdateResultBuilder	A ThreatListUpdateResultBuilder to build a threat list update result with.