Class ConsoleProgram<TApp>

Inheritance

object

ConsoleToolBase

ConsoleProgram<TApp>

Implements

IDisposable

Inherited Members

ConsoleToolBase.Read()

ConsoleToolBase.PressAnyKey()

ConsoleToolBase.WriteSuccess(string)

ConsoleToolBase.WriteSuccessLine(string)

ConsoleToolBase.WriteTitle(string)

ConsoleToolBase.WriteTitleLine(string)

ConsoleToolBase.WriteInfo(string)

ConsoleToolBase.WriteInfoLine(string)

ConsoleToolBase.WriteError(string)

ConsoleToolBase.WriteErrorLine(string)

ConsoleToolBase.Write(string)

ConsoleToolBase.WriteLine(string)

ConsoleToolBase.WriteColor(string, ConsoleColor)

ConsoleToolBase.WriteColorLine(string, ConsoleColor)

ConsoleToolBase.SuccessColor

ConsoleToolBase.TitleColor

ConsoleToolBase.InfoColor

ConsoleToolBase.ErrorColor

ConsoleToolBase.ForegroundColor

ConsoleToolBase.ExitCode

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: PayrollEngine.Client

Assembly: PayrollEngine.Client.Core.dll

Syntax

public abstract class ConsoleProgram<TApp> : ConsoleToolBase, IDisposable where TApp : class

Type Parameters

Name	Description
TApp

Constructors

ConsoleProgram(ProgramConfigurationOptions)

Declaration

protected ConsoleProgram(ProgramConfigurationOptions configurationOptions = ProgramConfigurationOptions.Default)

Parameters

Type	Name	Description
ProgramConfigurationOptions	configurationOptions

Properties

Configuration

Declaration

protected ProgramConfiguration<TApp> Configuration { get; }

Property Value

Type	Description
ProgramConfiguration<TApp>

DefaultCultureName

Declaration

protected virtual string DefaultCultureName { get; }

Property Value

Type	Description
string

HttpClient

Declaration

protected PayrollHttpClient HttpClient { get; }

Property Value

Type	Description
PayrollHttpClient

LogErrors

Declaration

protected virtual bool LogErrors { get; }

Property Value

Type	Description
bool

LogLifecycle

Declaration

protected virtual bool LogLifecycle { get; }

Property Value

Type	Description
bool

MandatoryArgumentCount

Declaration

protected virtual int MandatoryArgumentCount { get; }

Property Value

Type	Description
int

ShowConnectionInfo

Declaration

protected virtual bool ShowConnectionInfo { get; }

Property Value

Type	Description
bool

ShowErrorExitCode

Declaration

protected virtual bool ShowErrorExitCode { get; }

Property Value

Type	Description
bool

ShowProgramTitle

Declaration

protected virtual bool ShowProgramTitle { get; }

Property Value

Type	Description
bool

UseHelpArgument

Declaration

protected virtual bool UseHelpArgument { get; }

Property Value

Type	Description
bool

WaitOnError

Declaration

protected virtual bool WaitOnError { get; }

Property Value

Type	Description
bool

Methods

Dispose()

Declaration

public void Dispose()

ExecuteAsync()

Declaration

public virtual Task ExecuteAsync()

Returns

Type	Description
Task

FullErrorLog()

Declaration

protected virtual bool FullErrorLog()

Returns

Type	Description
bool

GetHttpClientHandlerAsync()

Declaration

protected virtual Task<HttpClientHandler> GetHttpClientHandlerAsync()

Returns

Type	Description
Task<HttpClientHandler>

GetHttpConfigurationAsync()

Declaration

protected virtual Task<PayrollHttpConfiguration> GetHttpConfigurationAsync()

Returns

Type	Description
Task<PayrollHttpConfiguration>

GetProgramCopyright()

Declaration

protected virtual string GetProgramCopyright()

Returns

Type	Description
string

GetProgramCultureAsync()

Declaration

protected virtual Task<string> GetProgramCultureAsync()

Returns

Type	Description
Task<string>

GetProgramTitle()

Declaration

protected virtual string GetProgramTitle()

Returns

Type	Description
string

GetProgramVersion()

Declaration

protected virtual string GetProgramVersion()

Returns

Type	Description
string

HelpAsync()

Declaration

protected virtual Task HelpAsync()

Returns

Type	Description
Task

InitializeAsync()

Declaration

protected virtual Task<bool> InitializeAsync()

Returns

Type	Description
Task<bool>

NotifyConnectionErrorAsync()

Declaration

protected virtual Task NotifyConnectionErrorAsync()

Returns

Type	Description
Task

NotifyErrorAsync(Exception)

Declaration

protected virtual Task NotifyErrorAsync(Exception exception)

Parameters

Type	Name	Description
Exception	exception

Returns

Type	Description
Task

NotifyErrorAsync(string)

Declaration

protected virtual Task NotifyErrorAsync(string error)

Parameters

Type	Name	Description
string	error

Returns

Type	Description
Task

NotifyGlobalErrorAsync(Exception)

Declaration

protected virtual Task NotifyGlobalErrorAsync(Exception exception)

Parameters

Type	Name	Description
Exception	exception

Returns

Type	Description
Task

OnInvalidHttpConfiguration(PayrollHttpConfiguration)

Declaration

protected virtual void OnInvalidHttpConfiguration(PayrollHttpConfiguration _)

Parameters

Type	Name	Description
PayrollHttpConfiguration	_

OnMissingHttpConfiguration()

Declaration

protected virtual void OnMissingHttpConfiguration()

RunAsync()

Declaration

protected abstract Task RunAsync()

Returns

Type	Description
Task

SetupHttpClientAsync()

Declaration

protected virtual Task<bool> SetupHttpClientAsync()

Returns

Type	Description
Task<bool>

SetupLogAsync()

Declaration

protected virtual Task SetupLogAsync()

Returns

Type	Description
Task

ShowTitleAsync()

Declaration

protected virtual Task ShowTitleAsync()

Returns

Type	Description
Task

ShutdownAsync()

Declaration

protected virtual Task ShutdownAsync()

Returns

Type	Description
Task

UseHttpClient()

Declaration

protected virtual bool UseHttpClient()

Returns

Type	Description
bool

Implements

IDisposable

Extension Methods

ConsoleExtensions.WriteProperties(object, bool)

ValueTypeExtensions.GetValueType(object)

ObjectInfo.GetPropertyValue(object, string)

ObjectInfo.GetPropertyValue<T>(object, string, T)

ObjectInfo.ResolvePropertyValue(object, string)

ObjectInfo.SetPropertyValue(object, string, object)