ptgb
A complete Telegram Bot API client for Dart

Forum Topics

Part of the API Reference.

getForumTopicIconStickers

Future<List<Json>> getForumTopicIconStickers() async => _l(await call('getForumTopicIconStickers'));

Lists the built-in custom emoji stickers usable as forum topic icons.

createForumTopic

Future<Json> createForumTopic(
    Object chatId,
    String name, {
    int? iconColor,
    String? iconCustomEmojiId,
  }) async =>

Creates a new topic in a forum-enabled supergroup.

editForumTopic

Future<bool> editForumTopic(
    Object chatId,
    int messageThreadId, {
    String? name,
    String? iconCustomEmojiId,
  }) async =>

Renames a forum topic and/or changes its icon.

closeForumTopic

Future<bool> closeForumTopic(Object chatId, int messageThreadId) async => _b(await call(
      'closeForumTopic', {'chat_id': chatId, 'message_thread_id': messageThreadId},),);

Closes a forum topic (prevents new messages until reopened).

reopenForumTopic

Future<bool> reopenForumTopic(Object chatId, int messageThreadId) async => _b(await call(
      'reopenForumTopic', {'chat_id': chatId, 'message_thread_id': messageThreadId},),);

Reopens a previously closed forum topic.

deleteForumTopic

Future<bool> deleteForumTopic(Object chatId, int messageThreadId) async => _b(await call(
      'deleteForumTopic', {'chat_id': chatId, 'message_thread_id': messageThreadId},),);

Deletes a forum topic and every message inside it.

unpinAllForumTopicMessages

Future<bool> unpinAllForumTopicMessages(Object chatId, int messageThreadId) async => _b(await call(
      'unpinAllForumTopicMessages', {'chat_id': chatId, 'message_thread_id': messageThreadId},),);

Unpins every message pinned within a specific forum topic.

editGeneralForumTopic

Future<bool> editGeneralForumTopic(Object chatId, String name) async =>

Renames the forum’s built-in “General” topic.

closeGeneralForumTopic

Future<bool> closeGeneralForumTopic(Object chatId) async =>

Closes the “General” forum topic.

reopenGeneralForumTopic

Future<bool> reopenGeneralForumTopic(Object chatId) async =>

Reopens the “General” forum topic.

hideGeneralForumTopic

Future<bool> hideGeneralForumTopic(Object chatId) async =>

Hides the “General” forum topic from the topic list.

unhideGeneralForumTopic

Future<bool> unhideGeneralForumTopic(Object chatId) async =>

Unhides the “General” forum topic.

unpinAllGeneralForumTopicMessages

Future<bool> unpinAllGeneralForumTopicMessages(Object chatId) async =>

Unpins every message pinned within the “General” forum topic.