Модуль Задачи > Отображение и поведение

Редактор GitHub

Отображение и поведение

Этот раздел включает команды, которые управляют отображением задач, приоритетами и пользовательскими настройками, такими как “избранное” и “закрепить”.

Примечание: все команды располагаются в пространсве имен Bitrix\Tasks\V2\Public\Command\Task

AddFavoriteCommand

AddFavoriteCommand добавляет задачу в список избранного пользователя.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Favorite\AddFavoriteCommand;

$command = new AddFavoriteCommand(taskId: 100, userId: 1);
if ($result->isSuccess()) {
    echo "Задача добавлена в избранное.";
} else {
    // Обработка ошибок
}

DeleteFavoriteCommand

DeleteFavoriteCommand удаляет задачу из списка избранного.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Favorite\DeleteFavoriteCommand;

$command = new DeleteFavoriteCommand(taskId: 100, userId: 1);
$result = $command->run();

if ($result->isSuccess()) {
    echo "Задача удалена из избранного.";
} else {
    // Обработка ошибок
}

ToggleFavoriteCommand

ToggleFavoriteCommand переключает статус задачи в избранном (добавляет или удаляет).

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя
$notifyLivefeed bool Нет Отправлять уведомление в живую ленту (по умолчанию true)

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Favorite\ToggleFavoriteCommand;

$command = new ToggleFavoriteCommand(taskId: 100, userId: 1);
$result = $command->run();

if ($result->isSuccess()) {
    $isFavorite = $result->getData()['isFavorite'];
    echo "Задача теперь " . ($isFavorite ? "в избранном" : "не в избранном");
} else {
    // Обработка ошибок
}

PinTaskCommand

PinTaskCommand закрепляет задачу вверху списка задач пользователя.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Attention\PinTaskCommand;

$command = new PinTaskCommand(taskId: 100, userId: 1);
if ($result->isSuccess()) {
    echo "Задача закреплена.";
} else {
    // Обработка ошибок
}

UnpinTaskCommand

UnpinTaskCommand открепляет задачу из верха списка.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Attention\UnpinTaskCommand;

$command = new UnpinTaskCommand(taskId: 100, userId: 1);
$result = $command->run();

if ($result->isSuccess()) {
    echo "Задача откреплена.";
} else {
    // Обработка ошибок
}

PinInGroupTaskCommand

PinInGroupTaskCommand закрепляет задачу в пределах группы/проекта.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Attention\PinInGroupTaskCommand;

$command = new PinInGroupTaskCommand(taskId: 100, userId: 1);
$result = $command->run();

if ($result->isSuccess()) {
    echo "Задача закреплена в группе.";
} else {
    foreach ($result->getErrors() as $error) {
        echo "Ошибка: {$error->getMessage()}";
    }
}

UnpinInGroupTaskCommand

UnpinInGroupTaskCommand убирает задачу из закреплённых в пределах группы/проекта.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Attention\UnpinInGroupTaskCommand;

$command = new UnpinInGroupTaskCommand(taskId: 100, userId: 1);
$result = $command->run();

if ($result->isSuccess()) {
    echo "Задача откреплена в группе.";
} else {
    foreach ($result->getErrors() as $error) {
        echo "Ошибка: {$error->getMessage()}";
    }
}

MuteTaskCommand

MuteTaskCommand отключает уведомления о задаче для пользователя.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Attention\MuteTaskCommand;

$command = new MuteTaskCommand(taskId: 100, userId: 1);
$result = $command->run();

if ($result->isSuccess()) {
    echo "Уведомления по задаче отключены.";
} else {
    foreach ($result->getErrors() as $error) {
        echo "Ошибка: {$error->getMessage()}";
    }
}

UnmuteTaskCommand

UnmuteTaskCommand включает уведомления о задаче для пользователя.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Attention\UnmuteTaskCommand;

$command = new UnmuteTaskCommand(taskId: 100, userId: 1);
$result = $command->run();

if ($result->isSuccess()) {
    echo "Уведомления по задаче включены.";
} else {
    foreach ($result->getErrors() as $error) {
        echo "Ошибка: {$error->getMessage()}";
    }
}

SetHighTaskPriorityCommand

SetHighTaskPriorityCommand устанавливает задаче высокий приоритет.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя
$useConsistency bool Нет Использовать консистентность данных (по умолчанию false)

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Attention\SetHighTaskPriorityCommand;

$command = new SetHighTaskPriorityCommand(taskId: 100, userId: 1);
if ($result->isSuccess()) {
    echo "Приоритет изменен на высокий.";
} else {
    // Обработка ошибок
}

SetAverageTaskPriorityCommand

SetAverageTaskPriorityCommand устанавливает задаче средний приоритет.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя
$useConsistency bool Нет Использовать консистентность данных (по умолчанию false)

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Attention\SetAverageTaskPriorityCommand;

$command = new SetAverageTaskPriorityCommand(taskId: 100, userId: 1);
$result = $command->run();

if ($result->isSuccess()) {
    echo "Приоритет изменен на средний.";
} else {
    // Обработка ошибок
}

ViewCommand

ViewCommand регистрирует факт просмотра задачи пользователем.

Входные аргументы:

Параметр Тип Обязательный Описание
$taskId int Да ID задачи
$userId int Да ID пользователя
$viewedTs ?int Нет Timestamp просмотра (по умолчанию null)
$isRealView bool Нет Флаг реального просмотра (по умолчанию false)
$sendPush bool Нет Отправлять push-уведомление (по умолчанию true)
$updateTopicLastVisit bool Нет Обновлять время последнего визита (по умолчанию true)

Пример использования:

use Bitrix\Tasks\V2\Public\Command\Task\Attention\ViewCommand;

$command = new ViewCommand(taskId: 100, userId: 1);
if ($result->isSuccess()) {
    echo "Задача просмотрена.";
} else {
    // Обработка ошибок
}