Class UnmanagedBrowsingDatabaseExtension

Unmanaged Database Extension.

Inheritance

System.Object

UnmanagedBrowsingDatabaseExtension

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.Databases

Assembly: Gee.External.Browsing.dll

Syntax

public static class UnmanagedBrowsingDatabaseExtension

Methods

ComputeThreatListChecksumAsync(IUnmanagedBrowsingDatabase, ThreatListDescriptor)

Compute a Threat List's Checksum Asynchronously.

Declaration

public static Task<string> ComputeThreatListChecksumAsync(this IUnmanagedBrowsingDatabase this, ThreatListDescriptor threatListDescriptor)

Parameters

Type	Name	Description
IUnmanagedBrowsingDatabase	this	An IUnmanagedBrowsingDatabase.
ThreatListDescriptor	threatListDescriptor	A ThreatListDescriptor identifying the ThreatList whose checksum should be computed.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	The checksum, formatted as a hexadecimal encoded string, of the ThreatList identified by threatListDescriptor.

Exceptions

Type	Condition
BrowsingDatabaseException	Thrown if a database error occurs.
System.ArgumentNullException	Thrown if this is a null reference, or if threatListDescriptor is a null reference.
System.ObjectDisposedException	Thrown if this is disposed.

ComputeThreatListChecksumAsync(IUnmanagedBrowsingDatabase, ThreatListDescriptor, CancellationToken)

Compute a Threat List's Checksum Asynchronously.

Declaration

public static Task<string> ComputeThreatListChecksumAsync(this IUnmanagedBrowsingDatabase this, ThreatListDescriptor threatListDescriptor, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IUnmanagedBrowsingDatabase	this	An IUnmanagedBrowsingDatabase.
ThreatListDescriptor	threatListDescriptor	A ThreatListDescriptor identifying the ThreatList whose checksum should be computed.
System.Threading.CancellationToken	cancellationToken	A cancellation token to cancel the asynchronous operation with.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	The checksum, formatted as a hexadecimal encoded string, of the ThreatList identified by threatListDescriptor.

Exceptions

Type	Condition
BrowsingDatabaseException	Thrown if a database error occurs.
System.ArgumentNullException	Thrown if this is a null reference, or if threatListDescriptor is a null reference.
System.ObjectDisposedException	Thrown if this is disposed.
System.OperationCanceledException	Thrown if the asynchronous operation is cancelled.

FindThreatListsAsync(IUnmanagedBrowsingDatabase, String)

Find Threat Lists Asynchronously.

Declaration

public static Task<IReadOnlyCollection<ThreatList>> FindThreatListsAsync(this IUnmanagedBrowsingDatabase this, string threatSha256HashPrefix)

Parameters

Type	Name	Description
IUnmanagedBrowsingDatabase	this	An IUnmanagedBrowsingDatabase.
System.String	threatSha256HashPrefix	A SHA256 hash prefix, formatted as a hexadecimal encoded string, identifying a threat associated with the collection of ThreatList to retrieve.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<ThreatList>>	A collection of ThreatList the threat identified by threatSha256HashPrefix is associated with. An empty collection indicates no threat lists were found.

Exceptions

Type	Condition
BrowsingDatabaseException	Thrown if a database error occurs.
System.ArgumentNullException	Thrown if this is a null reference, or if threatSha256HashPrefix is a null reference.
System.ObjectDisposedException	Thrown if this is disposed.

GetThreatListAsync(IUnmanagedBrowsingDatabase, ThreatListDescriptor)

Get a Threat List Asynchronously.

Declaration

public static Task<ThreatList> GetThreatListAsync(this IUnmanagedBrowsingDatabase this, ThreatListDescriptor threatListDescriptor)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<ThreatList>	The ThreatList identified by threatListDescriptor. A null reference indicates a threat list could not be found.

Exceptions

Type	Condition
BrowsingDatabaseException	Thrown if a database error occurs.
System.ArgumentNullException	Thrown if this is a null reference, or if threatListDescriptor is a null reference.
System.ObjectDisposedException	Thrown if this is disposed.

GetThreatListsAsync(IUnmanagedBrowsingDatabase)

Get Threat Lists Asynchronously.

Declaration

public static Task<IReadOnlyCollection<ThreatList>> GetThreatListsAsync(this IUnmanagedBrowsingDatabase this)

Parameters

Type	Name	Description
IUnmanagedBrowsingDatabase	this	An IUnmanagedBrowsingDatabase.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<ThreatList>>	A collection of ThreatList. An empty collection indicates no threat lists were found.

Exceptions

Type	Condition
BrowsingDatabaseException	Thrown if a database error occurs.
System.ArgumentNullException	Thrown if this is a null reference.
System.ObjectDisposedException	Thrown if this is disposed.

GetThreatListsAsync(IUnmanagedBrowsingDatabase, IEnumerable<ThreatListDescriptor>)

Get Threat Lists Asynchronously.

Declaration

public static Task<IReadOnlyCollection<ThreatList>> GetThreatListsAsync(this IUnmanagedBrowsingDatabase this, IEnumerable<ThreatListDescriptor> threatListDescriptors)

Parameters

Type	Name	Description
IUnmanagedBrowsingDatabase	this	A browsing database.
System.Collections.Generic.IEnumerable<ThreatListDescriptor>	threatListDescriptors	A collection of threat list descriptors identifying the threat lists to retrieve.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<ThreatList>>	A collection of threat lists identified by the threat list descriptors contained in threatListDescriptors. The length of the collection is not guaranteed to equal the length of threatListDescriptors. More specifically, the collection will only contain threat lists that can be identified by a threat list descriptor contained in threatListDescriptors.

Exceptions

Type	Condition
BrowsingDatabaseException	Thrown if a database error occurs.
System.ObjectDisposedException	Thrown if the object is disposed.

GetThreatsAsync(IUnmanagedBrowsingDatabase, ThreatListDescriptor)

Get Threats Asynchronously.

Declaration

public static Task<IReadOnlyCollection<string>> GetThreatsAsync(this IUnmanagedBrowsingDatabase this, ThreatListDescriptor threatListDescriptor)

Parameters

Type	Name	Description
IUnmanagedBrowsingDatabase	this	An IUnmanagedBrowsingDatabase.
ThreatListDescriptor	threatListDescriptor	A ThreatListDescriptor identifying the ThreatList the threats that should be retrieved are associated with.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<System.String>>	A collection of SHA256 hash prefixes, formatted as hexadecimal encoded strings, identifying the threats that are associated with the ThreatList identified by threatListDescriptor. An empty collection indicates no threats were found.

Exceptions

Type	Condition
BrowsingDatabaseException	Thrown if a database error occurs.
System.ArgumentNullException	Thrown if this is a null reference, or if threatListDescriptor is a null reference.
System.ObjectDisposedException	Thrown if this is disposed.

LookupAsync(IUnmanagedBrowsingDatabase, Url)

Lookup a URL Asynchronously.

Declaration

public static Task<DatabaseLookupResult> LookupAsync(this IUnmanagedBrowsingDatabase this, Url url)

Parameters

Type	Name	Description
IUnmanagedBrowsingDatabase	this	A database.
Url	url	A URL to lookup.

Returns

Type	Description
System.Threading.Tasks.Task<DatabaseLookupResult>	A database lookup result indicating the nature of lookup operation.

Exceptions

Type	Condition
BrowsingDatabaseException	Thrown if a database error occurs.
System.ArgumentNullException	Thrown if this is a null reference, or if url is a null reference.
System.ObjectDisposedException	Thrown if this is disposed.