IActivity Interface
Defines an Activity in a shell environment.
graph BT Type["IActivity"] class Type type-node Implementing0["IActivityWithTask"]-.->Type click Implementing0 "/SonghayCore/latest/Songhay.Abstractions/IActivityWithTask" Implementing1["IActivityWithOutput<TInput, TOutput>"]-.->Type click Implementing1 "/SonghayCore/latest/Songhay.Abstractions/IActivityWithOutput_2" Implementing2["IActivityWithTask<TInput>"]-.->Type click Implementing2 "/SonghayCore/latest/Songhay.Abstractions/IActivityWithTask_1" Implementing3["IActivityWithTask<TInput, TOutput>"]-.->Type click Implementing3 "/SonghayCore/latest/Songhay.Abstractions/IActivityWithTask_2" Implementing4["IActivityWithTaskOutput<TOutput>"]-.->Type click Implementing4 "/SonghayCore/latest/Songhay.Abstractions/IActivityWithTaskOutput_1"

Syntax

public interface IActivity

Remarks

For more detail, see “Songhay System Activities example” [https://github.com/BryanWilhite/Songhay.HelloWorlds.Activities]

Methods

Name Return Value Summary
DisplayHelp(ProgramArgs) string
Displays the conventional help text of the Activity.
Start(ProgramArgs) void
Start the Activity with the specified arguments.

Extension Methods

Name Value Summary
IsAssignableToISerializable<IActivity>() bool
Determines whether the specified type can be assigned to System.Runtime.Serialization.ISerializable.
StartActivity(ProgramArgs, TraceSource?, Func<TextWriter>?, bool) string
Starts the IActivity.
StartActivity(ProgramArgs, TraceSource?) string
Starts the IActivity.
StartActivityAsync(TraceSource?, Func<TextWriter>?, bool) Task<string>
Starts the IActivity, asynchronously.
StartActivityAsync(TraceSource?) Task<string>
Starts the IActivity, asynchronously.
StartActivityAsync<TInput, TOutput>(TInput, TraceSource?, Func<TextWriter>?) Task<ActivityOutput<TOutput>>
Starts the IActivity, asynchronously.
StartActivityAsync<TInput, TOutput>(TInput, TraceSource?) Task<ActivityOutput<TOutput>>
Starts the IActivity, asynchronously.
StartActivityAsync<TInput>(TInput, TraceSource?, Func<TextWriter>?, bool) Task<string>
Starts the IActivity, asynchronously.
StartActivityAsync<TInput>(TInput, TraceSource?) Task<string>
Starts the IActivity, asynchronously.
StartActivityForOutput<TInput, TOutput>(TInput, TraceSource?, Func<TextWriter>?, bool) ActivityOutput<TOutput>
Starts the IActivity for the specified output (TOutput).
StartActivityForOutput<TInput, TOutput>(TInput, TraceSource?) ActivityOutput<TOutput>
Starts the IActivity for the specified output (TOutput).
StartConsoleActivity(ProgramArgs, TraceSource?) void
Starts the IActivity with ConsoleTraceListener.
StartConsoleActivityAsync<TInput, TOutput>(TInput, TraceSource?) Task<TOutput>
Starts the IActivity, asynchronously with the specified ConsoleTraceListener.
StartConsoleActivityAsync<TInput>(TInput, TraceSource?) Task
Starts the IActivity, asynchronously with ConsoleTraceListener.
StartConsoleActivityForOutput<TInput, TOutput>(TInput, TraceSource?) TOutput
Starts the IActivity, synchronously with the specified ConsoleTraceListener.
ToActivityWithOutput<TInput, TOutput>() IActivityWithOutput<TInput, TOutput>
Converts the specified IActivity to IActivityWithOutput<TInput, TOutput>.
ToActivityWithTask() IActivityWithTask
Converts the specified IActivity to IActivityWithTask.
ToActivityWithTask<TInput, TOutput>() IActivityWithTask<TInput, TOutput>
Converts the specified IActivity to IActivityWithTask<TInput, TOutput>.
ToActivityWithTask<TInput>() IActivityWithTask<TInput>
Converts the specified IActivity to IActivityWithTask<TInput>.
ToActivityWithTaskOutput<TOutput>() IActivityWithTaskOutput<TOutput>
Converts the specified IActivity to IActivityWithTaskOutput<TOutput>.
ToObjectOrDbNull<IActivity>() object
Boxes the nullable in object or returns DBNull.
ToReferenceTypeValueOrThrow<IActivity>(string) T
Returns the non-null value of the specified, nullable reference type or throws an ArgumentNullException when the value is null.
WithConfiguration(IConfigurationRoot?) IActivity
Returns IActivity with IConfigurationRoot added when available.