Windows

The Workspaces API is accessible via the io.Workspaces object.

The .NET Workspaces API enables you to determine whether an io.Connect Window is currently in a Workspace, to retrieve snapshots and contexts of Workspaces, and to subscribe for events related to windows participating in Workspaces.

To determine whether a window is in a Workspace, use the IsInWorkspace() method and pass as an argument the IGDWindow object describing the respective window:

bool isInWorkspace = await io.Workspaces.IsInWorkspace(targetWindow);

To retrieve the context of the Workspace in which a window participates, use the GetWorkspaceContext() method and pass as an argument the IGDWindow object describing the respective window:

IContext context = await io.Workspaces.GetWorkspaceContext(targetWindow);

To retrieve a snapshot of a Workspace, use the GetWorkspaceSnapshot() method and provide the ID of the respective Workspace:

WorkspaceSnapshot snapshot = await io.Workspaces.GetWorkspaceSnapshot("workspace-id");

Console.WriteLine($"Workspace ID: {snapshot.Id}, Workspace title: {snapshot.Title}.");

The WorkspaceSnapshot object has the following properties:

To subscribe for events related to windows participating in Workspaces, use the SubscribeWindowEvent() method and pass a callback function for handling the event. The callback will receive a WorkspaceEvent object as an argument. Use this object to determine the type of the event, the io.Connect Window to which it's related, and the Workspace in which the respective window participates:

IDisposable subscription = await io.Workspaces.SubscribeWindowEvent((е) =>
{
    // Handling a specific event.
    if (е.Action == WorkspaceEvent.Added)
    {
        Console.WriteLine($"Window with ID {е.WindowId} was added to Workspace with ID {е.WorkspaceId}.");
    }
    else
    {
        Console.WriteLine($"Event {е.Action} fired for window with ID {е.WindowId}.");
    };
});

// Closing the subscription.
subscription.Dispose();

Upon successful subscription, the SubscribeWindowEvent() method returns a subscription object of type IDisposable. Use its Dispose() method to stop receiving event notifications.

The WorkspaceEvent object has the following properties:

The WindowEventAction enumeration describes the available events and has the following members: