Click or drag to resize

Orthogonal.Hoarder.StdLib Namespace

Base namespace for the Trona Standard Library classes and interfaces.
Classes
 ClassDescription
Public classHoarderConfiguration

Encapsulates all possible configuration values for the Hoarder suite. The static LoadAsync(String) method can be used to deserialize an instance from a JSON file accessible at a specified Uri (which may be a http:// address or a local file:// address). The JSON file must have exactly the same schema as the fields in this class. A sample JSON file is provided in this project.

Five of the configuration values are secrets known only to the person testing or hosting the Hoarder suite. The secret values are deserialized from the JSON file if it defines them, then an overriding value for each secret is taken from an Environment variable if one exists. Environment variables can be used to provide the secrets for the suite when it is hosted in a trusted environment such as a local PC or web hosting.

Public classHoarderServiceClient A .NET client class for the Hoarder web service API. All methods, request bodies and response bodies are mapped to strongly-typed C# shared library classes.
Public classTestHelper A base class of helper methods for unit tests.
Public classUtility A static class of utility methods that may be useful anywhere within the Hoarder suite.
Public classWikiPageInfo Represents Wikipedia page information (just the Uri at the moment).
Public classWikiSearchResult Represents a short summary of Wikipedia search results.
Public classXmlSerializeHelper A helper class to serialize and deserialize Title documents and their sub-documents to and from XML.
Delegates
 DelegateDescription
Public delegateHoarderServiceClient.LoggerDelegate Defines a method signature that the client class can use as a logging sink.
Enumerations
 EnumerationDescription
Public enumerationRole Enumeration of official authorisation roles recognised by the application suite.