@netgrif/components-core/lib/task-content/model/task-event-notification.d.ts

Netgrif Application engine frontend core Angular library

import { TaskEvent } from './task-event';
import { Task } from '../../resources/public-api';
import { TaskEventOutcome } from '../../event/model/event-outcomes/task-outcomes/task-event-outcome';
/**
 * Holds the information about an event that occurred to some {@link Task} resource.
 *
 * Task events correspond more or less 1-to-1 to backend calls and their results.
 */
export interface TaskEventNotification {
    /**
     * StringId of the affected {@link Task}
     */
    taskId: string;
    /**
     * StringId of the Transition
     */
    transitionId: string;
    /**
     * The event that occurred
     */
    event: TaskEvent;
    /**
     * Success state of the event
     */
    success: boolean;
    /**
     * The task eventOutcome from backend
     */
    outcome?: TaskEventOutcome;
}
/**
 * @param task affected Task object
 * @param event the reported Task event
 * @param success success state of the reported event
 * @param outcome TaskEventOutcome
 * @returns the notification informing about the event
 */
export declare function createTaskEventNotification(task: Task, event: TaskEvent, success: boolean, outcome?: TaskEventOutcome): TaskEventNotification;