QlikConnection Class

QlikConnection is responsible for handling the communication with a Qlik Sense instance

Inheritance Hierarchy

SystemObject
Qlik.Engine.CommunicationQlikConnection

Namespace: Qlik.Engine.Communication
Assembly: Qlik.Engine (in Qlik.Engine.dll) Version: 2.1.0.0+Build:7.origin/release/ms13

Syntax

public class QlikConnection : IQlikConnection, 
	IDisposable

Public Class QlikConnection
	Implements IQlikConnection, IDisposable

The QlikConnection type exposes the following members.

Constructors

	Name	Description
	QlikConnection	Creates a new connection to a Qlik Sense instance based on a known location and specific session

Methods

	Name	Description
	AwaitResponse(Task, String, CancellationToken)	Await the arrival of a response for a method call to the engine.
	AwaitResponseT(TaskT, String, CancellationToken)	Await the arrival of a response for a method call to the engine.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	NewT	Create a new structure bound to this session
	RegisterVisualizationT	Obsolete. Registration method for visualizations
	SendAsync(Request)	Sends a request asynchronously to a Qlik Sense instance
	SendAsync(Int32, String, IEnumerableString, Object)	Sends a request asynchronously to a Qlik Sense instance
	SendAsyncT(Request, FuncResponse, T)	Sends a request asynchronously to a Qlik Sense instance with a specified response handler

Properties

	Name	Description
	App	The active App if any
	CancellationToken	The token used to synchronize shutdown events with all outstanding tasks
	Hub	The active Hub
	RetryCountLimit	Maximum number of connection retry attemps performed when opening a websocket connection. Default is 3.
	ServerUri	The Uri used to connect to the Qlik Sense instance
	Session	The session metadata used for identifying the currently used connection
	SessionToken	The session metadata token used for identifying the currently used connection
	Timeout	Timeout value used for synchronous calls to engine. Usually used together with CancellationToken.
	WebSocketFactory

Events

	Name	Description
	PushMessage	Will catch all responses without registered receiver