Class Login
A utility class used for setting the current security credential for operations against an OAS server.
Inheritance
Inherited Members
Namespace: OASData
Assembly: OASData.dll
Syntax
public class Login
Methods
CurrentUser()
Returns the current user that is logged in to the application
Declaration
public string CurrentUser()
Returns
Type | Description |
---|---|
System.String | The current user's username |
LogIn(String, String)
Sets the current user name and password for all secure operations as well as operator events for alarm logging.
Declaration
public string LogIn(string UserName, string Password)
Parameters
Type | Name | Description |
---|---|---|
System.String | UserName | user name for OAS credential |
System.String | Password | password for OAS credential |
Returns
Type | Description |
---|---|
System.String | LogIn result |
LogIn(String, String, String)
Sets the current user name and password for all secure operations on a given network note, as well as operator events for alarm logging.
Declaration
public string LogIn(string UserName, string Password, string NetworkNode)
Parameters
Type | Name | Description |
---|---|---|
System.String | UserName | user name for OAS credential |
System.String | Password | password for OAS credential |
System.String | NetworkNode | IP address or server name of remote OAS server |
Returns
Type | Description |
---|---|
System.String | LogIn result |
LogIn(String, String, String, String)
Sets the current user name and password for all secure operations on a given network note and Live Data Cloud node (RemoteSCADAHost), as well as operator events for alarm logging.
Declaration
public string LogIn(string UserName, string Password, string NetworkNode, string RemoteSCADAHostName)
Parameters
Type | Name | Description |
---|---|---|
System.String | UserName | user name for OAS credential |
System.String | Password | password for OAS credential |
System.String | NetworkNode | IP address or server name of remote OAS server |
System.String | RemoteSCADAHostName | Registered Live Data Cloud node |
Returns
Type | Description |
---|---|
System.String | LogIn result |
LogOff()
Clears the current security user
Declaration
public void LogOff()
SetUserName(String)
The SetUserName method sets the user name for operator events for alarm logging with no security needed. If the LogIn method is used the user name will be set to that user name instead.
Declaration
public void SetUserName(string UserName)
Parameters
Type | Name | Description |
---|---|---|
System.String | UserName | user name for OAS credential |