Waher.Things.ICommand Interface Reference

Interface for commands. More...

Inheritance diagram for Waher.Things.ICommand:

Public Member Functions
Task< string >	GetNameAsync (Language Language)
	Gets the displayable name of the command. More...
Task< string >	GetConfirmationStringAsync (Language Language)
	Gets a confirmation string, if any, of the command. If no confirmation is necessary, null, or the empty string can be returned. More...
Task< string >	GetFailureStringAsync (Language Language)
	Gets a failure string, if any, of the command. If no specific failure string is available, null, or the empty string can be returned. More...
Task< string >	GetSuccessStringAsync (Language Language)
	Gets a success string, if any, of the command. If no specific success string is available, null, or the empty string can be returned. More...
Task< bool >	CanExecuteAsync (RequestOrigin Caller)
	If the command can be executed by the caller. More...
Task	ExecuteCommandAsync ()
	Executes the command. More...
Task	StartQueryExecutionAsync (Query Query, Language Language)
	Starts the execution of a query. More...
ICommand	Copy ()
	Creates a copy of the command object. More...

Properties
string	CommandID [get]
	ID of command. More...
CommandType	Type [get]
	Type of command. More...
string	SortCategory [get]
	Sort Category, if available. More...
string	SortKey [get]
	Sort Key, if available. More...

Detailed Description

Interface for commands.

Definition at line 31 of file ICommand.cs.

Member Function Documentation

CanExecuteAsync()

Task< bool > Waher.Things.ICommand.CanExecuteAsync

(

RequestOrigin

Caller

)

If the command can be executed by the caller.

Parameters

Caller

Information about caller.

Returns

If the command can be executed by the caller.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, and Waher.Things.Xmpp.Commands.ReconnectCommand.

Copy()

ICommand Waher.Things.ICommand.Copy

(

)

Creates a copy of the command object.

Returns

Copy of command object.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Service.IoTBroker.Sources.Reports.Events.Commands.EventStatisticsCommand, Waher.Service.IoTBroker.Sources.Reports.Events.Commands.SearchEventsCommand, Waher.Service.IoTBroker.Sources.Reports.Performance.Commands.LockedObjectsCommand, Waher.Service.IoTBroker.Sources.Reports.Performance.Commands.SampleStatisticsCommand, Waher.Service.IoTBroker.Sources.Reports.Protocols.Commands.HttpStatisticsCommand, Waher.Service.IoTBroker.Sources.Reports.Protocols.Commands.XmppStatisticsCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.Files.Commands.ExecuteReportFileCommand, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, Waher.Things.Xmpp.Commands.ReconnectCommand, Waher.Things.Xmpp.Commands.ScanNode, Waher.Things.Xmpp.Commands.ScanRootSources, Waher.Things.Xmpp.Commands.ScanSource, and Waher.Things.Xmpp.Commands.SubscribeToPresence.

ExecuteCommandAsync()

Task Waher.Things.ICommand.ExecuteCommandAsync

(

)

Executes the command.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, Waher.Things.Xmpp.Commands.ReconnectCommand, Waher.Things.Xmpp.Commands.ScanNode, Waher.Things.Xmpp.Commands.ScanRootSources, Waher.Things.Xmpp.Commands.ScanSource, and Waher.Things.Xmpp.Commands.SubscribeToPresence.

GetConfirmationStringAsync()

Task< string > Waher.Things.ICommand.GetConfirmationStringAsync

(

Language

Language

)

Gets a confirmation string, if any, of the command. If no confirmation is necessary, null, or the empty string can be returned.

Parameters

Language

Language to use.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, and Waher.Things.Xmpp.Commands.ReconnectCommand.

GetFailureStringAsync()

Task< string > Waher.Things.ICommand.GetFailureStringAsync

(

Language

Language

)

Gets a failure string, if any, of the command. If no specific failure string is available, null, or the empty string can be returned.

Parameters

Language

Language to use.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, and Waher.Things.Xmpp.Commands.ReconnectCommand.

GetNameAsync()

Task< string > Waher.Things.ICommand.GetNameAsync

(

Language

Language

)

Gets the displayable name of the command.

Parameters

Language

Language to use.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Service.IoTBroker.Sources.Reports.Events.Commands.EventStatisticsCommand, Waher.Service.IoTBroker.Sources.Reports.Events.Commands.SearchEventsCommand, Waher.Service.IoTBroker.Sources.Reports.Performance.Commands.LockedObjectsCommand, Waher.Service.IoTBroker.Sources.Reports.Performance.Commands.SampleStatisticsCommand, Waher.Service.IoTBroker.Sources.Reports.Protocols.Commands.HttpStatisticsCommand, Waher.Service.IoTBroker.Sources.Reports.Protocols.Commands.XmppStatisticsCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, Waher.Things.Xmpp.Commands.ReconnectCommand, Waher.Things.Xmpp.Commands.ScanNode, Waher.Things.Xmpp.Commands.ScanRootSources, Waher.Things.Xmpp.Commands.ScanSource, and Waher.Things.Xmpp.Commands.SubscribeToPresence.

GetSuccessStringAsync()

Task< string > Waher.Things.ICommand.GetSuccessStringAsync

(

Language

Language

)

Gets a success string, if any, of the command. If no specific success string is available, null, or the empty string can be returned.

Parameters

Language

Language to use.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, and Waher.Things.Xmpp.Commands.ReconnectCommand.

StartQueryExecutionAsync()

Task Waher.Things.ICommand.StartQueryExecutionAsync	(	Query	Query,
		Language	Language
	)

Starts the execution of a query.

Parameters

Query	Query data receptor.
Language	Language to use.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Service.IoTBroker.Sources.Reports.Events.Commands.EventStatisticsCommand, Waher.Service.IoTBroker.Sources.Reports.Events.Commands.SearchEventsCommand, Waher.Service.IoTBroker.Sources.Reports.Performance.Commands.LockedObjectsCommand, Waher.Service.IoTBroker.Sources.Reports.Performance.Commands.SampleStatisticsCommand, Waher.Service.IoTBroker.Sources.Reports.Protocols.Commands.HttpStatisticsCommand, Waher.Service.IoTBroker.Sources.Reports.Protocols.Commands.XmppStatisticsCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.Files.Commands.ExecuteReportFileCommand, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, and Waher.Things.Xmpp.Commands.ReconnectCommand.

Property Documentation

CommandID

string Waher.Things.ICommand.CommandID

get

ID of command.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, Waher.Things.Xmpp.Commands.ReconnectCommand, Waher.Things.Xmpp.Commands.ScanNode, Waher.Things.Xmpp.Commands.ScanRootSources, Waher.Things.Xmpp.Commands.ScanSource, and Waher.Things.Xmpp.Commands.SubscribeToPresence.

Definition at line 36 of file ICommand.cs.

SortCategory

string Waher.Things.ICommand.SortCategory

get

Sort Category, if available.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, and Waher.Things.Xmpp.Commands.ReconnectCommand.

Definition at line 52 of file ICommand.cs.

SortKey

string Waher.Things.ICommand.SortKey

get

Sort Key, if available.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, and Waher.Things.Xmpp.Commands.ReconnectCommand.

Definition at line 60 of file ICommand.cs.

Type

CommandType Waher.Things.ICommand.Type

get

Type of command.

Implemented in Waher.Service.IoTBroker.Sources.GatewayConfig.EventSinkNodes.Commands.ClearQueueCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateFolderCommand, Waher.Service.IoTBroker.Sources.ProgramData.CreateTextFileCommand, Waher.Service.IoTBroker.Sources.ProgramData.EditTextCommand, Waher.Groups.Commands.ClearMessages, Waher.Groups.Commands.LogMessage, Waher.Jobs.Commands.ClearMessages, Waher.Jobs.Commands.ExecuteJob, Waher.Jobs.Commands.LogMessage, Waher.Output.Commands.ClearMessages, Waher.Output.Commands.LogMessage, Waher.Processors.Commands.ClearMessages, Waher.Processors.Commands.LogMessage, Waher.Reports.ExecuteReport, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsRoot, Waher.Things.Ieee1451.Ieee1451_1_6.DiscoverNcapsTopic, Waher.Things.Metering.Commands.ClearMessages, Waher.Things.Metering.Commands.LogMessage, Waher.Things.Script.ScriptCommand, Waher.Things.Script.ScriptQuery, Waher.Things.Xmpp.Commands.ConnectedDeviceCommand, Waher.Things.Xmpp.Commands.ReconnectCommand, Waher.Things.Xmpp.Commands.ScanNode, Waher.Things.Xmpp.Commands.ScanRootSources, Waher.Things.Xmpp.Commands.ScanSource, and Waher.Things.Xmpp.Commands.SubscribeToPresence.

Definition at line 44 of file ICommand.cs.

---

The documentation for this interface was generated from the following file:

• C:/My Projects/IoTGateway/Things/Waher.Things/ICommand.cs