Safe Haskell	None
Language	Haskell2010

Telegram.Bot.API.Forum

Contents

getForumTopicIconStickers
createForumTopic
editForumTopic
closeForumTopic
reopenForumTopic
deleteForumTopic
unpinAllForumTopicMessages
unpinAllGeneralForumTopicMessages
editGeneralForumTopic
closeGeneralForumTopic
reopenGeneralForumTopic
hideGeneralForumTopic
unhideGeneralForumTopic

Synopsis

type GetForumTopicIconStickers = "getForumTopicIconStickers" :> Post '[JSON] (Response [Sticker])
getForumTopicIconStickers :: ClientM (Response [Sticker])
data CreateForumTopicRequest = CreateForumTopicRequest {
- createForumTopicRequestChatId :: SomeChatId
- createForumTopicName :: Text
- createForumTopicIconColor :: Maybe Integer
- createForumTopicIconCustomEmojiId :: 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 {
- closeForumTopicChatId :: SomeChatId
- closeForumTopicMessageThreadId :: MessageThreadId
}
type CloseForumTopic = "closeForumTopic" :> (ReqBody '[JSON] CloseForumTopicRequest :> Post '[JSON] (Response Bool))
closeForumTopic :: CloseForumTopicRequest -> ClientM (Response Bool)
data ReopenForumTopicRequest = ReopenForumTopicRequest {
- reopenForumTopicChatId :: SomeChatId
- reopenForumTopicMessageThreadId :: MessageThreadId
}
type ReopenForumTopic = "reopenForumTopic" :> (ReqBody '[JSON] ReopenForumTopicRequest :> Post '[JSON] (Response Bool))
reopenForumTopic :: ReopenForumTopicRequest -> ClientM (Response Bool)
data DeleteForumTopicRequest = DeleteForumTopicRequest {
- deleteForumTopicChatId :: SomeChatId
- deleteForumTopicMessageThreadId :: MessageThreadId
}
type DeleteForumTopic = "deleteForumTopic" :> (ReqBody '[JSON] DeleteForumTopicRequest :> Post '[JSON] (Response Bool))
deleteForumTopic :: DeleteForumTopicRequest -> ClientM (Response Bool)
data UnpinAllForumTopicMessagesRequest = UnpinAllForumTopicMessagesRequest {
- unpinAllForumTopicMessagesChatId :: SomeChatId
- unpinAllForumTopicMessagesMessageThreadId :: MessageThreadId
}
type UnpinAllForumTopicMessages = "unpinAllForumTopicMessages" :> (ReqBody '[JSON] UnpinAllForumTopicMessagesRequest :> Post '[JSON] (Response Bool))
unpinAllForumTopicMessages :: UnpinAllForumTopicMessagesRequest -> ClientM (Response Bool)
type UnpinAllGeneralForumTopicMessages = "unpinAllGeneralForumTopicMessages" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool))
unpinAllGeneralForumTopicMessages :: SomeChatId -> ClientM (Response Bool)
data EditGeneralForumTopicRequest = EditGeneralForumTopicRequest {
- editGeneralForumTopicChatId :: SomeChatId
- editGeneralForumTopicName :: Text
}
type EditGeneralForumTopic = "editGeneralForumTopic" :> (ReqBody '[JSON] EditGeneralForumTopicRequest :> Post '[JSON] (Response Bool))
editGeneralForumTopic :: EditGeneralForumTopicRequest -> ClientM (Response Bool)
newtype CloseGeneralForumTopicRequest = CloseGeneralForumTopicRequest {
- closeGeneralForumTopicChatId :: SomeChatId
}
type CloseGeneralForumTopic = "closeGeneralForumTopic" :> (ReqBody '[JSON] CloseGeneralForumTopicRequest :> Post '[JSON] (Response Bool))
closeGeneralForumTopic :: CloseGeneralForumTopicRequest -> ClientM (Response Bool)
newtype ReopenGeneralForumTopicRequest = ReopenGeneralForumTopicRequest {
- reopenGeneralForumTopicRequestChatId :: SomeChatId
}
type ReopenGeneralForumTopic = "reopenGeneralForumTopic" :> (ReqBody '[JSON] ReopenGeneralForumTopicRequest :> Post '[JSON] (Response Bool))
reopenGeneralForumTopic :: ReopenGeneralForumTopicRequest -> ClientM (Response Bool)
newtype HideGeneralForumTopicRequest = HideGeneralForumTopicRequest {
- hideGeneralForumTopicChatId :: SomeChatId
}
type HideGeneralForumTopic = "hideGeneralForumTopic" :> (ReqBody '[JSON] HideGeneralForumTopicRequest :> Post '[JSON] (Response Bool))
hideGeneralForumTopic :: HideGeneralForumTopicRequest -> ClientM (Response Bool)
newtype UnhideGeneralForumTopicRequest = UnhideGeneralForumTopicRequest {
- unhideGeneralForumTopicChatId :: SomeChatId
}
type UnhideGeneralForumTopic = "unhideGeneralForumTopic" :> (ReqBody '[JSON] UnhideGeneralForumTopicRequest :> Post '[JSON] (Response Bool))
unhideGeneralForumTopic :: UnhideGeneralForumTopicRequest -> ClientM (Response Bool)
defUnhideGeneralForumTopic :: SomeChatId -> UnhideGeneralForumTopicRequest
defHideGeneralForumTopic :: SomeChatId -> HideGeneralForumTopicRequest
defReopenGeneralForumTopic :: SomeChatId -> ReopenGeneralForumTopicRequest
defCloseGeneralForumTopic :: SomeChatId -> CloseGeneralForumTopicRequest
defEditGeneralForumTopic :: SomeChatId -> Text -> EditGeneralForumTopicRequest
defUnpinAllForumTopicMessages :: SomeChatId -> MessageThreadId -> UnpinAllForumTopicMessagesRequest
defDeleteForumTopic :: SomeChatId -> MessageThreadId -> DeleteForumTopicRequest
defReopenForumTopic :: SomeChatId -> MessageThreadId -> ReopenForumTopicRequest
defCloseForumTopic :: SomeChatId -> MessageThreadId -> CloseForumTopicRequest
defEditForumTopic :: SomeChatId -> MessageThreadId -> EditForumTopicRequest
defCreateForumTopic :: SomeChatId -> Text -> CreateForumTopicRequest

`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).
createForumTopicName :: Text
Topic name, 1-128 characters.
createForumTopicIconColor :: 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).
createForumTopicIconCustomEmojiId :: 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

ToJSON CreateForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Methods

toJSON :: CreateForumTopicRequest -> Value #

toEncoding :: CreateForumTopicRequest -> Encoding #

toJSONList :: [CreateForumTopicRequest] -> Value #

toEncodingList :: [CreateForumTopicRequest] -> Encoding #

omitField :: CreateForumTopicRequest -> Bool #

Generic CreateForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep CreateForumTopicRequest

Instance details

Defined in Telegram.Bot.API.Forum

type Rep CreateForumTopicRequest = D1 ('MetaData "CreateForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" '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)))))

Methods

from :: CreateForumTopicRequest -> Rep CreateForumTopicRequest x #

to :: Rep CreateForumTopicRequest x -> CreateForumTopicRequest #

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-7.4.4-CbkblO6b3n86XenTUj4wdS" '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)))))

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

ToJSON EditForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Methods

toJSON :: EditForumTopicRequest -> Value #

toEncoding :: EditForumTopicRequest -> Encoding #

toJSONList :: [EditForumTopicRequest] -> Value #

toEncodingList :: [EditForumTopicRequest] -> Encoding #

omitField :: EditForumTopicRequest -> Bool #

Generic EditForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep EditForumTopicRequest

Instance details

Defined in Telegram.Bot.API.Forum

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

Methods

from :: EditForumTopicRequest -> Rep EditForumTopicRequest x #

to :: Rep EditForumTopicRequest x -> EditForumTopicRequest #

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-7.4.4-CbkblO6b3n86XenTUj4wdS" '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 closeForumTopicChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). closeForumTopicMessageThreadId :: MessageThreadId Unique identifier for the target message thread of the forum topic.

Instances

Instances details

ToJSON CloseForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Methods

toJSON :: CloseForumTopicRequest -> Value #

toEncoding :: CloseForumTopicRequest -> Encoding #

toJSONList :: [CloseForumTopicRequest] -> Value #

toEncodingList :: [CloseForumTopicRequest] -> Encoding #

omitField :: CloseForumTopicRequest -> Bool #

Generic CloseForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep CloseForumTopicRequest

Instance details

Defined in Telegram.Bot.API.Forum

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

Methods

from :: CloseForumTopicRequest -> Rep CloseForumTopicRequest x #

to :: Rep CloseForumTopicRequest x -> CloseForumTopicRequest #

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-7.4.4-CbkblO6b3n86XenTUj4wdS" 'False) (C1 ('MetaCons "CloseForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "closeForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "closeForumTopicMessageThreadId") '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 reopenForumTopicChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). reopenForumTopicMessageThreadId :: MessageThreadId Unique identifier for the target message thread of the forum topic.

Instances

Instances details

ToJSON ReopenForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Methods

toJSON :: ReopenForumTopicRequest -> Value #

toEncoding :: ReopenForumTopicRequest -> Encoding #

toJSONList :: [ReopenForumTopicRequest] -> Value #

toEncodingList :: [ReopenForumTopicRequest] -> Encoding #

omitField :: ReopenForumTopicRequest -> Bool #

Generic ReopenForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep ReopenForumTopicRequest

Instance details

Defined in Telegram.Bot.API.Forum

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

Methods

from :: ReopenForumTopicRequest -> Rep ReopenForumTopicRequest x #

to :: Rep ReopenForumTopicRequest x -> ReopenForumTopicRequest #

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-7.4.4-CbkblO6b3n86XenTUj4wdS" 'False) (C1 ('MetaCons "ReopenForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "reopenForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "reopenForumTopicMessageThreadId") '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 deleteForumTopicChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). deleteForumTopicMessageThreadId :: MessageThreadId Unique identifier for the target message thread of the forum topic.

Instances

Instances details

ToJSON DeleteForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Methods

toJSON :: DeleteForumTopicRequest -> Value #

toEncoding :: DeleteForumTopicRequest -> Encoding #

toJSONList :: [DeleteForumTopicRequest] -> Value #

toEncodingList :: [DeleteForumTopicRequest] -> Encoding #

omitField :: DeleteForumTopicRequest -> Bool #

Generic DeleteForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep DeleteForumTopicRequest

Instance details

Defined in Telegram.Bot.API.Forum

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

Methods

from :: DeleteForumTopicRequest -> Rep DeleteForumTopicRequest x #

to :: Rep DeleteForumTopicRequest x -> DeleteForumTopicRequest #

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-7.4.4-CbkblO6b3n86XenTUj4wdS" 'False) (C1 ('MetaCons "DeleteForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleteForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "deleteForumTopicMessageThreadId") '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 unpinAllForumTopicMessagesChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) unpinAllForumTopicMessagesMessageThreadId :: MessageThreadId Unique identifier for the target message thread of the forum topic.

Instances

Instances details

ToJSON UnpinAllForumTopicMessagesRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Generic UnpinAllForumTopicMessagesRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep UnpinAllForumTopicMessagesRequest

Instance details

Defined in Telegram.Bot.API.Forum

type Rep UnpinAllForumTopicMessagesRequest = D1 ('MetaData "UnpinAllForumTopicMessagesRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'False) (C1 ('MetaCons "UnpinAllForumTopicMessagesRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "unpinAllForumTopicMessagesChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "unpinAllForumTopicMessagesMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageThreadId)))

Methods

from :: UnpinAllForumTopicMessagesRequest -> Rep UnpinAllForumTopicMessagesRequest x #

to :: Rep UnpinAllForumTopicMessagesRequest x -> UnpinAllForumTopicMessagesRequest #

type Rep UnpinAllForumTopicMessagesRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

type Rep UnpinAllForumTopicMessagesRequest = D1 ('MetaData "UnpinAllForumTopicMessagesRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'False) (C1 ('MetaCons "UnpinAllForumTopicMessagesRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "unpinAllForumTopicMessagesChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "unpinAllForumTopicMessagesMessageThreadId") '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.

`unpinAllGeneralForumTopicMessages`

type UnpinAllGeneralForumTopicMessages = "unpinAllGeneralForumTopicMessages" :> (RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool)) Source #

unpinAllGeneralForumTopicMessages Source #

Arguments

:: SomeChatId	Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
-> ClientM (Response Bool)

Use this method to clear the list of pinned messages in a General 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 editGeneralForumTopicChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). editGeneralForumTopicName :: Text New topic name, 1-128 characters.

Instances

Instances details

ToJSON EditGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Methods

toJSON :: EditGeneralForumTopicRequest -> Value #

toEncoding :: EditGeneralForumTopicRequest -> Encoding #

toJSONList :: [EditGeneralForumTopicRequest] -> Value #

toEncodingList :: [EditGeneralForumTopicRequest] -> Encoding #

omitField :: EditGeneralForumTopicRequest -> Bool #

Generic EditGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep EditGeneralForumTopicRequest

Instance details

Defined in Telegram.Bot.API.Forum

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

Methods

from :: EditGeneralForumTopicRequest -> Rep EditGeneralForumTopicRequest x #

to :: Rep EditGeneralForumTopicRequest x -> EditGeneralForumTopicRequest #

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-7.4.4-CbkblO6b3n86XenTUj4wdS" 'False) (C1 ('MetaCons "EditGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "editGeneralForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: S1 ('MetaSel ('Just "editGeneralForumTopicName") '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`

newtype CloseGeneralForumTopicRequest Source #

Constructors

CloseGeneralForumTopicRequest
Fields closeGeneralForumTopicChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).

Instances

Instances details

ToJSON CloseGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Methods

toJSON :: CloseGeneralForumTopicRequest -> Value #

toEncoding :: CloseGeneralForumTopicRequest -> Encoding #

toJSONList :: [CloseGeneralForumTopicRequest] -> Value #

toEncodingList :: [CloseGeneralForumTopicRequest] -> Encoding #

omitField :: CloseGeneralForumTopicRequest -> Bool #

Generic CloseGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep CloseGeneralForumTopicRequest

Instance details

Defined in Telegram.Bot.API.Forum

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

Methods

from :: CloseGeneralForumTopicRequest -> Rep CloseGeneralForumTopicRequest x #

to :: Rep CloseGeneralForumTopicRequest x -> CloseGeneralForumTopicRequest #

type Rep CloseGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

type Rep CloseGeneralForumTopicRequest = D1 ('MetaData "CloseGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'True) (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`

newtype ReopenGeneralForumTopicRequest Source #

Constructors

ReopenGeneralForumTopicRequest
Fields reopenGeneralForumTopicRequestChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).

Instances

Instances details

ToJSON ReopenGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Methods

toJSON :: ReopenGeneralForumTopicRequest -> Value #

toEncoding :: ReopenGeneralForumTopicRequest -> Encoding #

toJSONList :: [ReopenGeneralForumTopicRequest] -> Value #

toEncodingList :: [ReopenGeneralForumTopicRequest] -> Encoding #

omitField :: ReopenGeneralForumTopicRequest -> Bool #

Generic ReopenGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep ReopenGeneralForumTopicRequest

Instance details

Defined in Telegram.Bot.API.Forum

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

Methods

from :: ReopenGeneralForumTopicRequest -> Rep ReopenGeneralForumTopicRequest x #

to :: Rep ReopenGeneralForumTopicRequest x -> ReopenGeneralForumTopicRequest #

type Rep ReopenGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

type Rep ReopenGeneralForumTopicRequest = D1 ('MetaData "ReopenGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'True) (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`

newtype HideGeneralForumTopicRequest Source #

Constructors

HideGeneralForumTopicRequest
Fields hideGeneralForumTopicChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).

Instances

Instances details

ToJSON HideGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Methods

toJSON :: HideGeneralForumTopicRequest -> Value #

toEncoding :: HideGeneralForumTopicRequest -> Encoding #

toJSONList :: [HideGeneralForumTopicRequest] -> Value #

toEncodingList :: [HideGeneralForumTopicRequest] -> Encoding #

omitField :: HideGeneralForumTopicRequest -> Bool #

Generic HideGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep HideGeneralForumTopicRequest

Instance details

Defined in Telegram.Bot.API.Forum

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

Methods

from :: HideGeneralForumTopicRequest -> Rep HideGeneralForumTopicRequest x #

to :: Rep HideGeneralForumTopicRequest x -> HideGeneralForumTopicRequest #

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-7.4.4-CbkblO6b3n86XenTUj4wdS" 'True) (C1 ('MetaCons "HideGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "hideGeneralForumTopicChatId") '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`

newtype UnhideGeneralForumTopicRequest Source #

Constructors

UnhideGeneralForumTopicRequest
Fields unhideGeneralForumTopicChatId :: SomeChatId Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

Instances

Instances details

ToJSON UnhideGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Methods

toJSON :: UnhideGeneralForumTopicRequest -> Value #

toEncoding :: UnhideGeneralForumTopicRequest -> Encoding #

toJSONList :: [UnhideGeneralForumTopicRequest] -> Value #

toEncodingList :: [UnhideGeneralForumTopicRequest] -> Encoding #

omitField :: UnhideGeneralForumTopicRequest -> Bool #

Generic UnhideGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

Associated Types

type Rep UnhideGeneralForumTopicRequest

Instance details

Defined in Telegram.Bot.API.Forum

type Rep UnhideGeneralForumTopicRequest = D1 ('MetaData "UnhideGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'True) (C1 ('MetaCons "UnhideGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "unhideGeneralForumTopicChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId)))

Methods

from :: UnhideGeneralForumTopicRequest -> Rep UnhideGeneralForumTopicRequest x #

to :: Rep UnhideGeneralForumTopicRequest x -> UnhideGeneralForumTopicRequest #

type Rep UnhideGeneralForumTopicRequest Source #

Instance details

Defined in Telegram.Bot.API.Forum

type Rep UnhideGeneralForumTopicRequest = D1 ('MetaData "UnhideGeneralForumTopicRequest" "Telegram.Bot.API.Forum" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" 'True) (C1 ('MetaCons "UnhideGeneralForumTopicRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "unhideGeneralForumTopicChatId") '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.

defUnhideGeneralForumTopic :: SomeChatId -> UnhideGeneralForumTopicRequest Source #

defHideGeneralForumTopic :: SomeChatId -> HideGeneralForumTopicRequest Source #

defReopenGeneralForumTopic :: SomeChatId -> ReopenGeneralForumTopicRequest Source #

defCloseGeneralForumTopic :: SomeChatId -> CloseGeneralForumTopicRequest Source #

defEditGeneralForumTopic :: SomeChatId -> Text -> EditGeneralForumTopicRequest Source #

defUnpinAllForumTopicMessages :: SomeChatId -> MessageThreadId -> UnpinAllForumTopicMessagesRequest Source #

defDeleteForumTopic :: SomeChatId -> MessageThreadId -> DeleteForumTopicRequest Source #

defReopenForumTopic :: SomeChatId -> MessageThreadId -> ReopenForumTopicRequest Source #

defCloseForumTopic :: SomeChatId -> MessageThreadId -> CloseForumTopicRequest Source #

defEditForumTopic :: SomeChatId -> MessageThreadId -> EditForumTopicRequest Source #

defCreateForumTopic :: SomeChatId -> Text -> CreateForumTopicRequest Source #