telegram-bot-simple-0.8: Easy to use library for building Telegram bots.
Safe HaskellNone
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
Generic CreateForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep CreateForumTopicRequest :: Type -> Type #

ToJSON CreateForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep CreateForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep CreateForumTopicRequest = D1 ('MetaData "CreateForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "CreateForumTopicRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createForumTopicRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "createForumTopicRequestName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "createForumTopicRequestIconColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "createForumTopicRequestIconCustomEmojiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

type CreateForumTopic = "createForumTopic" :> (ReqBody '[JSON] CreateForumTopicRequest :> Post '[JSON] (Response ForumTopic)) Source #

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
Generic EditForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep EditForumTopicRequest :: Type -> Type #

ToJSON EditForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep EditForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep EditForumTopicRequest = D1 ('MetaData "EditForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" '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)))))

type EditForumTopic = "editForumTopic" :> (ReqBody '[JSON] EditForumTopicRequest :> Post '[JSON] (Response Bool)) Source #

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
Generic CloseForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep CloseForumTopicRequest :: Type -> Type #

ToJSON CloseForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep CloseForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep CloseForumTopicRequest = D1 ('MetaData "CloseForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "CloseForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "closeForumTopicRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "closeForumTopicRequestMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageThreadId)))

type CloseForumTopic = "closeForumTopic" :> (ReqBody '[JSON] CloseForumTopicRequest :> Post '[JSON] (Response Bool)) Source #

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
Generic ReopenForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep ReopenForumTopicRequest :: Type -> Type #

ToJSON ReopenForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep ReopenForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep ReopenForumTopicRequest = D1 ('MetaData "ReopenForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "ReopenForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "reopenForumTopicRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "reopenForumTopicRequestMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageThreadId)))

type ReopenForumTopic = "reopenForumTopic" :> (ReqBody '[JSON] ReopenForumTopicRequest :> Post '[JSON] (Response Bool)) Source #

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
Generic DeleteForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep DeleteForumTopicRequest :: Type -> Type #

ToJSON DeleteForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep DeleteForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep DeleteForumTopicRequest = D1 ('MetaData "DeleteForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "DeleteForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleteForumTopicRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "deleteForumTopicRequestMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageThreadId)))

type DeleteForumTopic = "deleteForumTopic" :> (ReqBody '[JSON] DeleteForumTopicRequest :> Post '[JSON] (Response Bool)) Source #

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

Instances

Instances details
Generic UnpinAllForumTopicMessagesRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep UnpinAllForumTopicMessagesRequest :: Type -> Type #

ToJSON UnpinAllForumTopicMessagesRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep UnpinAllForumTopicMessagesRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep UnpinAllForumTopicMessagesRequest = D1 ('MetaData "UnpinAllForumTopicMessagesRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "UnpinAllForumTopicMessagesRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "unpinAllForumTopicMessagesRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "unpinAllForumTopicMessagesRequestMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageThreadId)))

type UnpinAllForumTopicMessages = "unpinAllForumTopicMessages" :> (ReqBody '[JSON] UnpinAllForumTopicMessagesRequest :> Post '[JSON] (Response Bool)) Source #

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
Generic EditGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep EditGeneralForumTopicRequest :: Type -> Type #

ToJSON EditGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep EditGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep EditGeneralForumTopicRequest = D1 ('MetaData "EditGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "EditGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "editGeneralForumTopicRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "editGeneralForumTopicRequestName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

type EditGeneralForumTopic = "editGeneralForumTopic" :> (ReqBody '[JSON] EditGeneralForumTopicRequest :> Post '[JSON] (Response Bool)) Source #

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

Instances

Instances details
Generic CloseGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep CloseGeneralForumTopicRequest :: Type -> Type #

ToJSON CloseGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep CloseGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep CloseGeneralForumTopicRequest = D1 ('MetaData "CloseGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "CloseGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "closeGeneralForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)))

type CloseGeneralForumTopic = "closeGeneralForumTopic" :> (ReqBody '[JSON] CloseGeneralForumTopicRequest :> Post '[JSON] (Response Bool)) Source #

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

Instances

Instances details
Generic ReopenGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep ReopenGeneralForumTopicRequest :: Type -> Type #

ToJSON ReopenGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep ReopenGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep ReopenGeneralForumTopicRequest = D1 ('MetaData "ReopenGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "ReopenGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "reopenGeneralForumTopicRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)))

type ReopenGeneralForumTopic = "reopenGeneralForumTopic" :> (ReqBody '[JSON] ReopenGeneralForumTopicRequest :> Post '[JSON] (Response Bool)) Source #

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
Generic HideGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep HideGeneralForumTopicRequest :: Type -> Type #

ToJSON HideGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep HideGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep HideGeneralForumTopicRequest = D1 ('MetaData "HideGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "HideGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "hideGeneralForumTopicRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)))

type HideGeneralForumTopic = "hideGeneralForumTopic" :> (ReqBody '[JSON] HideGeneralForumTopicRequest :> Post '[JSON] (Response Bool)) Source #

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

Instances

Instances details
Generic UnhideGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep UnhideGeneralForumTopicRequest :: Type -> Type #

ToJSON UnhideGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep UnhideGeneralForumTopicRequest Source # 
Instance details

Defined in Telegram.Bot.API.Forum

type Rep UnhideGeneralForumTopicRequest = D1 ('MetaData "UnhideGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-simple-0.8-inplace" 'False) (C1 ('MetaCons "UnhideGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "unhideGeneralForumTopicRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)))

type UnhideGeneralForumTopic = "unhideGeneralForumTopic" :> (ReqBody '[JSON] UnhideGeneralForumTopicRequest :> Post '[JSON] (Response Bool)) Source #

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.