Interface IPinpointFileService

Namespace

Acuit.Pinpoint.Services.Client

Assembly

Acuit.Pinpoint.Services.Client.dll

The Acuit Pinpoint file retrieval service.

public interface IPinpointFileService

Methods

RetrieveFile(string)

Retrieves a file from Acuit Pinpoint.

Stream RetrieveFile(string serverFileName)

Parameters

serverFileName string

The name of the file on the Acuit Pinpoint server.

Returns

Stream

A Stream from which the file contents can be read.

Remarks

With Acuit Pinpoint versions 7.1.87 and later, serverFileName can include environment variables quoted with the percent sign character (%).

Exceptions

FaultException<TDetail>

serverFileName is null.

FaultException<TDetail>

The serverFileName is an empty string, contains only white space, or contains one or more invalid characters.

FaultException<TDetail>

An I/O error occurred while opening the file.

FaultException<TDetail>

serverFileName specified a directory.

FaultException<TDetail>

The Acuit Pinpoint server process does not have the required permission to read the file.

FaultException<TDetail>

serverFileName is in an invalid format.

CommunicationException

A communication error occurred.

TimeoutException

A communication timeout error occurred.

RetrieveFileAsync(string)

Retrieves a file from Acuit Pinpoint.

Task<Stream> RetrieveFileAsync(string serverFileName)

Parameters

serverFileName string

The name of the file on the Acuit Pinpoint server.

Returns

Task<Stream>

The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a Stream from which the file contents can be read.

With Acuit Pinpoint versions 7.1.87 and later, serverFileName can include environment variables quoted with the percent sign character (%).

Exceptions

FaultException<TDetail>

serverFileName is null.

FaultException<TDetail>

The serverFileName is an empty string, contains only white space, or contains one or more invalid characters.

FaultException<TDetail>

An I/O error occurred while opening the file.

FaultException<TDetail>

serverFileName specified a directory.

FaultException<TDetail>

The Acuit Pinpoint server process does not have the required permission to read the file.

FaultException<TDetail>

serverFileName is in an invalid format.

CommunicationException

A communication error occurred.

TimeoutException

A communication timeout error occurred.