Hub Members

Qlik Sense .NET SDK - API Reference

The Hub type exposes the following members.

Constructors

	Name	Description
	Hub	Initializes a new instance of the Hub class

Methods

	Name	Description
	AbortAll	Sets an abort flag on all pending and ongoing requests in the current session. * If an abort flag is set on a pending request, the request is aborted. * If an abort flag is set on an ongoing request, the engine checks to see if it is possible to abort the request.
	AbortAllAsync	Sets an abort flag on all pending and ongoing requests in the current session. * If an abort flag is set on a pending request, the request is aborted. * If an abort flag is set on an ongoing request, the engine checks to see if it is possible to abort the request.
	AllowCreateApp	Indicates whether or not a user is able to create an app.
	AllowCreateAppAsync(String)	Indicates whether or not a user is able to create an app.
	AllowCreateAppAsync T (Func Response, T , String)	Indicates whether or not a user is able to create an app.
	AllowEditMode	Indicates whether or not a user is able to edit Qlik Sense on remote devices.
	AllowEditModeAsync(String)	Indicates whether or not a user is able to edit Qlik Sense on remote devices.
	AllowEditModeAsync T (Func Response, T , String)	Indicates whether or not a user is able to edit Qlik Sense on remote devices.
	CancelReload	Cancels an ongoing reload. The reload of the app is stopped.
	CancelReloadAsync	Cancels an ongoing reload. The reload of the app is stopped.
	CancelRequest	Cancels an ongoing request. The request is stopped.
	CancelRequestAsync	Cancels an ongoing request. The request is stopped.
	ConfigureReload	Configures the engine's behavior during a reload. The ConfigureReload method should be run before the DoReload method.
	ConfigureReloadAsync	Configures the engine's behavior during a reload. The ConfigureReload method should be run before the DoReload method.
	CopyApp	Copies an app that is in the Qlik Sense repository. The engine copies the app into an app entity that was previously created by the repository. See the QRS API (REST API) help for more information. This method applies only if running in server mode.
	CopyAppAsync(String, String, IEnumerable String , String)	Copies an app that is in the Qlik Sense repository. The engine copies the app into an app entity that was previously created by the repository. See the QRS API (REST API) help for more information. This method applies only if running in server mode.
	CopyAppAsync T (String, String, IEnumerable String , Func Response, T , String)	Copies an app that is in the Qlik Sense repository. The engine copies the app into an app entity that was previously created by the repository. See the QRS API (REST API) help for more information. This method applies only if running in server mode.
	CreateApp	Creates an app.
	CreateAppAsync(String, String, String)	Creates an app.
	CreateAppAsync T (String, String, Func Response, T , String)	Creates an app.
	CreateAppEx	Creates an app and opens a session. This method applies only if running a local installation of Qlik Sense.
	CreateAppExAsync(String, String, String, String, String, String)	Creates an app and opens a session. This method applies only if running a local installation of Qlik Sense.
	CreateAppExAsync T (String, String, String, String, String, Func Response, T , String)	Creates an app and opens a session. This method applies only if running a local installation of Qlik Sense.
	DestroyApp	Deletes an app from the Qlik Sense repository or from the file system. In server mode In addition to being removed from the repository, the app is removed from the directory as well: <installation_directory>\Qlik\Sense\Repository\Apps The default installation directory is ProgramData. In local installation mode The app is deleted from the directory C:\Users\%username%\Documents\Qlik\Sense\Apps.
	DestroyAppAsync(String, String, String)	Deletes an app from the Qlik Sense repository or from the file system. In server mode In addition to being removed from the repository, the app is removed from the directory as well: <installation_directory>\Qlik\Sense\Repository\Apps The default installation directory is ProgramData. In local installation mode The app is deleted from the directory C:\Users\%username%\Documents\Qlik\Sense\Apps.
	DestroyAppAsync T (String, String, Func Response, T , String)	Deletes an app from the Qlik Sense repository or from the file system. In server mode In addition to being removed from the repository, the app is removed from the directory as well: <installation_directory>\Qlik\Sense\Repository\Apps The default installation directory is ProgramData. In local installation mode The app is deleted from the directory C:\Users\%username%\Documents\Qlik\Sense\Apps.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from QixClassBase.)
	ExportApp	Exports an app from the Qlik Sense repository to the file system. This method applies only if running in server mode.
	ExportAppAsync(String, String, IEnumerable String , String)	Exports an app from the Qlik Sense repository to the file system. This method applies only if running in server mode.
	ExportAppAsync T (String, String, IEnumerable String , Func Response, T , String)	Exports an app from the Qlik Sense repository to the file system. This method applies only if running in server mode.
	GetActiveDoc	Returns the handle of the current app.
	GetActiveDocAsync(String)	Returns the handle of the current app.
	GetActiveDocAsync T (Func Response, T , String)	Returns the handle of the current app.
	GetAppList	Returns the list of apps available: * in the repository in C:\ProgramData\Qlik\Sense\Repository\Apps if running Qlik Sense Server * in the directory C:\Users\<user name>\Documents\Qlik\Sense\Apps if running a local installation of Qlik Sense. If Qlik Sense has not been installed under ProgramData when in server mode, the app files are located under <installation_directory>\Qlik\Sense\Repository\Apps.
	GetAppListAsync(String)	Returns the list of apps available: * in the repository in C:\ProgramData\Qlik\Sense\Repository\Apps if running Qlik Sense Server * in the directory C:\Users\<user name>\Documents\Qlik\Sense\Apps if running a local installation of Qlik Sense. If Qlik Sense has not been installed under ProgramData when in server mode, the app files are located under <installation_directory>\Qlik\Sense\Repository\Apps.
	GetAppListAsync T (Func Response, T , String)	Returns the list of apps available: * in the repository in C:\ProgramData\Qlik\Sense\Repository\Apps if running Qlik Sense Server * in the directory C:\Users\<user name>\Documents\Qlik\Sense\Apps if running a local installation of Qlik Sense. If Qlik Sense has not been installed under ProgramData when in server mode, the app files are located under <installation_directory>\Qlik\Sense\Repository\Apps.
	GetAuthenticatedUser	Retrieves information about the authenticated user.
	GetAuthenticatedUserAsync(String)	Retrieves information about the authenticated user.
	GetAuthenticatedUserAsync T (Func Response, T , String)	Retrieves information about the authenticated user.
	GetBNF
	GetBNFAsync(BNFType, String)
	GetBNFAsync T (BNFType, Func Response, T , String)
	GetCustomConnectors	List the custom connectors available in the system.
	GetCustomConnectorsAsync(Boolean, String)	List the custom connectors available in the system.
	GetCustomConnectorsAsync T (Boolean, Func Response, T , String)	List the custom connectors available in the system.
	GetDatabasesFromConnectionString	Lists the databases in a ODBC, OLEDB or CUSTOM data source.
	GetDatabasesFromConnectionStringAsync(Connection, String)	Lists the databases in a ODBC, OLEDB or CUSTOM data source.
	GetDatabasesFromConnectionStringAsync T (Connection, Func Response, T , String)	Lists the databases in a ODBC, OLEDB or CUSTOM data source.
	GetDefaultAppFolder	Returns the folder where the apps are stored. This method applies only if running Qlik Sense Desktop.
	GetDefaultAppFolderAsync(String)	Returns the folder where the apps are stored. This method applies only if running Qlik Sense Desktop.
	GetDefaultAppFolderAsync T (Func Response, T , String)	Returns the folder where the apps are stored. This method applies only if running Qlik Sense Desktop.
	GetFolderItemsForPath	Returns the files and folders located at a specified path.
	GetFolderItemsForPathAsync(String, String)	Returns the files and folders located at a specified path.
	GetFolderItemsForPathAsync T (String, Func Response, T , String)	Returns the files and folders located at a specified path.
	GetFunctions
	GetFunctionsAsync(FunctionGroup, String)
	GetFunctionsAsync T (FunctionGroup, Func Response, T , String)
	GetInteract
	GetInteractAsync(Int32, String)
	GetInteractAsync T (Int32, Func Response, T , String)
	GetLogicalDriveStrings	Lists the logical drives in the system. This method applies only if running Qlik Sense Desktop.
	GetLogicalDriveStringsAsync(String)	Lists the logical drives in the system. This method applies only if running Qlik Sense Desktop.
	GetLogicalDriveStringsAsync T (Func Response, T , String)	Lists the logical drives in the system. This method applies only if running Qlik Sense Desktop.
	GetMyDocumentsFolder
	GetMyDocumentsFolderAsync(String)
	GetMyDocumentsFolderAsync T (Func Response, T , String)
	GetOdbcDsns	Returns the list of the ODBC connectors that are installed in the system.
	GetOdbcDsnsAsync(String)	Returns the list of the ODBC connectors that are installed in the system.
	GetOdbcDsnsAsync T (Func Response, T , String)	Returns the list of the ODBC connectors that are installed in the system.
	GetOleDbProviders	Returns the list of the OLEDB providers installed on the system.
	GetOleDbProvidersAsync(String)	Returns the list of the OLEDB providers installed on the system.
	GetOleDbProvidersAsync T (Func Response, T , String)	Returns the list of the OLEDB providers installed on the system.
	GetProgress	Gives information about the progress of the DoReload and DoSave calls. For more information on DoReload and DoSave, see the DoReload method and DoSave method.
	GetProgressAsync(String)
	GetProgressAsync(Int32, String)	Gives information about the progress of the DoReload and DoSave calls. For more information on DoReload and DoSave, see the DoReload method and DoSave method.
	GetProgressAsync T (Int32, Func Response, T , String)	Gives information about the progress of the DoReload and DoSave calls. For more information on DoReload and DoSave, see the DoReload method and DoSave method.
	GetStreamList	Lists the streams.
	GetStreamListAsync(String)	Lists the streams.
	GetStreamListAsync T (Func Response, T , String)	Lists the streams.
	GetSupportedCodePages	Lists the supported code pages.
	GetSupportedCodePagesAsync(String)	Lists the supported code pages.
	GetSupportedCodePagesAsync T (Func Response, T , String)	Lists the supported code pages.
	GetUniqueID	Returns the unique identifier of the endpoint for the current user in the current app. This unique identifier can be used for logging purposes.
	GetUniqueIDAsync(String)	Returns the unique identifier of the endpoint for the current user in the current app. This unique identifier can be used for logging purposes.
	GetUniqueIDAsync T (Func Response, T , String)	Returns the unique identifier of the endpoint for the current user in the current app. This unique identifier can be used for logging purposes.
	ImportApp	Imports an app to the Qlik Sense repository. This method applies only if running in server mode.
	ImportAppAsync(String, String, IEnumerable String , String)	Imports an app to the Qlik Sense repository. This method applies only if running in server mode.
	ImportAppAsync T (String, String, IEnumerable String , Func Response, T , String)	Imports an app to the Qlik Sense repository. This method applies only if running in server mode.
	InteractDone
	InteractDoneAsync
	IsDesktopMode	Indicates whether or not the user works in standalone mode.
	IsDesktopModeAsync(String)	Indicates whether or not the user works in standalone mode.
	IsDesktopModeAsync T (Func Response, T , String)	Indicates whether or not the user works in standalone mode.
	IsPersonalMode	Indicates whether or not the user works in personal mode.
	IsPersonalModeAsync(String)	Indicates whether or not the user works in personal mode.
	IsPersonalModeAsync T (Func Response, T , String)	Indicates whether or not the user works in personal mode.
	IsValidConnectionString
	IsValidConnectionStringAsync(Connection, String)
	IsValidConnectionStringAsync T (Connection, Func Response, T , String)
	OpenApp	Opens an app.
	OpenAppAsync(String, String, String, String, String)	Opens an app.
	OpenAppAsync T (String, String, String, String, Func Response, T , String)	Opens an app.
	OSName	Returns the name of the operating system.
	OSNameAsync(String)	Returns the name of the operating system.
	OSNameAsync T (Func Response, T , String)	Returns the name of the operating system.
	OSVersion	Returns the version number of the operating system.
	OSVersionAsync(String)	Returns the version number of the operating system.
	OSVersionAsync T (Func Response, T , String)	Returns the version number of the operating system.
	PublishApp
	PublishAppAsync(String, String, Boolean, String, String)
	PublishAppAsync T (String, String, Boolean, String, Func Response, T , String)
	QTProduct	Returns the Qlik product name.
	QTProductAsync(String)	Returns the Qlik product name.
	QTProductAsync T (Func Response, T , String)	Returns the Qlik product name.
	QvVersion	Returns the Qlik Sense version number.
	QvVersionAsync(String)	Returns the Qlik Sense version number.
	QvVersionAsync T (Func Response, T , String)	Returns the Qlik Sense version number.
	ReloadExtensionList	Reloads the list of extensions.
	ReloadExtensionListAsync	Reloads the list of extensions.
	ReplaceAppFromID	Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode.
	ReplaceAppFromIDAsync(String, String, IEnumerable String , String)	Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode.
	ReplaceAppFromIDAsync T (String, String, IEnumerable String , Func Response, T , String)	Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode.
	ReplaceAppFromPath	Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode.
	ReplaceAppFromPathAsync(String, String, IEnumerable String , String)	Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode.
	ReplaceAppFromPathAsync T (String, String, IEnumerable String , Func Response, T , String)	Replaces an app with the objects from a source app. The list of objects in the app to be replaced must be defined in qIds. The data model of the app cannot be updated. This method applies only if running in server mode.
	ShutdownProcess	Shutdowns the Qlik engine. This method applies only if running a local installation of Qlik Sense.
	ShutdownProcessAsync	Shutdowns the Qlik engine. This method applies only if running a local installation of Qlik Sense.
	TestLogging
	TestLoggingAsync(String, Int32, Int32, String)
	TestLoggingAsync T (String, Int32, Int32, Func Response, T , String)
	TestRepositoryLogging
	TestRepositoryLoggingAsync(String, Int32, String, String)
	TestRepositoryLoggingAsync T (String, Int32, String, Func Response, T , String)

Properties

	Name	Description
	Handle	The handle of the generic object. (Inherited from QixClassBase.)
	Id	(Inherited from QixClassBase.)
	Session	The session this object resides in. (Inherited from QixClassBase.)
	Type	The type of the generic object. (Inherited from QixClassBase.)

Events

	Name	Description
	Changed	(Inherited from QixClassBase.)
	Closed	(Inherited from QixClassBase.)
	CommunicationError
	ObjectsChanged
	ObjectsClosed