The Host type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| Host | Overloaded. |
Methods
| Name | Description | |
|---|---|---|
| CheckPasswordComplexity | Check the password to see if it meets the complexity requirements. | |
| Dispose |
Disconnects from the server and shuts down the API.
| |
| EnterLock | Overloaded. | |
| Equals | (Inherited from Object.) | |
| ExitLock | Overloaded. | |
| Finalize | (Inherited from Object.) | |
| GetHashCode | (Inherited from Object.) | |
| GetPasswordComplexityDescription | Returns an xml document describing the password complexity requirements for this user's firm | |
| GetType | (Inherited from Object.) | |
| IsInRole |
Method to determine whether the user is in the specified role or not.
| |
| MemberwiseClone | (Inherited from Object.) | |
| RemoteTime | Overloaded. | |
| SaveUserSettings |
Save the current xml document user settings.
| |
| SetConnectionSettings | Tells the server what type of connection data we want | |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
| SyncRoot | Synchronisation root. |
Properties
| Name | Description | |
|---|---|---|
| Accounts |
The list of accounts that this user has access to.
| |
| AppName | Application Name | |
| Bandwidth | The connection bandwidth setting. | |
| Brand |
Simple branding details for the firm.
| |
| Compressed | The connection compression setting. | |
| Firm |
The Firm that this user belongs to.
| |
| FirmURL |
Return the firm specific url based on the login firm.
| |
| IsConnected |
Whether the API is currently connected to the server or not.
| |
| MarketData |
Exchange, Contract and market information that this user has access to.
| |
| News | News and economic indicator data if the user has access to it | |
| NewVersion | The latest version number of the software that is available. | |
| NewVersionAvailable |
Return whether there is a new version available that is not compulsory.
| |
| NewVersionRequired |
Return whether there is a new version available that is compulsory.
| |
| NewVersionURL |
Return the url of the latest version install if we have one.
| |
| PerformanceMonitor |
Server Performance Monitoring information.
| |
| Roles |
Method that returns the list of roles that this user can perform.
| |
| Server |
Whether the API is connected to the Live or Simulator systems.
| |
| ServerName | The name of the server that we last logged into | |
| UserID |
The user's unique identifier.
| |
| Username |
The user's login name.
| |
| Users |
The list of users that have also been logged in.
| |
| UserSettings |
XML document containing any settings for this user and application.
| |
| Version |
The version number of this API instance.
|
Events
| Name | Description | |
|---|---|---|
| Connected |
Event raised when the API connects to the server.
| |
| Disconnected |
Event raised when the API is disconnected from the server.
| |
| Heartbeat |
Event raised when a heartbeat is received from the server.
| |
| LoginFailure |
Event raised when login fails.
| |
| LoginSuccess |
Event raised when login succeeds.
| |
| Notification |
Event for text notifications from the server.
|