IGenericLocation Interface

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

Interface for accessing information relating to Qlik Sense locations.

Syntax

public interface IGenericLocation

Name	Description
CustomUserAgent	Custom HTTP user-agent header for identifying application.
CustomUserCookies	Property for custom user cookies
CustomUserHeaders	Property for custom user headers
CustomUserUrlParameters	Property for custom url parameters
EnablePing	If this property is set to `true` then a websocket will be opened at the first possible opportunity by forcing a dummy RPC request to the engine. If the value is `false` then a websocket will be opened only when the first RPC request is made. Default value is: `true`
ServerUri	The Uri of the Qlik Sense server
WebSocketProxy	The proxy for WebSocket requests.

Name	Description
AsManualConfiguration()	Leave location without any configurations leaving it to the user to set headers, url parameters and/or cookies according to own needs.
GetWebSocketSessionContainer(ISession)	Method for retrieving a WebSocketSessionContainer based on the current location and the argument session.
GetWebsocketUri(ISession, String)	Returns the full Uri used when performing a websocket connection.

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!