Перейти к содержимому

Методы управления топиками

Группа методов класса ZG для работы с супергруппами в режиме форума. Позволяет создавать, редактировать, закрывать и удалять темы.

Контекст

Во всех методах ниже параметры chat_id и thread_id являются необязательными. Если они не переданы, библиотека попытается взять их из текущего входящего обновления (контекста).

createTopic

Создает новую тему.

Параметры

#НазваниеТипОписание
1namestringНазвание темы (1-128 символов).
2icon_colorint|nullЦвет иконки темы в формате RGB (например, 0x6FB9F0).
3icon_custom_emoji_idstring|nullУникальный идентификатор кастомного эмодзи для иконки.
4chat_idint|string|nullID чата.

Пример

php
<?php
require_once __DIR__ . '/vendor/autoload.php';
use ZenithGram\ZenithGram\ZG;

$tg = ZG::create(BOT_TOKEN);

// Создание простой темы
$tg->createTopic('Новости');

// Создание темы с цветом и эмодзи
$tg->createTopic(
    name: 'Флудилка',
    icon_color: 0xFFD67E,
    icon_custom_emoji_id: '5310132165583840589'
);

editTopic

Редактирует название и иконку существующей темы.

Параметры

#НазваниеТипОписание
1namestring|nullНовое название темы.
2icon_custom_emoji_idstring|nullID нового кастомного эмодзи. Пустая строка удалит иконку.
3thread_idint|nullID темы.
4chat_idint|string|nullID чата.

Пример

php
$tg->editTopic(name: 'Архив', thread_id: 12345);

closeTopic

Закрывает тему. В закрытую тему нельзя отправлять сообщения (кроме админов), но она остается видна в списке.

Параметры

#НазваниеТипОписание
1thread_idint|nullID темы.
2chat_idint|string|nullID чата.

Пример

php
$tg->closeTopic();

reopenTopic

Открывает ранее закрытую тему.

Параметры

#НазваниеТипОписание
1thread_idint|nullID темы.
2chat_idint|string|nullID чата.

Пример

php
$tg->reopenTopic();

deleteTopic

Удаляет тему целиком вместе со всеми сообщениями. Это действие необратимо.

Параметры

#НазваниеТипОписание
1thread_idint|nullID темы.
2chat_idint|string|nullID чата.

Пример

php
$tg->deleteTopic();

unpinTopicMessages

Открепляет все закрепленные сообщения внутри конкретной темы.

Параметры

#НазваниеТипОписание
1thread_idint|nullID темы.
2chat_idint|string|nullID чата.

Пример

php
$tg->unpinTopicMessages();

Методы темы "General"

В каждом форуме есть тема "General" (Основная), которая имеет ID 1 (или иногда null в старых клиентах, но API работает с ней отдельно). Для неё существуют специальные методы.

editGeneralTopic

Редактирует название темы "General".

Параметры

#НазваниеТипОписание
1namestringНовое название.
2chat_idint|string|nullID чата.

Пример

php
$tg->editGeneralTopic('Главный чат');

closeGeneralTopic

Закрывает тему "General".

Параметры

#НазваниеТипОписание
1chat_idint|string|nullID чата.

Пример

php
$tg->closeGeneralTopic();

reopenGeneralTopic

Открывает тему "General".

Параметры

#НазваниеТипОписание
1chat_idint|string|nullID чата.

Пример

php
$tg->reopenGeneralTopic();

hideGeneralTopic

Скрывает тему "General" из списка активных тем.

Параметры

#НазваниеТипОписание
1chat_idint|string|nullID чата.

Пример

php
$tg->hideGeneralTopic();

unhideGeneralTopic

Возвращает скрытую тему "General" обратно в список.

Параметры

#НазваниеТипОписание
1chat_idint|string|nullID чата.

Пример

php
$tg->unhideGeneralTopic();

unpinGeneralTopicMessages

Открепляет все сообщения в теме "General".

Параметры

#НазваниеТипОписание
1chat_idint|string|nullID чата.

Пример

php
$tg->unpinGeneralTopicMessages();

Опубликовано под лицензией MIT.