AgentSchedulerFactory Class
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/agent-scheduler/legacy.
For more information about our API support guarantees, see here.
Signature
export declare class AgentSchedulerFactory implements IFluidDataStoreFactory
Implements: IFluidDataStoreFactory
Static Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| registryEntry | Beta | readonly | NamedFluidDataStoreRegistryEntry | |
| type | Beta | readonly |
Static Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| createChildInstance(parentContext) | Beta | Promise<IAgentScheduler> |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| IFluidDataStoreFactory | Beta | readonly | AgentSchedulerFactory | |
| type | Beta | readonly |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| instantiateDataStore(context, existing) | Beta | Promise<FluidDataStoreRuntime> |
Property Details
IFluidDataStoreFactory
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
get IFluidDataStoreFactory(): AgentSchedulerFactory;
Type: AgentSchedulerFactory
registryEntry
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
static get registryEntry(): NamedFluidDataStoreRegistryEntry;
Type: NamedFluidDataStoreRegistryEntry
type
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
readonly type = "_scheduler";
type
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
static readonly type = "_scheduler";
Method Details
createChildInstance
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
static createChildInstance(parentContext: IFluidDataStoreContext): Promise<IAgentScheduler>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| parentContext | IFluidDataStoreContext |
Returns
Return type: Promise<IAgentScheduler>
instantiateDataStore
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
instantiateDataStore(context: IFluidDataStoreContext, existing: boolean): Promise<FluidDataStoreRuntime>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| context | IFluidDataStoreContext | |
| existing | boolean |
Returns
Return type: Promise<FluidDataStoreRuntime>