Skip to main content Skip to complementary content
Close announcements banner

QlikConnection Class

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

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

Inheritance

Syntax

public class QlikConnection : RpcConnection, IQlikConnection, IRpcConnection, IDisposable

Constructors

Name Description
QlikConnection(IGenericLocation, ISession)

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

Properties

Name Description
App

The active App if any

Hub

The active Hub

Session

The session specification.

SessionToken

The session metadata token used for identifying the currently used connection

Methods

Name Description
AwaitResponse(Task, String, CancellationToken)

Await the arrival of a response for a method call to the engine.

AwaitResponse<T>(Task<T>, String, CancellationToken)

Await the arrival of a response for a method call to the engine.

Deserialize<T>(JToken)

Deserialize a token to a specific type.

Log(String)

Method to use when emitting a log message.

MakeInboundSerializer()

Method for creating the JsonSerializer used to deserialize message received from the RPC connection.

MakeOutboundSerializer()

Method for creating the JsonSerializer used to serialize requests to an the RPC connection.

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)
SendAsync<T>(Request, Func<Response, T>)

Sends a request asynchronously to a Qlik Sense instance

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.

Explicit Interface Implementations

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!