ControlRoomContext
Description
Connects to the AI Command Center and exposes repositories for SDK operations. See Get started for a complete connection example.
Constructor
The ControlRoomContext class has the following constructors.
| Constructor | Description |
|---|---|
ControlRoomContext() | Initializes a new instance of the ControlRoomContext. |
| ControlRoomContext (string connectionString) | Initializes a new instance of the ControlRoomContext with connectionString parameter needed for connecting to AI Command Center. |
| ControlRoomContext (string serverUrl, string clientId, string userName, string password, bool isStation = false) | Initializes a new instance of the ControlRoomContext with all the information needed to connect to AI Command Center. |
Properties
The ControlRoomContext class has APIs for the following categories.
| Property | Description |
|---|---|
| Schedules | Represents the repository that holds Schedules (Time Trigger) APIs. |
| SmartBuddies | Represents the repository that holds SmartBuddies APIs. |
| Roles | Represents the repository that holds Roles Management APIs. |
| Users | Represents the repository that holds Users Management APIs. |
| Machines | Represents the repository that holds SmartStation Management APIs. |
| Logs | Represents the repository that holds Log Management APIs. |
| EnterpriseVariables | Represents the repository that holds Enterprise Variables Management APIs. |
| Processes | Represents the repository that holds Processes Management APIs. |
| Jobs | Represents the repository that holds Jobs Management APIs. |
| Tasks | Represents the repository that holds Tasks Management APIs. |
| Bots | Represents the repository that holds Assistant Buddy Management APIs. |
| FileSystemTriggers | Represents the repository that holds FileSystemTrigger Management APIs. |
| EmailTriggers | Represents the repository that holds EmailTrigger Management APIs. |
| ProcessInstances | Creates and manages process instances and their runtime data. |
| Connections | Manages connections. |
Methods
The ControlRoomContext class has the following method.
| Method | Description |
|---|---|
| Open | Opens a connection to the specified AI Command Center and initiates the Context object |
For connection lifetime methods, see BaseContext. For task query and lifecycle operations, see Task Services; examples use context.Tasks.
Remarks
Use ControlRoomContext to log in to the IntelliBuddies AI Command Center and work with different repository APIs.
Example
See the complete quickstart for environment-based credentials and cleanup.
Connection helper
public IControlRoomContext LoginControlRoom()
{
string RequiredSetting(string name) => Environment.GetEnvironmentVariable(name) ?? throw new InvalidOperationException($"Set {name} before running this example.");
string serverUrl = RequiredSetting("INTELLIBUDDIES_SERVER_URL");
string userName = RequiredSetting("INTELLIBUDDIES_USERNAME");
string password = RequiredSetting("INTELLIBUDDIES_PASSWORD");
string connectionString = $"ServerUrl={serverUrl};UserName={userName};Password={password}";
IControlRoomContext context = new ControlRoomContext(connectionString);
context.Open();
return context;
}