Lime Web Components API Documentation - v7.4.0
    Preparing search index...

    Enumeration TaskEventType

    Events dispatched by the task service

    Listen to these through the EventDispatcher service. They are not dispatched on window.

    TaskEventType.Success and TaskEventType.Failed are cancelable. Call preventDefault() on the event to stop the default notification, for example to show your own message instead.

    import {
    PlatformServiceName,
    TaskEvent,
    TaskEventType,
    } from '@limetech/lime-web-components';

    const eventDispatcher = platform.get(PlatformServiceName.EventDispatcher);

    const onTaskSuccess = (event: TaskEvent) => {
    // Suppress the built-in snackbar and show our own message instead
    event.preventDefault();

    const { task } = event.detail;
    console.log('Task finished', task.id, task.result);
    };

    const onTaskFailure = (event: TaskEvent) => {
    const { error } = event.detail;
    console.error('Task failed', error);
    };

    eventDispatcher.addListener(TaskEventType.Success, onTaskSuccess);
    eventDispatcher.addListener(TaskEventType.Failed, onTaskFailure);

    // Remember to remove the listeners in `disconnectedCallback()`
    eventDispatcher.removeListener(TaskEventType.Success, onTaskSuccess);
    eventDispatcher.removeListener(TaskEventType.Failed, onTaskFailure);
    Index

    Enumeration Members

    Enumeration Members

    Created: "task.created"

    Dispatched when a task has been created.

    Failed: "task.failed"

    Dispatched if an error occured while running the task

    Success: "task.success"

    Dispatched when the task has successfully been completed