Inheritance diagram for ilMailDeliveryJobUserInteraction:

Collaboration diagram for ilMailDeliveryJobUserInteraction:

Public Member Functions
	getOptions (array $input)

	getRemoveOption ()
	Returns Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position) See also self::getAbortOption(); More...

	getInputTypes ()

	getOutputType ()

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

	getMessage (array $input)
	@inheritDoc More...

	canBeSkipped (array $input)
	@inheritDoc More...

Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction
	getMessage (array $input)
	@inheritDoc More...

	canBeSkipped (array $input)
	@inheritDoc More...

	getSkippedValue (array $input)

	isFinal ()

Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	setInput (array $values)

	getOutput ()

	getInput ()

	getType ()

	unfoldTask ()
	Unfold the task. More...

	getRemoveOption ()
	Returns Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position) See also self::getAbortOption(); More...

	getAbortOption ()
	Returns Option In case a Job is failed or did not respond for some time, an Abort-Option is displayed. There is already a Standard-Abort-Option registered, you can override with your own and do some cleanup if possible. More...

	getType ()

	getInputTypes ()

	getOutputType ()

	getOutput ()

	setInput (array $values)

	getInput ()

	unfoldTask ()

	getRemoveOption ()

	getAbortOption ()

Public Member Functions inherited from ILIAS\BackgroundTasks\Task\UserInteraction
	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)

Data Fields
final const string	OPTION_CANCEL = 'cancel'

Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'

const	MAIN_ABORT = 'bt_main_abort'

Additional Inherited Members
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes (array $values)

	extractType ($value)

Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
array	$input = []

Value	$output

Detailed Description

Definition at line 29 of file class.ilMailDeliveryJobUserInteraction.php.

Member Function Documentation

◆ canBeSkipped()

ilMailDeliveryJobUserInteraction::canBeSkipped ( array $input )

@inheritDoc

Reimplemented from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction.

Definition at line 66 of file class.ilMailDeliveryJobUserInteraction.php.

                                              : bool
    {
        return true;
    }

◆ getInputTypes()

ilMailDeliveryJobUserInteraction::getInputTypes ( )

Returns: Type[] A list of types that are taken as input.

Implements ILIAS\BackgroundTasks\Task.

Definition at line 43 of file class.ilMailDeliveryJobUserInteraction.php.

                                   : array
    {
        return [];
    }

◆ getMessage()

ilMailDeliveryJobUserInteraction::getMessage ( array $input )

@inheritDoc

Reimplemented from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractUserInteraction.

Definition at line 61 of file class.ilMailDeliveryJobUserInteraction.php.

                                            : string
    {
        return '';
    }

◆ getOptions()

ilMailDeliveryJobUserInteraction::getOptions ( array $input )

Parameters

Value[] $input The input value of this task.

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

Implements ILIAS\BackgroundTasks\Task\UserInteraction.

Definition at line 33 of file class.ilMailDeliveryJobUserInteraction.php.

                                            : array
    {
        return [];
    }

◆ getOutputType()

ilMailDeliveryJobUserInteraction::getOutputType ( )

Implements ILIAS\BackgroundTasks\Task.

Definition at line 48 of file class.ilMailDeliveryJobUserInteraction.php.

                                   : Type
    {
        return new SingleType(StringValue::class);
    }

◆ getRemoveOption()

ilMailDeliveryJobUserInteraction::getRemoveOption ( )

Returns: Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position)

See also: self::getAbortOption();

Reimplemented from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask.

Definition at line 38 of file class.ilMailDeliveryJobUserInteraction.php.

                                     : Option
    {
        return new UserInteractionOption('remove', self::OPTION_CANCEL);
    }

◆ interaction()

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

Definition at line 53 of file class.ilMailDeliveryJobUserInteraction.php.

     : Value {
        return $input[0];
    }

Field Documentation

◆ OPTION_CANCEL

final const string ilMailDeliveryJobUserInteraction::OPTION_CANCEL = 'cancel'

Definition at line 31 of file class.ilMailDeliveryJobUserInteraction.php.

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

components/ILIAS/Mail/classes/BackgroundTask/class.ilMailDeliveryJobUserInteraction.php

Public Member Functions

Data Fields

Additional Inherited Members