RemoteCommand
Overview
Provides the ability to dynamically invoke a Command from the server's Schema.
By default, the standard DataAbstractService class is configured to prevent execution of arbitrary commands from the client, as this poses a possible security risk, depending on what kind of commands are defined on your schema.
To enable execution of commands form the client, set the AllowExecuteCommand property of your DataAbstractService to true and ensure that all published Commands in your schema are safe for execution. Also, you need to have proper authentication methods in place to prevent anonymous users from making malicious calls.
Location
- Reference: RemObjects.DataAbstract.dll
- Namespace: RemObjects.DataAbstract
- Ancestry: BaseComponent | BaseCommand | RemoteCommand
constructor
constructor
RemoteCommand()
Sub New
constructor (IContainer)
constructor(container: IContainer)
RemoteCommand(IContainer container)
Sub New (container As IContainer)
Parameters:
- container:
add_AfterExecuteCommand
method add_AfterExecuteCommand(value: EventHandler<RemoteCommandAfteExecuteEventArgs>)
void add_AfterExecuteCommand(EventHandler<RemoteCommandAfteExecuteEventArgs> value)
Sub add_AfterExecuteCommand(value As EventHandler<RemoteCommandAfteExecuteEventArgs>)
Parameters:
- value:
add_BeforeExecuteCommand
method add_BeforeExecuteCommand(value: EventHandler<RemoteCommandEventArgs>)
void add_BeforeExecuteCommand(EventHandler<RemoteCommandEventArgs> value)
Sub add_BeforeExecuteCommand(value As EventHandler<RemoteCommandEventArgs>)
Parameters:
- value:
AfterExecuteCommand
event AfterExecuteCommand: EventHandler<RemoteCommandAfteExecuteEventArgs>;
delegate EventHandler<RemoteCommandAfteExecuteEventArgs> AfterExecuteCommand()
Event AfterExecuteCommand As EventHandler<RemoteCommandAfteExecuteEventArgs>
BeforeExecuteCommand
event BeforeExecuteCommand: EventHandler<RemoteCommandEventArgs>;
delegate EventHandler<RemoteCommandEventArgs> BeforeExecuteCommand()
Event BeforeExecuteCommand As EventHandler<RemoteCommandEventArgs>
CATEGORY_COMMUNICATION protected (declared in BaseCommand)
const CATEGORY_COMMUNICATION: String = "Communication";
const String CATEGORY_COMMUNICATION = "Communication"
Dim CATEGORY_COMMUNICATION As String = "Communication"
CATEGORY_DYNAMIC_METHOD_BINDING protected (declared in BaseCommand)
const CATEGORY_DYNAMIC_METHOD_BINDING: String = "Dynamic Method Binding";
const String CATEGORY_DYNAMIC_METHOD_BINDING = "Dynamic Method Binding"
Dim CATEGORY_DYNAMIC_METHOD_BINDING As String = "Dynamic Method Binding"
CATEGORY_OPTIONS protected (declared in BaseCommand)
const CATEGORY_OPTIONS: String = "Options";
const String CATEGORY_OPTIONS = "Options"
Dim CATEGORY_OPTIONS As String = "Options"
CATEGORY_STREAMING protected (declared in BaseCommand)
const CATEGORY_STREAMING: String = "Streaming";
const String CATEGORY_STREAMING = "Streaming"
Dim CATEGORY_STREAMING As String = "Streaming"
Execute (String): Int32 (declared in BaseCommand)
method Execute(commandName: String): Int32
Int32 Execute(String commandName)
Function Execute(commandName As String) As Int32
Parameters:
- commandName:
Execute (String, array of DataParameter): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameters: array of DataParameter): Int32
Int32 Execute(String commandName, DataParameter[] parameters)
Function Execute(commandName As String, parameters As array of DataParameter) As Int32
Parameters:
- commandName:
- parameters:
Execute (String, array of DataParameter, DataParameter): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameters: array of DataParameter; out output: DataParameter): Int32
Int32 Execute(String commandName, DataParameter[] parameters, out DataParameter output)
Function Execute(commandName As String, parameters As array of DataParameter, <OutAttribute> ByRef output As DataParameter) As Int32
Parameters:
- commandName:
- parameters:
- output:
Execute (String, array of String, array of Object): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object): Int32
Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues)
Function Execute(commandName As String, parameterNames As array of String, parameterValues As array of Object) As Int32
Parameters:
- commandName:
- parameterNames:
- parameterValues:
Execute (String, array of String, array of Object, String, Object): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object; out outputNames: String; out outputValues: Object): Int32
Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues, out String outputNames, out Object outputValues)
Function Execute(commandName As String, parameterNames As array of String, parameterValues As array of Object, <OutAttribute> ByRef outputNames As String, <OutAttribute> ByRef outputValues As Object) As Int32
Parameters:
- commandName:
- parameterNames:
- parameterValues:
- outputNames:
- outputValues:
ExecuteCall
The DynamicRequest that will be used to invoke the Command on the server. By default, it will be mapped to the ExecuteCommand call as defined in the IDataAbstractService implemented by standard Data Abstract 4.0 servers. When using a custom server interface, you can change its sub-properties to control how the data update call is made.
property ExecuteCall: RemoteCommandRequest read;
RemoteCommandRequest ExecuteCall { get; }
Property ReadOnly ExecuteCall As RemoteCommandRequest
RemoteService
References the RemoteService component that defines the service to call for executing the command.
property RemoteService: RemoteService read write;
RemoteService RemoteService { get; set; }
Property RemoteService As RemoteService
remove_AfterExecuteCommand
method remove_AfterExecuteCommand(value: EventHandler<RemoteCommandAfteExecuteEventArgs>)
void remove_AfterExecuteCommand(EventHandler<RemoteCommandAfteExecuteEventArgs> value)
Sub remove_AfterExecuteCommand(value As EventHandler<RemoteCommandAfteExecuteEventArgs>)
Parameters:
- value:
remove_BeforeExecuteCommand
method remove_BeforeExecuteCommand(value: EventHandler<RemoteCommandEventArgs>)
void remove_BeforeExecuteCommand(EventHandler<RemoteCommandEventArgs> value)
Sub remove_BeforeExecuteCommand(value As EventHandler<RemoteCommandEventArgs>)
Parameters:
- value:
TriggerAfterExecuteCommand protected
method TriggerAfterExecuteCommand(e: RemoteCommandAfteExecuteEventArgs)
void TriggerAfterExecuteCommand(RemoteCommandAfteExecuteEventArgs e)
Sub TriggerAfterExecuteCommand(e As RemoteCommandAfteExecuteEventArgs)
Parameters:
- e:
TriggerBeforeExecuteCommand protected
method TriggerBeforeExecuteCommand(e: RemoteCommandEventArgs)
void TriggerBeforeExecuteCommand(RemoteCommandEventArgs e)
Sub TriggerBeforeExecuteCommand(e As RemoteCommandEventArgs)
Parameters:
- e:
CATEGORY_COMMUNICATION protected (declared in BaseCommand)
const CATEGORY_COMMUNICATION: String = "Communication";
const String CATEGORY_COMMUNICATION = "Communication"
Dim CATEGORY_COMMUNICATION As String = "Communication"
CATEGORY_DYNAMIC_METHOD_BINDING protected (declared in BaseCommand)
const CATEGORY_DYNAMIC_METHOD_BINDING: String = "Dynamic Method Binding";
const String CATEGORY_DYNAMIC_METHOD_BINDING = "Dynamic Method Binding"
Dim CATEGORY_DYNAMIC_METHOD_BINDING As String = "Dynamic Method Binding"
CATEGORY_OPTIONS protected (declared in BaseCommand)
const CATEGORY_OPTIONS: String = "Options";
const String CATEGORY_OPTIONS = "Options"
Dim CATEGORY_OPTIONS As String = "Options"
CATEGORY_STREAMING protected (declared in BaseCommand)
const CATEGORY_STREAMING: String = "Streaming";
const String CATEGORY_STREAMING = "Streaming"
Dim CATEGORY_STREAMING As String = "Streaming"
ExecuteCall
The DynamicRequest that will be used to invoke the Command on the server. By default, it will be mapped to the ExecuteCommand call as defined in the IDataAbstractService implemented by standard Data Abstract 4.0 servers. When using a custom server interface, you can change its sub-properties to control how the data update call is made.
property ExecuteCall: RemoteCommandRequest read;
RemoteCommandRequest ExecuteCall { get; }
Property ReadOnly ExecuteCall As RemoteCommandRequest
RemoteService
References the RemoteService component that defines the service to call for executing the command.
property RemoteService: RemoteService read write;
RemoteService RemoteService { get; set; }
Property RemoteService As RemoteService
constructor
constructor
RemoteCommand()
Sub New
constructor (IContainer)
constructor(container: IContainer)
RemoteCommand(IContainer container)
Sub New (container As IContainer)
Parameters:
- container:
add_AfterExecuteCommand
method add_AfterExecuteCommand(value: EventHandler<RemoteCommandAfteExecuteEventArgs>)
void add_AfterExecuteCommand(EventHandler<RemoteCommandAfteExecuteEventArgs> value)
Sub add_AfterExecuteCommand(value As EventHandler<RemoteCommandAfteExecuteEventArgs>)
Parameters:
- value:
add_BeforeExecuteCommand
method add_BeforeExecuteCommand(value: EventHandler<RemoteCommandEventArgs>)
void add_BeforeExecuteCommand(EventHandler<RemoteCommandEventArgs> value)
Sub add_BeforeExecuteCommand(value As EventHandler<RemoteCommandEventArgs>)
Parameters:
- value:
Execute (String): Int32 (declared in BaseCommand)
method Execute(commandName: String): Int32
Int32 Execute(String commandName)
Function Execute(commandName As String) As Int32
Parameters:
- commandName:
Execute (String, array of DataParameter): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameters: array of DataParameter): Int32
Int32 Execute(String commandName, DataParameter[] parameters)
Function Execute(commandName As String, parameters As array of DataParameter) As Int32
Parameters:
- commandName:
- parameters:
Execute (String, array of DataParameter, DataParameter): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameters: array of DataParameter; out output: DataParameter): Int32
Int32 Execute(String commandName, DataParameter[] parameters, out DataParameter output)
Function Execute(commandName As String, parameters As array of DataParameter, <OutAttribute> ByRef output As DataParameter) As Int32
Parameters:
- commandName:
- parameters:
- output:
Execute (String, array of String, array of Object): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object): Int32
Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues)
Function Execute(commandName As String, parameterNames As array of String, parameterValues As array of Object) As Int32
Parameters:
- commandName:
- parameterNames:
- parameterValues:
Execute (String, array of String, array of Object, String, Object): Int32 (declared in BaseCommand)
method Execute(commandName: String; parameterNames: array of String; parameterValues: array of Object; out outputNames: String; out outputValues: Object): Int32
Int32 Execute(String commandName, String[] parameterNames, Object[] parameterValues, out String outputNames, out Object outputValues)
Function Execute(commandName As String, parameterNames As array of String, parameterValues As array of Object, <OutAttribute> ByRef outputNames As String, <OutAttribute> ByRef outputValues As Object) As Int32
Parameters:
- commandName:
- parameterNames:
- parameterValues:
- outputNames:
- outputValues:
remove_AfterExecuteCommand
method remove_AfterExecuteCommand(value: EventHandler<RemoteCommandAfteExecuteEventArgs>)
void remove_AfterExecuteCommand(EventHandler<RemoteCommandAfteExecuteEventArgs> value)
Sub remove_AfterExecuteCommand(value As EventHandler<RemoteCommandAfteExecuteEventArgs>)
Parameters:
- value:
remove_BeforeExecuteCommand
method remove_BeforeExecuteCommand(value: EventHandler<RemoteCommandEventArgs>)
void remove_BeforeExecuteCommand(EventHandler<RemoteCommandEventArgs> value)
Sub remove_BeforeExecuteCommand(value As EventHandler<RemoteCommandEventArgs>)
Parameters:
- value:
TriggerAfterExecuteCommand protected
method TriggerAfterExecuteCommand(e: RemoteCommandAfteExecuteEventArgs)
void TriggerAfterExecuteCommand(RemoteCommandAfteExecuteEventArgs e)
Sub TriggerAfterExecuteCommand(e As RemoteCommandAfteExecuteEventArgs)
Parameters:
- e:
TriggerBeforeExecuteCommand protected
method TriggerBeforeExecuteCommand(e: RemoteCommandEventArgs)
void TriggerBeforeExecuteCommand(RemoteCommandEventArgs e)
Sub TriggerBeforeExecuteCommand(e As RemoteCommandEventArgs)
Parameters:
- e:
AfterExecuteCommand
event AfterExecuteCommand: EventHandler<RemoteCommandAfteExecuteEventArgs>;
delegate EventHandler<RemoteCommandAfteExecuteEventArgs> AfterExecuteCommand()
Event AfterExecuteCommand As EventHandler<RemoteCommandAfteExecuteEventArgs>
BeforeExecuteCommand
event BeforeExecuteCommand: EventHandler<RemoteCommandEventArgs>;
delegate EventHandler<RemoteCommandEventArgs> BeforeExecuteCommand()
Event BeforeExecuteCommand As EventHandler<RemoteCommandEventArgs>