Class ServerConfigurationExtensions

Namespace: Acuit.Pinpoint.Workstation.Configuration

Assembly: Acuit.Pinpoint.Workstation.Abstractions.dll

Extensions related to Acuit Pinpoint configuration sources.

public static class ServerConfigurationExtensions

Inheritance: object

ServerConfigurationExtensions

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

GetLocalFileNameAsync(IConfigurationRoot, string)

Asynchronously gets the full path to a local file for the specified configuration setting.

public static Task<string> GetLocalFileNameAsync(this IConfigurationRoot configuration, string key)

Parameters

configuration IConfigurationRoot
key string: The configuration key.

Returns

Task<string>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the full path to a local file.

RegisterServerFileRetriever(IServerFileRetriever) must be used to register an Acuit Pinpoint host computer file retriever before this can be called.

The configuration value retrieved via key is expected to be the full path to a file, accessible from the system on which it is configured. If the file resides on the Acuit Pinpoint host computer and this method is being called from Acuit Pinpoint Workstation, the file will be retrieved and stored locally.

Exceptions

ArgumentNullException: key is null.
InvalidOperationException: An Acuit Pinpoint host computer file retriever has not been registered, or the setting does not exist.
InvalidOperationException: The setting has no value.