Click or drag to resize
ClientConfig Properties DataPA OpenAnalytics
DataPA OpenAnalytics API Reference

The ClientConfig type exposes the following members.

Properties
  Name Description
Public property AllowQuerySelectConnection
Gets and sets a property that indicates if this client supports the selection of a connection from the query wizard.
Public property Application
Gets and sets the Application object used to allow access to queries and setup.
Public property AppServerValidationFailed
Gets a value that indicate if validation on the security appserver failed.
Public property AuthToken
Details of the token used to authenticate with the Enterprise Service
Public property AutoUpdate
Gets and sets a value that indicates if the client should automatically check for updates.
Public property ConfigSettings
Gets the configuration settings object
Public property CustomLoadingImage
Gets and sets the custom loading image
Public property CustomLoadingImageBase64
Gets and sets the custom loading image as a base64 encoded string
Public property CustomLoadingImageType
Gets and sets the loading image type for this client instance
Public property DashboardStyle
Gets and sets the default dashboard style for client applications
Public property DataFileFormat
Gets and sets a value that indicates the file format used to store the setup.
Public property DataLocation
Gets and sets the data location
Public property DataLocationType
Gets a value that indicates what type of data location is currently set.
Public property EnterpriseServiceEndpoint
Gets the Enterprise Service End Point for this client instance
Public property EnterpriseServiceHubPort
Gets a value that indicates the port being used to commincate with the Enteprise Service SignalR Hub.
Public property Group
Gets the unique ID of the users group.
Public property Initialised
Gets a property that indicates if this clientconfig has been successfully initialised.
Public property LicenseInfo
Gets and sets the LicenseInfo object for this object.
Public property LoadingImage
Gets the loading image for this client session
Public property LockServerCode
Gets the encrypted lockserver code.
Public property MaxJSONLength
Gets a value that indicates the maximum JSON document size permitted.
Public property PaletteFile
Gets the palette file for this client instamce
Public property Password
Gets and sets the Password the user has logged in with.
Public property PreviousLoginFailed
Gets and sets a value that indicates if the previous login attempt failed.
Public property QuietCheckForUpdate
Gets and sets a property that indicates if the check for update should show a message when there is no update.
Public property RootObject
Gets and sets the root object used to provide AppServer connectivity to download dat files etc.
Public property SchedulerClient
Gets and sets a property that indicates if the client should be checking for scheduler licenses rather than standard.
Public property Security
Gets and sets the Security object for this object.
Public property SessionFreeDataLocationAppServer
Gets and sets a value that indicates if the Data Location AppServer is a session free AppServer
Public property SetupGUID
Gets a value that indicate the setup GUID used to tell when the setup on the server has changed.
Public property SetupManager
Gets and sets a setup manager object for this objects.
Public property Silent
Gets and sets a property that indicates if the application is set to silent so will hide messages.
Public property SplashScreenText
Gets and sets the text displayed on the splash screen.
Public property SuppressLoginDialog
Gets and sets a property that indicates if the login dialog should always be suppressed
Public property SystemStructure
Gets a System Structure (DBs, Tables, Fields, Functions etc.) Object
Public property UpdateLocation
Gets and sets the location the client will check for updates.
Public property UsePreviousUsernameAndPasswordSet
Gets and sets a value that indicates if the previously used username and password should be used rather than prompting again.
Public property UserName
Gets and sets the username the user has logged in with.
Public property Version
Gets the version of DataPA currently installed.
Top
See Also