ControlRoomContext

Description

Represents the context for ControlRoom Automation APIs

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 Control Room.
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 Control Room.

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.

Methods

The ControlRoomContext class has the following method.

Method	Description
Open	Opens a connection to the specified Control Room and initiates the Context object

Remarks

Use ControlRoomContext to log in to the IntelliBuddies Control Room and work with different repository APIs.

Example

C#

using IntelliBuddies.Client;

public void ControlRoom_Login()
{
    string connectionString = "ServerUrl=<Control_Room_Login_Url>;UserName=<UserName>;Password=<Password>";
    IControlRoomContext context;
    
    context = new ControlRoomContext(connectionString);
    context.Open();
}