Class ThreatListUpdateQuery

Threat List Update Query.

Inheritance

System.Object

ThreatListUpdateQuery

Inherited Members

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

System.Object.GetType()

System.Object.MemberwiseClone()

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

Namespace: Gee.External.Browsing.Clients

Assembly: Gee.External.Browsing.dll

Syntax

public sealed class ThreatListUpdateQuery

Constructors

ThreatListUpdateQuery(ThreatListDescriptor)

Create a Threat List Update Query.

Declaration

public ThreatListUpdateQuery(ThreatListDescriptor threatListDescriptor)

Parameters

Type	Name	Description
ThreatListDescriptor	threatListDescriptor	A ThreatListDescriptor identifying the ThreatList to retrieve.

Exceptions

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

ThreatListUpdateQuery(ThreatListDescriptor, String)

Create a Threat List Update Query.

Declaration

public ThreatListUpdateQuery(ThreatListDescriptor threatListDescriptor, string threatListState)

Parameters

Type	Name	Description
ThreatListDescriptor	threatListDescriptor	A ThreatListDescriptor identifying the ThreatList to retrieve.
System.String	threatListState	The state, formatted as a hexadecimal encoded string, of the ThreatList identified by threatListDescriptor. This should be the value returned by the Google Safe Browsing API when the threat list was most recently retrieved. An invalid state will be ignored by the Google Safe Browsing API and will force the threat list to be retrieved as a Full update. A null reference indicates the state of the threat list is unknown and will force the threat list to be retrieved as a Full update.

Exceptions

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

ThreatListUpdateQuery(ThreatListDescriptor, String, ThreatListUpdateConstraints)

Create a Threat List Update Query.

Declaration

public ThreatListUpdateQuery(ThreatListDescriptor threatListDescriptor, string threatListState, ThreatListUpdateConstraints updateConstraints)

Parameters

Type	Name	Description
ThreatListDescriptor	threatListDescriptor	A ThreatListDescriptor identifying the ThreatList to retrieve.
System.String	threatListState	The state, formatted as a hexadecimal encoded string, of the ThreatList identified by threatListDescriptor. This should be the value returned by the Google Safe Browsing API when the threat list was most recently retrieved. An invalid state will be ignored by the Google Safe Browsing API and will force the threat list to be retrieved as a Full update. A null reference indicates the state of the threat list is unknown and will force the threat list to be retrieved as a Full update.
ThreatListUpdateConstraints	updateConstraints	The ThreatListUpdateConstraints to apply when the ThreatList identified by threatListDescriptor is retrieved. A null reference indicates no update constraints should be applied.

Exceptions

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

Properties

ThreatListDescriptor

Get Threat List Descriptor.

Declaration

public ThreatListDescriptor ThreatListDescriptor { get; }

Property Value

Type
ThreatListDescriptor

Remarks

Represents the ThreatListDescriptor identifying the ThreatList to retrieve.

ThreatListState

Get Threat List State.

Declaration

public string ThreatListState { get; }

Property Value

Type
System.String

Remarks

Represents the state, formatted as a hexadecimal encoded string, of the ThreatList identified by ThreatListDescriptor. A null reference indicates the state of the threat list is unknown and will force the threat list to be retrieved as a Full update.

UpdateConstraints

Get Update Constraints.

Declaration

public ThreatListUpdateConstraints UpdateConstraints { get; }

Property Value

Type
ThreatListUpdateConstraints

Remarks

Represents the ThreatListUpdateConstraints to apply when the ThreatList identified by ThreatListDescriptor is retrieved. A null reference indicates no update constraints should be applied.

Methods

Build()

Build a Threat List Update Query.

Declaration

public static ThreatListUpdateQueryBuilder Build()

Returns

Type	Description
ThreatListUpdateQueryBuilder	A ThreatListUpdateQueryBuilder to build the threat list update query with.

Equals(Object)

Determine if This Object is Equal to Another Object.

Declaration

public override bool Equals(object object)

Parameters

Type	Name	Description
System.Object	object	An object to compare to.

Returns

Type	Description
System.Boolean	A boolean true if the object is equal to object. A boolean false otherwise.

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Get Object's Hash Code.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	The object's hash code.

Overrides

System.Object.GetHashCode()

ToString()

Get Object's String Representation.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The object's string representation.

Overrides

System.Object.ToString()