The SkmSession provides authentication keeps reference to the session on the Skm server.
More...
|
| void | Login (string Username, string Password) |
| | Logs into the Skm creating a valid session on the Skm server. This method will throw a 'SkmAuthenticationException' exception if the authentication fails or an exception of type 'Exception' for any other error. More...
|
| |
|
| static SkmSession | NewSkmSession (string Address) |
| | Factory method to create a new SkmSession. This method only initializes and returns a new instance. It does not communicate with the Skm server. More...
|
| |
The SkmSession provides authentication keeps reference to the session on the Skm server.
◆ Login()
| void SkmXmlApi.SkmSession.Login |
( |
string |
Username, |
|
|
string |
Password |
|
) |
| |
Logs into the Skm creating a valid session on the Skm server. This method will throw a 'SkmAuthenticationException' exception if the authentication fails or an exception of type 'Exception' for any other error.
- Parameters
-
| Username | Username to authenticate |
| Password | Password of the user |
◆ NewSkmSession()
| static SkmSession SkmXmlApi.SkmSession.NewSkmSession |
( |
string |
Address | ) |
|
|
static |
Factory method to create a new SkmSession. This method only initializes and returns a new instance. It does not communicate with the Skm server.
- Parameters
-
| Address | Skm server address |
- Returns
- A new instance of the SkmSession
◆ IsSessionValid
| bool SkmXmlApi.SkmSession.IsSessionValid |
|
get |
Is true if the session has been logged in and is valid
◆ ServerAddress
| string? SkmXmlApi.SkmSession.ServerAddress |
|
getset |
The address of the Skm Server. This can either be an IP address or a resolvable DNS name.
◆ SessionCookie
| string SkmXmlApi.SkmSession.SessionCookie |
|
get |
◆ User
The user associated to this session
The documentation for this class was generated from the following file:
- src/SkmXmlApi/SkmSession.cs