Interface IUnmanagedBrowsingDatabase

Abstract Unmanaged Database.

Inherited Members
System.IDisposable.Dispose()
Namespace: Gee.External.Browsing.Databases
Assembly: Gee.External.Browsing.dll
Syntax
public interface IUnmanagedBrowsingDatabase : IDisposable

Methods

FindThreatListsAsync(String, CancellationToken)

Find Threat Lists Asynchronously.

Declaration
Task<IReadOnlyCollection<ThreatList>> FindThreatListsAsync(string threatSha256HashPrefix, CancellationToken cancellationToken)
Parameters
Type Name Description
System.String threatSha256HashPrefix

A SHA256 hash prefix, formatted as a hexadecimal encoded string, identifying a threat associated with the collection of ThreatList to retrieve.
System.Threading.CancellationToken cancellationToken

A cancellation token to cancel the asynchronous operation with.
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 threatSha256HashPrefix is a null reference.
System.ObjectDisposedException

Thrown if the object is disposed.
System.OperationCanceledException

Thrown if the asynchronous operation is cancelled.

GetThreatListAsync(ThreatListDescriptor, CancellationToken)

Get a Threat List Asynchronously.

Declaration
Task<ThreatList> GetThreatListAsync(ThreatListDescriptor threatListDescriptor, CancellationToken cancellationToken)
Parameters
Type Name Description
ThreatListDescriptor threatListDescriptor

A ThreatListDescriptor identifying the ThreatList to retrieve.
System.Threading.CancellationToken cancellationToken

A cancellation token to cancel the asynchronous operation with.
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 threatListDescriptor is a null reference.
System.ObjectDisposedException

Thrown if the object is disposed.
System.OperationCanceledException

Thrown if the asynchronous operation is cancelled.

GetThreatListsAsync(CancellationToken)

Get Threat Lists Asynchronously.

Declaration
Task<IReadOnlyCollection<ThreatList>> GetThreatListsAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

A cancellation token to cancel the asynchronous operation with.
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.ObjectDisposedException

Thrown if the object is disposed.
System.OperationCanceledException

Thrown if the asynchronous operation is cancelled.

GetThreatsAsync(ThreatListDescriptor, CancellationToken)

Get Threats Asynchronously.

Declaration
Task<IReadOnlyCollection<string>> GetThreatsAsync(ThreatListDescriptor threatListDescriptor, CancellationToken cancellationToken)
Parameters
Type Name Description
ThreatListDescriptor threatListDescriptor

A ThreatListDescriptor identifying the ThreatList the threats that should be retrieved are associated with.
System.Threading.CancellationToken cancellationToken

A cancellation token to cancel the asynchronous operation 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 threatListDescriptor is a null reference.
System.ObjectDisposedException

Thrown if the object is disposed.
System.OperationCanceledException

Thrown if the asynchronous operation is cancelled.

Extension Methods