csharp.IReadableConfiguration.mustache Maven / Gradle / Ivy

Go to download
{{>partial_header}}

using System.Collections.Generic;

namespace {{packageName}}.Client
{
    /// 
    /// Represents a readable-only configuration contract.
    /// 
    public interface IReadableConfiguration
    {
        /// 
        /// Gets the access token.
        /// 
        /// Access token.
        string AccessToken { get; }

        /// 
        /// Gets the API key.
        /// 
        /// API key.
        IDictionary ApiKey { get; }

        /// 
        /// Gets the API key prefix.
        /// 
        /// API key prefix.
        IDictionary ApiKeyPrefix { get; }

        /// 
        /// Gets the base path.
        /// 
        /// Base path.
        string BasePath { get; }

        /// 
        /// Gets the date time format.
        /// 
        /// Date time foramt.
        string DateTimeFormat { get; }

        /// 
        /// Gets the default header.
        /// 
        /// Default header.
        IDictionary DefaultHeader { get; }

        /// 
        /// Gets the temp folder path.
        /// 
        /// Temp folder path.
        string TempFolderPath { get; }

        /// 
        /// Gets the HTTP connection timeout (in milliseconds)
        /// 
        /// HTTP connection timeout.
        int Timeout { get; }

        /// 
        /// Gets the user agent.
        /// 
        /// User agent.
        string UserAgent { get; }

        /// 
        /// Gets the username.
        /// 
        /// Username.
        string Username { get; }

        /// 
        /// Gets the password.
        /// 
        /// Password.
        string Password { get; }

        /// 
        /// Gets the API key with prefix.
        /// 
        /// API key identifier (authentication scheme).
        /// API key with prefix.
        string GetApiKeyWithPrefix(string apiKeyIdentifier);
    }
}