telegram-bot-simple-0.2.0: Easy to use library for building Telegram bots.

Safe HaskellNone
LanguageHaskell2010

Telegram.Bot.API.GettingUpdates

Contents

Synopsis

Update

data Update #

This object represents an incoming update. At most one of the optional parameters can be present in any given update.

Constructors

Update 

Fields

  • updateUpdateId :: UpdateId

    The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.

  • updateMessage :: Maybe Message

    New incoming message of any kind — text, photo, sticker, etc.

  • updateEditedMessage :: Maybe Message

    New version of a message that is known to the bot and was edited

  • updateChannelPost :: Maybe Message

    New incoming channel post of any kind — text, photo, sticker, etc.

  • updateEditedChannelPost :: Maybe Message

    New version of a channel post that is known to the bot and was edited

  • updateCallbackQuery :: Maybe CallbackQuery

    New incoming callback query

Instances
Show Update # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

Generic Update # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

Associated Types

type Rep Update :: * -> * #

Methods

from :: Update -> Rep Update x #

to :: Rep Update x -> Update #

ToJSON Update # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

FromJSON Update # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

type Rep Update # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

type Rep Update = D1 (MetaData "Update" "Telegram.Bot.API.GettingUpdates" "telegram-bot-simple-0.2.0-CzIJRSoNDaaG4f8wjjIbGm" False) (C1 (MetaCons "Update" PrefixI True) ((S1 (MetaSel (Just "updateUpdateId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UpdateId) :*: (S1 (MetaSel (Just "updateMessage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Message)) :*: S1 (MetaSel (Just "updateEditedMessage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Message)))) :*: (S1 (MetaSel (Just "updateChannelPost") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Message)) :*: (S1 (MetaSel (Just "updateEditedChannelPost") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Message)) :*: S1 (MetaSel (Just "updateCallbackQuery") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe CallbackQuery))))))

getUpdates

getUpdates :: GetUpdatesRequest -> ClientM (Response [Update]) #

Use this method to receive incoming updates using long polling. An list of Update objects is returned.

NOTE: This method will not work if an outgoing webhook is set up.

NOTE: In order to avoid getting duplicate updates, recalculate offset after each server response.

data GetUpdatesRequest #

Request parameters for getUpdates.

Constructors

GetUpdatesRequest 

Fields

  • getUpdatesOffset :: Maybe UpdateId

    Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.

  • getUpdatesLimit :: Maybe Int32

    Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100.

  • getUpdatesTimeout :: Maybe Seconds

    Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.

  • getUpdatesAllowedUpdates :: Maybe [UpdateType]

    List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See GetUpdates for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.

Instances
Generic GetUpdatesRequest # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

Associated Types

type Rep GetUpdatesRequest :: * -> * #

ToJSON GetUpdatesRequest # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

FromJSON GetUpdatesRequest # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

type Rep GetUpdatesRequest # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

type Rep GetUpdatesRequest = D1 (MetaData "GetUpdatesRequest" "Telegram.Bot.API.GettingUpdates" "telegram-bot-simple-0.2.0-CzIJRSoNDaaG4f8wjjIbGm" False) (C1 (MetaCons "GetUpdatesRequest" PrefixI True) ((S1 (MetaSel (Just "getUpdatesOffset") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UpdateId)) :*: S1 (MetaSel (Just "getUpdatesLimit") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int32))) :*: (S1 (MetaSel (Just "getUpdatesTimeout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Seconds)) :*: S1 (MetaSel (Just "getUpdatesAllowedUpdates") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [UpdateType])))))

data UpdateType #

Instances
Generic UpdateType # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

Associated Types

type Rep UpdateType :: * -> * #

ToJSON UpdateType # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

FromJSON UpdateType # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

type Rep UpdateType # 
Instance details

Defined in Telegram.Bot.API.GettingUpdates

type Rep UpdateType = D1 (MetaData "UpdateType" "Telegram.Bot.API.GettingUpdates" "telegram-bot-simple-0.2.0-CzIJRSoNDaaG4f8wjjIbGm" False) (((C1 (MetaCons "UpdateMessage" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "UpdateEditedMessage" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "UpdateChannelPost" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "UpdateEditedChannelPost" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "UpdateInlineQuery" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "UpdateChosenInlineResult" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "UpdateCallbackQuery" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "UpdateShippingQuery" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "UpdatePreCheckoutQuery" PrefixI False) (U1 :: * -> *)))))