Skip to main content Skip to complementary content

IQlikConnection Interface

Namespace: Qlik.Engine.Communication
Assembly: Qlik.Engine.dll

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

Syntax

public interface IQlikConnection : IRpcConnection, IDisposable

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

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

Methods

Name Description
GetQixObject<T>(String, Func<AsyncHandle, Func<Response, T>, String, Task<T>>, Func<Response, T>)

Get QIX object either from cache, or from the engine.

New<T>(JObject)

Create a new structure bound to this session

RetryOnAbort<T>(Func<Task<T>>, Int32, Int32)

Perform the request and retry if the operation is aborted due to a generic abort.

SendAsync(Request)

Sends a request asynchronously to a Qlik Sense instance

SendAsync(Int32, String, IEnumerable<String>, Object[])

Sends a request asynchronously to a Qlik Sense instance

SendAsync<T>(Request, Func<Response, T>)

Sends a request asynchronously to a Qlik Sense instance with a specified response handler

Events

Name Description
ObjectChangedMessageEvent

Event that is fired when a response received on the web socket contains change notifications.

ObjectClosedMessageEvent

Event that is fired when a response received on the web socket contains object closed notifications.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!