ApiSessionLogin Method |
Logs a user in to the connected articy:server
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
SyntaxC#
public void Login( string aUserName, string aPassword )
Parameters
- aUserName
- Type: SystemString
The name of the user account. Ask your articy:server administrator for account credentials. - aPassword
- Type: SystemString
The password of the user account.
Exceptions| Exception | Condition |
|---|---|
| ArticyApiException | NotConnected is thrown when you are not connected to an articy:server |
Remarks
Once the connection to an articy:server has been established successfully,
your program needs to login. In order to achieve this, the username and password of a regular articy:draft user is needed.
All limitations that apply to this user (available projects, rights within the projects) also apply to your program using this user account.
See Also