Skip to main content Skip to complementary content

LocationExtensions Class

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

Some locations need to be accessed in a specific way, the default is using NTML Authentication to connect against a server installation and will not require any specific setup.

Inheritance

  • System.Object
    • LocationExtensions

Syntax

public static class LocationExtensions

Methods

Name Description
ActiveApp(ILocation, IAppIdentifier, ISession)

Connect to an already active Qlik Sense app. This method opens a websocket connection.

ActiveAppAsync(ILocation, IAppIdentifier, ISession)

Connect to an already active Qlik Sense app This method opens a websocket connection.

App(ILocation, IAppIdentifier, ISession, Boolean)

Connect to a Qlik Sense app. This method opens a websocket connection.

App(ILocation, String, ISession, Boolean)

Connect to a Qlik Sense app. This method opens a websocket connection.

AppAsync(ILocation, IAppIdentifier, ISession, Boolean)

Connect to a Qlik Sense app. This method opens a websocket connection.

AppAsync(ILocation, String, ISession, Boolean)

Connect to a Qlik Sense app. This method opens a websocket connection.

AppsWithNameOrDefault(ILocation, String)

Connect to a Qlik Sense app with the name, and return a list of apps. If you connect to a server, you can have multiple apps with the same name. On desktop you can only have one app with a specific name. This method opens a temporary websocket connection.

AppWithId(ILocation, String)

Connect to a Qlik Sense app with the app id. This method opens a temporary websocket connection.

AppWithIdOrDefault(ILocation, String)

Connect to a Qlik Sense app with the app id. This method opens a temporary websocket connection.

AppWithNameOrCreate(ILocation, String)

Connect to a Qlik Sense app with the name or create it if it does not exists. This method opens a temporary websocket connection.

AppWithNameOrDefault(ILocation, String)

Connect to a Qlik Sense app with the name. If you connect to a server, you can have multiple apps with the same name. On desktop you can only have one app with a specific name. If you have multiple apps with the same name on the server this method will return the first app in the list. If you would like to get all the apps with a specific name please use the method AppsWithNameOrDefault. This method opens a temporary websocket connection.

CreateAppWithName(ILocation, String)

Create an application with given name. This method opens a temporary websocket connection.

Delete(ILocation, IAppIdentifier)

Deletes the application. This method opens a temporary websocket connection.

GetAppIdentifiers(ILocation)

Get a list of app identifiers. This method opens a temporary websocket connection.

GetAppIdentifiersAsync(ILocation)

Get a list of app identifiers. This method opens a temporary websocket connection.

HasAppWithId(ILocation, String)

Check if location has app with id. This method opens a temporary websocket connection.

HasAppWithName(ILocation, String)

Checks if there is an application with a specific name. This method opens a temporary websocket connection.

Hub(ILocation, ISession)

Connect to the Qlik Sense hub. This method opens a websocket connection.

HubAsync(ILocation, ISession)

Connect to the Qlik Sense hub. This method opens a websocket connection.

IsAlive(ILocation)

Checks if the connection is alive This method opens a temporary websocket connection.

SessionApp(ILocation, ISession)

Create and connect to a new session app. This method opens a websocket connection.

SessionAppAsync(ILocation, ISession)

Create and connect to a new session app. This method opens a websocket connection.

SessionAppFromApp(ILocation, IAppIdentifier, ISession)

Create and connect to a new session app based on another app. This method opens a websocket connection.

SessionAppFromApp(ILocation, String, ISession)

Create and connect to a new session app based on another app. This method opens a websocket connection.

SessionAppFromAppAsync(ILocation, IAppIdentifier, ISession)

Create and connect to a new session app based on another app. This method opens a websocket connection.

SessionAppFromAppAsync(ILocation, String, ISession)

Create and connect to a new session app based on another app. This method opens a websocket connection.

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!