Telegram.Bot.API.Methods.SetMyCommands

setMyCommands

data SetMyCommandsRequest

Request parameters for setMyCommands.

Constructors

SetMyCommandsRequest

Fields

• setMyCommandsCommands :: [BotCommand]

  A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.

• setMyCommandsScope :: Maybe BotCommandScope

  A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.

• setMyCommandsLanguageCode :: Maybe Text

  A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands

Instances

FromJSON SetMyCommandsRequest

Defined in Telegram.Bot.API.Methods.SetMyCommands

Methods

parseJSON :: Value -> Parser SetMyCommandsRequest

parseJSONList :: Value -> Parser [SetMyCommandsRequest]

omittedField :: Maybe SetMyCommandsRequest

ToJSON SetMyCommandsRequest

Defined in Telegram.Bot.API.Methods.SetMyCommands

Methods

toJSON :: SetMyCommandsRequest -> Value

toEncoding :: SetMyCommandsRequest -> Encoding

toJSONList :: [SetMyCommandsRequest] -> Value

toEncodingList :: [SetMyCommandsRequest] -> Encoding

omitField :: SetMyCommandsRequest -> Bool

Generic SetMyCommandsRequest

Defined in Telegram.Bot.API.Methods.SetMyCommands

Associated Types

type Rep SetMyCommandsRequest :: Type -> Type

Methods

from :: SetMyCommandsRequest -> Rep SetMyCommandsRequest x

to :: Rep SetMyCommandsRequest x -> SetMyCommandsRequest

type Rep SetMyCommandsRequest

Defined in Telegram.Bot.API.Methods.SetMyCommands

type Rep SetMyCommandsRequest = D1 ('MetaData "SetMyCommandsRequest" "Telegram.Bot.API.Methods.SetMyCommands" "telegram-bot-api-7.4.4-fdOK3VCUfTCfzXncfzYz7" 'False) (C1 ('MetaCons "SetMyCommandsRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "setMyCommandsCommands") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [BotCommand]) :*: (S1 ('MetaSel ('Just "setMyCommandsScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BotCommandScope)) :*: S1 ('MetaSel ('Just "setMyCommandsLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

type SetMyCommands = "setMyCommands" :> (ReqBody '[JSON] SetMyCommandsRequest :> Post '[JSON] (Response Bool))

setMyCommands :: SetMyCommandsRequest -> ClientM (Response Bool)

Use this method to change the list of the bot's commands. See https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success.

defSetMyCommands :: [BotCommand] -> SetMyCommandsRequest