ILIAS\BackgroundTasks\Task\UserInteraction Interface Reference

Inheritance diagram for ILIAS\BackgroundTasks\Task\UserInteraction:

Collaboration diagram for ILIAS\BackgroundTasks\Task\UserInteraction:

Public Member Functions
	getOptions (array $input)
	canBeSkipped (array $input)
	Decide whether the UserInteraction is presented to the user and he has to decide or user UserInteraction is skipped by the TaskManager. More...
	getSkippedValue (array $input)
	isFinal ()
	interaction (array $input, Option $user_selected_option, Bucket $bucket)
	getMessage (array $input)
Public Member Functions inherited from ILIAS\BackgroundTasks\Task
	getType ()
	getInputTypes ()
	getOutputType ()
	getOutput ()
	setInput (array $values)
	getInput ()
	unfoldTask ()
	getRemoveOption ()
	getAbortOption ()

Detailed Description

Definition at line 31 of file UserInteraction.php.

Member Function Documentation

canBeSkipped()

ILIAS\BackgroundTasks\Task\UserInteraction::canBeSkipped

(

array

$input

)

Decide whether the UserInteraction is presented to the user and he has to decide or user UserInteraction is skipped by the TaskManager.

You must return a valid Value then,

Parameters

Value[]

$input The input value of this task.

See also

getSkippedValue.

Implemented in ilDownloadZipInteraction, ilSumOfFileSizesTooLargeInteraction, ilSumOfWorkspaceFileSizesTooLargeInteraction, ilMailDeliveryJobUserInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction.

Referenced by ILIAS\BackgroundTasks\Implementation\TaskManager\SyncTaskManager\run().

Here is the caller graph for this function:

getMessage()

ILIAS\BackgroundTasks\Task\UserInteraction::getMessage

(

array

$input

)

Parameters

Value[]

$input The input value of this task.

Returns

string $message enables the UserInteraction to be used as a notification (for example when a bucket fails due to an expected condition not being met)

Implemented in ilSumOfFileSizesTooLargeInteraction, ilSumOfWorkspaceFileSizesTooLargeInteraction, ilMailDeliveryJobUserInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction.

getOptions()

ILIAS\BackgroundTasks\Task\UserInteraction::getOptions

(

array

$input

)

Parameters

Value[]

$input The input value of this task.

Returns

Option[] Options are buttons the user can press on this interaction.

Implemented in ilDownloadZipInteraction, ilSumOfFileSizesTooLargeInteraction, ilSumOfWorkspaceFileSizesTooLargeInteraction, ilExDownloadSubmissionsZipInteraction, ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction, ilCalendarDownloadZipInteraction, ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction, ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger, and ilMailDeliveryJobUserInteraction.

getSkippedValue()

ILIAS\BackgroundTasks\Task\UserInteraction::getSkippedValue

(

array

$input

)

Parameters

Value[]

$input

See also

canBeSkipped, whenever you decide to skip the UserInteraction, you have to return a valid Value to proceed.

Implemented in ilSumOfFileSizesTooLargeInteraction, ilSumOfWorkspaceFileSizesTooLargeInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction.

interaction()

ILIAS\BackgroundTasks\Task\UserInteraction::interaction	(	array	$input,
		Option	$user_selected_option,
		Bucket	$bucket
	)

Parameters

Implemented in ilDownloadZipInteraction, ilExDownloadSubmissionsZipInteraction, ilCalendarDownloadZipInteraction, ILIAS\MediaCast\BackgroundTasks\DownloadAllZipInteraction, ilSumOfFileSizesTooLargeInteraction, ilSumOfWorkspaceFileSizesTooLargeInteraction, ILIAS\BackgroundTasks\Implementation\Tasks\NotFoundUserInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\DownloadInteger.

isFinal()

ILIAS\BackgroundTasks\Task\UserInteraction::isFinal

(

)

Returns

bool true if this is the last skippable interaction in your chain/bucket, defaults to true.

Implemented in ilSumOfFileSizesTooLargeInteraction, ilSumOfWorkspaceFileSizesTooLargeInteraction, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction.

---

The documentation for this interface was generated from the following file:

• src/BackgroundTasks/Task/UserInteraction.php