Show / Hide Table of Contents

Class ConsoleCommand

Inheritance
object
ConsoleCommand
AddModule
ListModules
Implements
IConsoleCommand
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: DotNetNuke.Prompt
Assembly: DotNetNuke.dll
Syntax
public abstract class ConsoleCommand : IConsoleCommand

Constructors

ConsoleCommand()

Declaration
protected ConsoleCommand()

Properties

Args

Declaration
protected string[] Args { get; }
Property Value
Type Description
string[]

Flags

Declaration
protected IDictionary<string, string> Flags { get; }
Property Value
Type Description
IDictionary<string, string>

LocalResourceFile

Declaration
public abstract string LocalResourceFile { get; }
Property Value
Type Description
string

PortalId

Declaration
protected int PortalId { get; }
Property Value
Type Description
int

PortalSettings

Declaration
protected IPortalSettings PortalSettings { get; }
Property Value
Type Description
IPortalSettings

ResultHtml

Declaration
public virtual string ResultHtml { get; }
Property Value
Type Description
string

TabId

Declaration
protected int TabId { get; }
Property Value
Type Description
int

User

Declaration
protected IUserInfo User { get; }
Property Value
Type Description
IUserInfo

ValidationMessage

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

Methods

AddMessage(string)

Declaration
protected void AddMessage(string message)
Parameters
Type Name Description
string message

CreateMapping()

Declaration
protected virtual IList<ConsoleCommand.ParameterMapping> CreateMapping()
Returns
Type Description
IList<ConsoleCommand.ParameterMapping>

Initialize(string[], IPortalSettings, IUserInfo, int)

Declaration
public virtual void Initialize(string[] args, IPortalSettings portalSettings, IUserInfo userInfo, int activeTabId)
Parameters
Type Name Description
string[] args
IPortalSettings portalSettings
IUserInfo userInfo
int activeTabId

IsValid()

Declaration
public virtual bool IsValid()
Returns
Type Description
bool

LocalizeString(string)

Declaration
protected string LocalizeString(string key)
Parameters
Type Name Description
string key
Returns
Type Description
string

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

Run()

Declaration
public abstract IConsoleResultModel Run()
Returns
Type Description
IConsoleResultModel

Implements

IConsoleCommand

Extension Methods

JsonExtensionsWeb.ToJson(object)
Back to top by the community, for the community... #DNNCMS