Skip to main content Skip to complementary content

IRpcConnection Interface

Namespace: Qlik.Sense.JsonRpc
Assembly: Qlik.Sense.JsonRpc.dll

RpcConnection is responsible for handling the JsonRpc traffic to and from a a Qlik Sense instance.

Syntax

public interface IRpcConnection : IDisposable

Properties

Name Description
ConnectionState

Indicates session connection status. Can be used to identify if the connection resulted in the creation of a new session or if it attached to an already existing session.

Methods

Name Description
Deserialize<T>(JToken)

Deserialize a token to a specific type.

Log(String, String)

Post message to the DebugConsole. If no debug console is active, then the method has no effect.

SendAsync(Request)

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
CommunicationErrorEvent

Event that fires when an exception occurs on the web socket or the socket is unexpectedly closed by the server.

ConnectionClosingEvent

Event that fires when a connection closes.

PushMessageEvent

Will catch all responses without registered receiver

PushMethodReceivedEvent

Event that is fired whenever a push method is received from Qlik Sense.

ResponseEvent

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

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!