Connections.GetConnectionByNameAsync

Description

Gets the specified connection from the connected AI Command Center

Signature [C#]

Task<Connection> GetConnectionByNameAsync(string name);

Properties

Input

Parameter	Type	Required / default	Description
name	string	Required	Specify the name of the connection to be retrieved.

Output

Property	Description
Task<Connection>	Returns the details of the specified connection.

Remarks

Use GetConnectionByNameAsync API to get information about the connection from the connected AI Command Center.

Example

C#

public async Task GetConnectionByName()
{
    IControlRoomContext context = LoginControlRoom();
    try
    {
        string connectionName = "demo_connection";
        var connection = await context.Connections.GetConnectionByNameAsync(connectionName);
        Console.WriteLine("Connection Value: " + connection.Value);
    }
    finally
    {
        context.Close();
    }
}

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;
}

See Get started for namespaces, configuration, and context cleanup, and SDK usage for error handling.