Class ConsoleCommand

Inheritance
System.Object
ConsoleCommand
AddModule
ListModules
Implements
Namespace: DotNetNuke.Prompt
Assembly: DotNetNuke.dll
Syntax
public abstract class ConsoleCommand : object, IConsoleCommand

Properties

| Improve this Doc View Source

Args

Declaration
protected string[] Args { get; }
Property Value
Type Description
System.String[]
| Improve this Doc View Source

Flags

Declaration
protected IDictionary<string, string> Flags { get; }
Property Value
Type Description
IDictionary<System.String, System.String>
| Improve this Doc View Source

LocalResourceFile

Declaration
public abstract string LocalResourceFile { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PortalId

Declaration
protected int PortalId { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PortalSettings

Declaration
protected IPortalSettings PortalSettings { get; }
Property Value
Type Description
IPortalSettings
| Improve this Doc View Source

ResultHtml

Gets resource key for the result html.

Declaration
public virtual string ResultHtml { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

TabId

Declaration
protected int TabId { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

User

Declaration
protected IUserInfo User { get; }
Property Value
Type Description
IUserInfo
| Improve this Doc View Source

ValidationMessage

Declaration
public string ValidationMessage { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

AddMessage(String)

Declaration
protected void AddMessage(string message)
Parameters
Type Name Description
System.String message
| Improve this Doc View Source

CreateMapping()

Declaration
protected virtual IList<ConsoleCommand.ParameterMapping> CreateMapping()
Returns
Type Description
IList<ConsoleCommand.ParameterMapping>
| Improve this Doc View Source

Initialize(String[], IPortalSettings, IUserInfo, Int32)

Declaration
public virtual void Initialize(string[] args, IPortalSettings portalSettings, IUserInfo userInfo, int activeTabId)
Parameters
Type Name Description
System.String[] args
IPortalSettings portalSettings
IUserInfo userInfo
System.Int32 activeTabId
| Improve this Doc View Source

IsValid()

Declaration
public virtual bool IsValid()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LocalizeString(String)

Declaration
protected string LocalizeString(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
System.String
| Improve this Doc View Source

ParseParameters<T>(T)

Declaration
protected void ParseParameters<T>(T myCommand)
    where T : class, new()
Parameters
Type Name Description
T myCommand
Type Parameters
Name Description
T
| Improve this Doc View Source

Run()

The main method of the command which executes it.

Declaration
public abstract IConsoleResultModel Run()
Returns
Type Description
IConsoleResultModel

A class used by the client to display results.

Implements

Extension Methods