@fluidframework/agent-scheduler

@fluidframework/agent-scheduler

Using Fluid Framework libraries

When taking a dependency on a Fluid Framework library's public APIs, we recommend using a ^ (caret) version range, such as ^1.3.4. While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries, library consumers should always prefer ^.

If using any of Fluid Framework's unstable APIs (for example, its beta APIs), we recommend using a more constrained version range, such as ~.

AgentScheduler

The AgentScheduler is a data object that can be used to assign tasks to unique clients.

Creation

To create an AgentScheduler as a child instance of your data object, add the factory to your registry and call the static createChildInstance function on the factory. You can then retrieve and store its handle to access it later:

// In your Data Object
protected async initializingFirstTime() {
    const agentScheduler = await AgentSchedulerFactory.createChildInstance(this.context);
    this.root.set("agentScheduler", agentScheduler.handle);
}

// When creating your DataObjectFactory
export const MyDataObjectFactory = new DataObjectFactory(
    "my-data-object",
    MyDataObject,
    [],
    {},
    new Map([
      AgentSchedulerFactory.registryEntry,
    ]),
);

Trademark

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.

Use of these trademarks or logos must follow Microsoft's Trademark & Brand Guidelines.

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.