Delete

CDBResult
CTaskReminders::Delete(
 array arFilter = array()
);

This method deletes notifications for tasks by the arFilter filter.

Method parameters

Parameter	Description
arFilter	Array of the array("filtered field"=>"filter value" [, ...]) type. Filtered field can have the following values: TASK_ID - task ID; USER_ID - user ID; REMIND_DATE - date of notification. Type of filtration can be specified in front of the name: "!" - not equal "<" - less "<=" - less or equal ">" - more ">=" - more or equal "filter values" - single value or an array.

Parameter

Description

arFilter

Array of the array("filtered field"=>"filter value" [, ...]) type. Filtered field can have the following values:

TASK_ID - task ID;
USER_ID - user ID;
REMIND_DATE - date of notification.

Type of filtration can be specified in front of the name:

"!" - not equal
"<" - less
"<=" - less or equal
">" - more
">=" - more or equal

"filter values" - single value or an array.

Returned value

CDBResult object is returned.

Examples of use

<?

// Delete all notifications for the task with ID = 28
if (CModule::IncludeModule("tasks") && $USER->IsAdmin())
{
    $res = CTaskReminders::Delete( 
        Array("TASK_ID" => "28")
    );
}

?>