telegram-bot-api-6.5: Easy to use library for building Telegram bots. Exports Telegram Bot API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Telegram.Bot.API.Forum

Synopsis

getForumTopicIconStickers

type GetForumTopicIconStickers = "getForumTopicIconStickers" :> Post '[JSON] (Response [Sticker]) Source #

getForumTopicIconStickers :: ClientM (Response [Sticker]) Source #

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an '[Sticker]' objects.

createForumTopic

data CreateForumTopicRequest Source #

Constructors

CreateForumTopicRequest 

Fields

Instances

Instances details
ToJSON CreateForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Generic CreateForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep CreateForumTopicRequest :: Type -> Type #

type Rep CreateForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep CreateForumTopicRequest = D1 ('MetaData "CreateForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "CreateForumTopicRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createForumTopicRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "createForumTopicName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "createForumTopicIconColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "createForumTopicIconCustomEmojiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

createForumTopic :: CreateForumTopicRequest -> ClientM (Response ForumTopic) Source #

Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.

editForumTopic

data EditForumTopicRequest Source #

Constructors

EditForumTopicRequest 

Fields

Instances

Instances details
ToJSON EditForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Generic EditForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep EditForumTopicRequest :: Type -> Type #

type Rep EditForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep EditForumTopicRequest = D1 ('MetaData "EditForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "EditForumTopicRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "editForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "editForumTopicMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageThreadId)) :*: (S1 ('MetaSel ('Just "editForumTopicName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "editForumTopicIconCustomEmojiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

editForumTopic :: EditForumTopicRequest -> ClientM (Response Bool) Source #

Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

closeForumTopic

data CloseForumTopicRequest Source #

Constructors

CloseForumTopicRequest 

Fields

Instances

Instances details
ToJSON CloseForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Generic CloseForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep CloseForumTopicRequest :: Type -> Type #

type Rep CloseForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep CloseForumTopicRequest = D1 ('MetaData "CloseForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "CloseForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "closeForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "closeForumTopicMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageThreadId)))

closeForumTopic :: CloseForumTopicRequest -> ClientM (Response Bool) Source #

Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

reopenForumTopic

data ReopenForumTopicRequest Source #

Constructors

ReopenForumTopicRequest 

Fields

Instances

Instances details
ToJSON ReopenForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Generic ReopenForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep ReopenForumTopicRequest :: Type -> Type #

type Rep ReopenForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep ReopenForumTopicRequest = D1 ('MetaData "ReopenForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "ReopenForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "reopenForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "reopenForumTopicMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageThreadId)))

reopenForumTopic :: ReopenForumTopicRequest -> ClientM (Response Bool) Source #

Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

deleteForumTopic

data DeleteForumTopicRequest Source #

Constructors

DeleteForumTopicRequest 

Fields

Instances

Instances details
ToJSON DeleteForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Generic DeleteForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep DeleteForumTopicRequest :: Type -> Type #

type Rep DeleteForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep DeleteForumTopicRequest = D1 ('MetaData "DeleteForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "DeleteForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleteForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "deleteForumTopicMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageThreadId)))

deleteForumTopic :: DeleteForumTopicRequest -> ClientM (Response Bool) Source #

Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

unpinAllForumTopicMessages

data UnpinAllForumTopicMessagesRequest Source #

Constructors

UnpinAllForumTopicMessagesRequest 

Fields

unpinAllForumTopicMessages :: UnpinAllForumTopicMessagesRequest -> ClientM (Response Bool) Source #

Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

editGeneralForumTopic

data EditGeneralForumTopicRequest Source #

Constructors

EditGeneralForumTopicRequest 

Fields

Instances

Instances details
ToJSON EditGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Generic EditGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep EditGeneralForumTopicRequest :: Type -> Type #

type Rep EditGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep EditGeneralForumTopicRequest = D1 ('MetaData "EditGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "EditGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "editGeneralForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "editGeneralForumTopicName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

editGeneralForumTopic :: EditGeneralForumTopicRequest -> ClientM (Response Bool) Source #

Use this method to edit the name of the General topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.

closeGeneralForumTopic

data CloseGeneralForumTopicRequest Source #

Constructors

CloseGeneralForumTopicRequest 

Fields

closeGeneralForumTopic :: CloseGeneralForumTopicRequest -> ClientM (Response Bool) Source #

Use this method to close an open General topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

reopenGeneralForumTopic

data ReopenGeneralForumTopicRequest Source #

Constructors

ReopenGeneralForumTopicRequest 

Fields

reopenGeneralForumTopic :: ReopenGeneralForumTopicRequest -> ClientM (Response Bool) Source #

Use this method to reopen a closed General topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

hideGeneralForumTopic

data HideGeneralForumTopicRequest Source #

Constructors

HideGeneralForumTopicRequest 

Fields

Instances

Instances details
ToJSON HideGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Generic HideGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep HideGeneralForumTopicRequest :: Type -> Type #

type Rep HideGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep HideGeneralForumTopicRequest = D1 ('MetaData "HideGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "HideGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "hideGeneralForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)))

hideGeneralForumTopic :: HideGeneralForumTopicRequest -> ClientM (Response Bool) Source #

Use this method to hide the General topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

unhideGeneralForumTopic

data UnhideGeneralForumTopicRequest Source #

Constructors

UnhideGeneralForumTopicRequest 

Fields

unhideGeneralForumTopic :: UnhideGeneralForumTopicRequest -> ClientM (Response Bool) Source #

Use this method to unhide the General topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.