Show / Hide Table of Contents

Interface IBrowsingClient

Abstract Client.

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

Methods

FindFullHashesAsync(FullHashRequest, CancellationToken)

Find Full Hashes Asynchronously.

Declaration
Task<FullHashResponse> FindFullHashesAsync(FullHashRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
FullHashRequest request

A FullHashRequest.

System.Threading.CancellationToken cancellationToken

A cancellation token to cancel the asynchronous operation with.

Returns
Type Description
System.Threading.Tasks.Task<FullHashResponse>

A FullHashResponse.

Exceptions
Type Condition
BrowsingClientException

Thrown if an error communicating with the Google Safe Browsing API occurs.

System.ArgumentNullException

Thrown if request is a null reference.

System.ObjectDisposedException

Thrown if the object is disposed.

System.OperationCanceledException

Thrown if the asynchronous operation is cancelled.

System.TimeoutException

Thrown if communication with the Google Safe Browsing API times out.

GetThreatListDescriptorsAsync(CancellationToken)

Get Threat List Descriptors Asynchronously.

Declaration
Task<IEnumerable<ThreatListDescriptor>> GetThreatListDescriptorsAsync(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.IEnumerable<ThreatListDescriptor>>

A collection of ThreatListDescriptor.

Exceptions
Type Condition
BrowsingClientException

Thrown if an error communicating with the Google Safe Browsing API occurs.

System.ObjectDisposedException

Thrown if the object is disposed.

System.OperationCanceledException

Thrown if the asynchronous operation is cancelled.

System.TimeoutException

Thrown if communication with the Google Safe Browsing API times out.

GetThreatListUpdatesAsync(ThreatListUpdateRequest, CancellationToken)

Get Threat List Updates Asynchronously.

Declaration
Task<ThreatListUpdateResponse> GetThreatListUpdatesAsync(ThreatListUpdateRequest request, CancellationToken cancellationToken)
Parameters
Type Name Description
ThreatListUpdateRequest request

A ThreatListUpdateRequest.

System.Threading.CancellationToken cancellationToken

A cancellation token to cancel the asynchronous operation with.

Returns
Type Description
System.Threading.Tasks.Task<ThreatListUpdateResponse>

A ThreatListUpdateResponse.

Exceptions
Type Condition
BrowsingClientException

Thrown if an error communicating with the Google Safe Browsing API occurs.

System.ArgumentNullException

Thrown if request is a null reference.

System.ObjectDisposedException

Thrown if the object is disposed.

System.OperationCanceledException

Thrown if the asynchronous operation is cancelled.

System.TimeoutException

Thrown if communication with the Google Safe Browsing API times out.

Extension Methods

BrowsingClientExtension.FindFullHashesAsync(IBrowsingClient, FullHashRequest)
BrowsingClientExtension.FindFullHashesAsync(IBrowsingClient, String, IEnumerable<ThreatList>)
BrowsingClientExtension.FindFullHashesAsync(IBrowsingClient, String, IEnumerable<ThreatList>, CancellationToken)
BrowsingClientExtension.GetThreatListDescriptorsAsync(IBrowsingClient)
BrowsingClientExtension.GetThreatListUpdatesAsync(IBrowsingClient, ThreatListUpdateRequest)
BrowsingClientExtension.GetThreatListUpdatesAsync(IBrowsingClient, IEnumerable<ThreatList>)
BrowsingClientExtension.GetThreatListUpdatesAsync(IBrowsingClient, IEnumerable<ThreatList>, CancellationToken)
BrowsingClientExtension.GetThreatListUpdatesAsync(IBrowsingClient, ThreatList, ThreatListUpdateConstraints)
BrowsingClientExtension.GetThreatListUpdatesAsync(IBrowsingClient, ThreatList, ThreatListUpdateConstraints, CancellationToken)
Back to top Generated by DocFX