ITaskManagerEvents Interface

Events emitted by ITaskManager.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/task-manager/legacy.

For more information about our API support guarantees, see here.

Signature

export interface ITaskManagerEvents extends ISharedObjectEvents

Extends: ISharedObjectEvents

Call Signatures

Call Signature	Alerts	Return Type	Description
(event: "assigned", listener: TaskEventListener): any	Beta	any	Fires when a task has been exclusively assigned to the client.
(event: "completed", listener: TaskEventListener): any	Beta	any	Fires when a task the client is queued for is completed.
(event: "lost", listener: TaskEventListener): any	Beta	any	Fires when the task assignment is lost by the local client.

Call Signature Details

(event: "assigned", listener: TaskEventListener): any

Fires when a task has been exclusively assigned to the client.

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

(event: "assigned", listener: TaskEventListener): any;

Remarks

Does not account for known pending ops, but instead only reflects the current consensus state.

(event: "completed", listener: TaskEventListener): any

Fires when a task the client is queued for is completed.

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

(event: "completed", listener: TaskEventListener): any;

(event: "lost", listener: TaskEventListener): any

Fires when the task assignment is lost by the local client.

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

(event: "lost", listener: TaskEventListener): any;

Remarks

This could be due to the client disconnecting or by manually calling abandon(taskId).