You are here

public function SchedulingStateInterface::getHaltedMessage in Webform Scheduled Tasks 8.2

Get the message associated with a halted task, if one exists.

Parameters

\Drupal\webform_scheduled_tasks\Entity\WebformScheduledTaskInterface $scheduledTask: The task.

Return value

string The message provided when halting the task.

Throws

\Exception Thrown when a task has not been halted.

1 method overrides SchedulingStateInterface::getHaltedMessage()
SchedulingState::getHaltedMessage in src/SchedulingState.php
Get the message associated with a halted task, if one exists.

File

src/SchedulingStateInterface.php, line 77

Class

SchedulingStateInterface
An interface for managing the scheduling state of tasks.

Namespace

Drupal\webform_scheduled_tasks

Code

public function getHaltedMessage(WebformScheduledTaskInterface $scheduledTask);