Safe Haskell	Safe-Inferred
Language	Haskell2010

Telegram.Bot.API.Methods.PinChatMessage

Contents

pinChatMessage

Synopsis

data PinChatMessageRequest = PinChatMessageRequest {
}
type PinChatMessage = "pinChatMessage" :> (ReqBody '[JSON] PinChatMessageRequest :> Post '[JSON] (Response Bool))
pinChatMessage :: PinChatMessageRequest -> ClientM (Response Bool)
defPinChatMessage :: SomeChatId -> MessageId -> PinChatMessageRequest

`pinChatMessage`

data PinChatMessageRequest Source #

Request parameters for pinChatMessage.

Constructors

PinChatMessageRequest

Fields

pinChatMessageChatId :: SomeChatId
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
pinChatMessageMessageId :: MessageId
Identifier of a message to pin
pinChatMessageDisableNotification :: Maybe Bool
Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.

Instances

Instances details

FromJSON PinChatMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.PinChatMessage Methods parseJSON :: Value -> Parser PinChatMessageRequest # parseJSONList :: Value -> Parser [PinChatMessageRequest] # omittedField :: Maybe PinChatMessageRequest #
ToJSON PinChatMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.PinChatMessage Methods toJSON :: PinChatMessageRequest -> Value # toEncoding :: PinChatMessageRequest -> Encoding # toJSONList :: [PinChatMessageRequest] -> Value # toEncodingList :: [PinChatMessageRequest] -> Encoding # omitField :: PinChatMessageRequest -> Bool #
Generic PinChatMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.PinChatMessage Associated Types type Rep PinChatMessageRequest :: Type -> Type # Methods from :: PinChatMessageRequest -> Rep PinChatMessageRequest x # to :: Rep PinChatMessageRequest x -> PinChatMessageRequest #
type Rep PinChatMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods.PinChatMessage type Rep PinChatMessageRequest = D1 ('MetaData "PinChatMessageRequest" "Telegram.Bot.API.Methods.PinChatMessage" "telegram-bot-api-7.0-2XShkJeCLX71W7OKNKemWZ" 'False) (C1 ('MetaCons "PinChatMessageRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "pinChatMessageChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :: (S1 ('MetaSel ('Just "pinChatMessageMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageId) :: S1 ('MetaSel ('Just "pinChatMessageDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

type PinChatMessage = "pinChatMessage" :> (ReqBody '[JSON] PinChatMessageRequest :> Post '[JSON] (Response Bool)) Source #

pinChatMessage :: PinChatMessageRequest -> ClientM (Response Bool) Source #

Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in a supergroup or can_edit_messages administrator right in a channel. Returns True on success.

defPinChatMessage :: SomeChatId -> MessageId -> PinChatMessageRequest Source #