Safe Haskell	None
Language	Haskell2010

Telegram.Bot.API.Forum

Contents

getForumTopicIconStickers
createForumTopic
editForumTopic
closeForumTopic
reopenForumTopic
deleteForumTopic
unpinAllForumTopicMessages

Synopsis

type GetForumTopicIconStickers = "getForumTopicIconStickers" :> Post '[JSON] (Response [Sticker])
getForumTopicIconStickers :: ClientM (Response [Sticker])
data CreateForumTopicRequest = CreateForumTopicRequest {
- createForumTopicRequestChatId :: SomeChatId
- createForumTopicRequestName :: Text
- createForumTopicRequestIconColor :: Maybe Integer
- createForumTopicRequestIconCustomEmojiId :: Maybe Text
}
type CreateForumTopic = "createForumTopic" :> (ReqBody '[JSON] CreateForumTopicRequest :> Post '[JSON] (Response ForumTopic))
createForumTopic :: CreateForumTopicRequest -> ClientM (Response ForumTopic)
data EditForumTopicRequest = EditForumTopicRequest {
- editForumTopicChatId :: SomeChatId
- editForumTopicMessageThreadId :: MessageThreadId
- editForumTopicName :: Maybe Text
- editForumTopicIconCustomEmojiId :: Maybe Text
}
type EditForumTopic = "editForumTopic" :> (ReqBody '[JSON] EditForumTopicRequest :> Post '[JSON] (Response Bool))
editForumTopic :: EditForumTopicRequest -> ClientM (Response Bool)
data CloseForumTopicRequest = CloseForumTopicRequest {
- closeForumTopicRequestChatId :: SomeChatId
- closeForumTopicRequestMessageThreadId :: MessageThreadId
}
type CloseForumTopic = "closeForumTopic" :> (ReqBody '[JSON] CloseForumTopicRequest :> Post '[JSON] (Response Bool))
closeForumTopic :: CloseForumTopicRequest -> ClientM (Response Bool)
data ReopenForumTopicRequest = ReopenForumTopicRequest {
- reopenForumTopicRequestChatId :: SomeChatId
- reopenForumTopicRequestMessageThreadId :: MessageThreadId
}
type ReopenForumTopic = "reopenForumTopic" :> (ReqBody '[JSON] ReopenForumTopicRequest :> Post '[JSON] (Response Bool))
reopenForumTopic :: ReopenForumTopicRequest -> ClientM (Response Bool)
data DeleteForumTopicRequest = DeleteForumTopicRequest {
- deleteForumTopicRequestChatId :: SomeChatId
- deleteForumTopicRequestMessageThreadId :: MessageThreadId
}
type DeleteForumTopic = "deleteForumTopic" :> (ReqBody '[JSON] DeleteForumTopicRequest :> Post '[JSON] (Response Bool))
deleteForumTopic :: DeleteForumTopicRequest -> ClientM (Response Bool)
data UnpinAllForumTopicMessagesRequest = UnpinAllForumTopicMessagesRequest {
- unpinAllForumTopicMessagesRequestChatId :: SomeChatId
- unpinAllForumTopicMessagesRequestMessageThreadId :: MessageThreadId
}
type UnpinAllForumTopicMessages = "unpinAllForumTopicMessages" :> (ReqBody '[JSON] UnpinAllForumTopicMessagesRequest :> Post '[JSON] (Response Bool))
unpinAllForumTopicMessages :: UnpinAllForumTopicMessagesRequest -> ClientM (Response Bool)

`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

createForumTopicRequestChatId :: SomeChatId
Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).
createForumTopicRequestName :: Text
Topic name, 1-128 characters.
createForumTopicRequestIconColor :: Maybe Integer
Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F).
createForumTopicRequestIconCustomEmojiId :: Maybe Text
Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.

Instances

Instances details

Generic CreateForumTopicRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Associated Types type Rep CreateForumTopicRequest :: Type -> Type # Methods from :: CreateForumTopicRequest -> Rep CreateForumTopicRequest x # to :: Rep CreateForumTopicRequest x -> CreateForumTopicRequest #
ToJSON CreateForumTopicRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Methods toJSON :: CreateForumTopicRequest -> Value toEncoding :: CreateForumTopicRequest -> Encoding toJSONList :: [CreateForumTopicRequest] -> Value toEncodingList :: [CreateForumTopicRequest] -> Encoding
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.7-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

editForumTopicChatId :: SomeChatId
Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).
editForumTopicMessageThreadId :: MessageThreadId
Unique identifier for the target message thread of the forum topic.
editForumTopicName :: Maybe Text
New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept.
editForumTopicIconCustomEmojiId :: Maybe Text
New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept.

Instances

Instances details

Generic EditForumTopicRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Associated Types type Rep EditForumTopicRequest :: Type -> Type # Methods from :: EditForumTopicRequest -> Rep EditForumTopicRequest x # to :: Rep EditForumTopicRequest x -> EditForumTopicRequest #
ToJSON EditForumTopicRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Methods toJSON :: EditForumTopicRequest -> Value toEncoding :: EditForumTopicRequest -> Encoding toJSONList :: [EditForumTopicRequest] -> Value toEncodingList :: [EditForumTopicRequest] -> Encoding
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.7-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 closeForumTopicRequestChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). closeForumTopicRequestMessageThreadId :: MessageThreadId Unique identifier for the target message thread of the forum topic.

Instances

Instances details

Generic CloseForumTopicRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Associated Types type Rep CloseForumTopicRequest :: Type -> Type # Methods from :: CloseForumTopicRequest -> Rep CloseForumTopicRequest x # to :: Rep CloseForumTopicRequest x -> CloseForumTopicRequest #
ToJSON CloseForumTopicRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Methods toJSON :: CloseForumTopicRequest -> Value toEncoding :: CloseForumTopicRequest -> Encoding toJSONList :: [CloseForumTopicRequest] -> Value toEncodingList :: [CloseForumTopicRequest] -> Encoding
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.7-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 reopenForumTopicRequestChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). reopenForumTopicRequestMessageThreadId :: MessageThreadId Unique identifier for the target message thread of the forum topic.

Instances

Instances details

Generic ReopenForumTopicRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Associated Types type Rep ReopenForumTopicRequest :: Type -> Type # Methods from :: ReopenForumTopicRequest -> Rep ReopenForumTopicRequest x # to :: Rep ReopenForumTopicRequest x -> ReopenForumTopicRequest #
ToJSON ReopenForumTopicRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Methods toJSON :: ReopenForumTopicRequest -> Value toEncoding :: ReopenForumTopicRequest -> Encoding toJSONList :: [ReopenForumTopicRequest] -> Value toEncodingList :: [ReopenForumTopicRequest] -> Encoding
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.7-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 deleteForumTopicRequestChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). deleteForumTopicRequestMessageThreadId :: MessageThreadId Unique identifier for the target message thread of the forum topic.

Instances

Instances details

Generic DeleteForumTopicRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Associated Types type Rep DeleteForumTopicRequest :: Type -> Type # Methods from :: DeleteForumTopicRequest -> Rep DeleteForumTopicRequest x # to :: Rep DeleteForumTopicRequest x -> DeleteForumTopicRequest #
ToJSON DeleteForumTopicRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Methods toJSON :: DeleteForumTopicRequest -> Value toEncoding :: DeleteForumTopicRequest -> Encoding toJSONList :: [DeleteForumTopicRequest] -> Value toEncodingList :: [DeleteForumTopicRequest] -> Encoding
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.7-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 unpinAllForumTopicMessagesRequestChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) unpinAllForumTopicMessagesRequestMessageThreadId :: MessageThreadId Unique identifier for the target message thread of the forum topic.

Instances

Instances details

Generic UnpinAllForumTopicMessagesRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Associated Types type Rep UnpinAllForumTopicMessagesRequest :: Type -> Type # Methods from :: UnpinAllForumTopicMessagesRequest -> Rep UnpinAllForumTopicMessagesRequest x # to :: Rep UnpinAllForumTopicMessagesRequest x -> UnpinAllForumTopicMessagesRequest #
ToJSON UnpinAllForumTopicMessagesRequest Source #
Instance details Defined in Telegram.Bot.API.Forum Methods toJSON :: UnpinAllForumTopicMessagesRequest -> Value toEncoding :: UnpinAllForumTopicMessagesRequest -> Encoding toJSONList :: [UnpinAllForumTopicMessagesRequest] -> Value toEncodingList :: [UnpinAllForumTopicMessagesRequest] -> Encoding
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.7-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.