WSClient Members
WebStatistica Client Class.
Functions
| Name | Description |
|---|---|
| EnableBasicAuth |
Enable Live Score mode of operation for some single-request WS(Job)Client operations using Basic Authentication scheme; NOTE: pass empty strings to disable this mode. |
| IntegratedLogin |
Attempt to log in to WebStatistica using integrated login only. Return value: String. |
| InteractiveLogin |
Use built-in dialogs to perform interactive login to WebStatistica. Return value: String. |
| IsLoggedIn |
Check if WebStatistica is logged in and if the session is 'alive'. Return value: Boolean. |
| LiveScore |
Authenticate using Basic Auth and run a Live Score operation. Return value: Dictionary. |
| Login |
Log into WebStatistica. Return value: String. |
| Logout |
Log out of WebStatistica. |
| TaskStatusDialog |
Launch the Task Status dialog. |
Properties
| Name | Description |
|---|---|
| HostName |
Get or set the WebStatistica Server Name (full or partial URL, or a network name of the machine) [default: localhost]. Return/assignment value: String. |
| HostPort |
Get or set the WebStatistica Server Port [default: 8081]. Return/assignment value: unsigned short. |
| IDToken |
Obtain this session's Identity token. Return value: String. This property is read only. |
| IISExtensionPath |
Get or set IIS extension support library path (relative to web root) [default: /ISAPI/StaISAPI.dll]. Return/assignment value: String. |
| JobClient |
Obtain pointer to JobClient object. Return value: WSJobClient. This property is read only. |
| MainURL |
Get Main WebStatistica URL (interactive Web interface). Return value: String. This property is read only. |
| Permissions |
Returns user permissions for currently logged-in WebStatistica user. Return value: UserPermissions. This property is read only. |
| RepositoryClient |
Obtain pointer to RepositoryClient object. Return value: WSRepositoryClient. This property is read only. |
| Silent |
Get/set silent mode (no UI -> suitable for server applications). Return/assignment value: Boolean. |
| SitePath |
Get or set Virtual Directory [default: /WebStatistica]. Return/assignment value: String. |
| Timeout |
Get/set timeout for silent mode (in seconds). Return/assignment value: unsigned short. |