Interface IServerFileRetriever

Namespace

Acuit.Pinpoint.Configuration

Assembly

Acuit.Pinpoint.Configuration.dll

Represents a server file retriever.

public interface IServerFileRetriever

Methods

RetrieveFileAsync(string)

Asynchronously retrieves a file from the server, storing it to a temporary folder but retaining the original file name.

Task<string> RetrieveFileAsync(string serverFileName)

Parameters

serverFileName string

The name of the file on the server.

Returns

Task<string>

A task that represents the asynchronous operation. The value of its Result property contains the full path to the local file.

Exceptions

CommunicationException

A communication error occurred while attempting to retrieve the file from the server, or Acuit Pinpoint Server could not read the file. This will only occur asynchronously, wrapped in an AggregateException as the faulted task's Exception.

TimeoutException

Timed out while attempting to retrieve the file from the server. This will only occur asynchronously, wrapped in an AggregateException as the faulted task's Exception.