Public API for connection functionality to a particular server
Namespace: GF.Api.Connection
Assembly: GF.Api (in GF.Api.dll) Version: dd7171be68430789135ec75c4e9f4bbfeca31201
Syntax
The IServerConnectionApi type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | CurrentUser |
Gets the user currently logged in to this server.
|
| IsAdmin |
True if the currently logged in user has admin privileges.
|
| IsClosed |
Socket is closed
|
| IsConnected |
Socket is open and server connection established
See LoginCompleted.
|
| IsConnecting |
Socket is open but server connection not yet established
|
Methods
| Name | Description | |
|---|---|---|
 | Connect |
Establishes new connection to the server
|
| Disconnect |
Closes the connection to the OEC server.
|
Events
| Name | Description | |
|---|---|---|
 | Disconnected |
Raised when connection to server is dropped
|
| LoginCompleted |
Raised when logged in and initial client cache loading is complete
|
| LoginFailed |
Raised when connection couldn't be established, credentials are wrong, or client API version is invalid
|
See Also