IApp.SendGenericCommandToCustomConnectorAsync Method (String, String, String, IEnumerable(String), String, AsyncHandle)

IAppSendGenericCommandToCustomConnectorAsync Method (String, String, String, IEnumerableString, String, AsyncHandle)

Sends a generic command to a custom connector.

For more information on the commands that can be sent to a custom connector, see the QVX SDK help.

Namespace: Qlik.Engine
Assembly: Qlik.Engine (in Qlik.Engine.dll) Version: 1.1.0.0 (1.1.0.0)

Syntax

Task<string> SendGenericCommandToCustomConnectorAsync(
	string provider,
	string command,
	string method,
	IEnumerable<string> parameters,
	string appendConnection,
	AsyncHandle asyncHandle = null
)

Function SendGenericCommandToCustomConnectorAsync ( 
	provider As String,
	command As String,
	method As String,
	parameters As IEnumerable(Of String),
	appendConnection As String,
	Optional asyncHandle As AsyncHandle = Nothing
) As Task(Of String)

Parameters

provider: Type: SystemString
Connector file name. Command to be executed by the connector.
command: Type: SystemString
One of: JsonRequest GetCustomCaption IsConnected DisableQlikViewSelectButton HaveStarField
method: Type: SystemString
Method name to be used within the command. The available methods depend on the chosen connector.
parameters: Type: System.Collections.GenericIEnumerableString
Parameters of the command. No parameters are required. This parameter is optional.
appendConnection: Type: SystemString
Name of the connection. This parameter is optional.
asyncHandle (Optional): Type: Qlik.EngineAsyncHandle
Handle to asyncronous method request

Return Value

Type: TaskString

Reference

IApp Interface

SendGenericCommandToCustomConnectorAsync Overload

Qlik.Engine Namespace