Telegram.Bot.API.GettingUpdates

Update

newtype UpdateId

Constructors

UpdateId Int

Instances

FromJSON UpdateId

Defined in Telegram.Bot.API.GettingUpdates

Methods

parseJSON :: Value -> Parser UpdateId

parseJSONList :: Value -> Parser [UpdateId]

omittedField :: Maybe UpdateId

ToJSON UpdateId

Defined in Telegram.Bot.API.GettingUpdates

Methods

toJSON :: UpdateId -> Value

toEncoding :: UpdateId -> Encoding

toJSONList :: [UpdateId] -> Value

toEncodingList :: [UpdateId] -> Encoding

omitField :: UpdateId -> Bool

Show UpdateId

Defined in Telegram.Bot.API.GettingUpdates

Methods

showsPrec :: Int -> UpdateId -> ShowS

show :: UpdateId -> String

showList :: [UpdateId] -> ShowS

Eq UpdateId

Defined in Telegram.Bot.API.GettingUpdates

Methods

(==) :: UpdateId -> UpdateId -> Bool

(/=) :: UpdateId -> UpdateId -> Bool

Ord UpdateId

Defined in Telegram.Bot.API.GettingUpdates

Methods

compare :: UpdateId -> UpdateId -> Ordering

(<) :: UpdateId -> UpdateId -> Bool

(<=) :: UpdateId -> UpdateId -> Bool

(>) :: UpdateId -> UpdateId -> Bool

(>=) :: UpdateId -> UpdateId -> Bool

max :: UpdateId -> UpdateId -> UpdateId

min :: UpdateId -> UpdateId -> UpdateId

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.

• updateBusinessConnection :: Maybe BusinessConnection

  The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot.

• updateBusinessMessage :: Maybe Message

  New message from a connected business account.

• updateEditedBusinessMessage :: Maybe Message

  New version of a message from a connected business account.

• updateDeletedBusinessMessages :: Maybe BusinessMessagesDeleted

  Messages were deleted from a connected business account.

• updateMessageReaction :: Maybe MessageReactionUpdated

  A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify message_reaction in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots.

• updateMessageReactionCount :: Maybe MessageReactionCountUpdated

  Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify message_reaction_count in the list of allowed_updates to receive these updates. The updates are grouped and can be sent with delay up to a few minutes.

• updateInlineQuery :: Maybe InlineQuery

  New incoming inline query.

• updateChosenInlineResult :: Maybe ChosenInlineResult

  The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.

• updateCallbackQuery :: Maybe CallbackQuery

  New incoming callback query.

• updateShippingQuery :: Maybe ShippingQuery

  New incoming shipping query. Only for invoices with flexible price

• updatePreCheckoutQuery :: Maybe PreCheckoutQuery

  New incoming pre-checkout query. Contains full information about checkout

• updatePoll :: Maybe Poll

  New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot.

• updatePollAnswer :: Maybe PollAnswer

  A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.

• updateMyChatMember :: Maybe ChatMemberUpdated

  The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.

• updateChatMember :: Maybe ChatMemberUpdated

  A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates.

• updateChatJoinRequest :: Maybe ChatJoinRequest

  A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.

• updateChatBoost :: Maybe ChatBoostUpdated

  A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.

• updateRemovedChatBoost :: Maybe ChatBoostRemoved

  A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.

Instances

FromJSON Update

Defined in Telegram.Bot.API.GettingUpdates

Methods

parseJSON :: Value -> Parser Update

parseJSONList :: Value -> Parser [Update]

omittedField :: Maybe Update

ToJSON Update

Defined in Telegram.Bot.API.GettingUpdates

Methods

toJSON :: Update -> Value

toEncoding :: Update -> Encoding

toJSONList :: [Update] -> Value

toEncodingList :: [Update] -> Encoding

omitField :: Update -> Bool

Generic Update

Defined in Telegram.Bot.API.GettingUpdates

Associated Types

type Rep Update :: Type -> Type

Methods

from :: Update -> Rep Update x

to :: Rep Update x -> Update

Show Update

Defined in Telegram.Bot.API.GettingUpdates

Methods

showsPrec :: Int -> Update -> ShowS

show :: Update -> String

showList :: [Update] -> ShowS

type Rep Update

Defined in Telegram.Bot.API.GettingUpdates

type Rep Update = D1 ('MetaData "Update" "Telegram.Bot.API.GettingUpdates" "telegram-bot-api-7.4.3-38UQu7GyDDHHZ1He0cP5zf" '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 "updateBusinessConnection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BusinessConnection)) :*: (S1 ('MetaSel ('Just "updateBusinessMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Message)) :*: S1 ('MetaSel ('Just "updateEditedBusinessMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Message)))) :*: (S1 ('MetaSel ('Just "updateDeletedBusinessMessages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BusinessMessagesDeleted)) :*: (S1 ('MetaSel ('Just "updateMessageReaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageReactionUpdated)) :*: S1 ('MetaSel ('Just "updateMessageReactionCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageReactionCountUpdated)))))) :*: (((S1 ('MetaSel ('Just "updateInlineQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineQuery)) :*: (S1 ('MetaSel ('Just "updateChosenInlineResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChosenInlineResult)) :*: S1 ('MetaSel ('Just "updateCallbackQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe CallbackQuery)))) :*: (S1 ('MetaSel ('Just "updateShippingQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ShippingQuery)) :*: (S1 ('MetaSel ('Just "updatePreCheckoutQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PreCheckoutQuery)) :*: S1 ('MetaSel ('Just "updatePoll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Poll))))) :*: ((S1 ('MetaSel ('Just "updatePollAnswer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PollAnswer)) :*: (S1 ('MetaSel ('Just "updateMyChatMember") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatMemberUpdated)) :*: S1 ('MetaSel ('Just "updateChatMember") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatMemberUpdated)))) :*: (S1 ('MetaSel ('Just "updateChatJoinRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatJoinRequest)) :*: (S1 ('MetaSel ('Just "updateChatBoost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatBoostUpdated)) :*: S1 ('MetaSel ('Just "updateRemovedChatBoost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatBoostRemoved))))))))

updateChatId :: Update -> Maybe ChatId

extractUpdateMessage :: Update -> Maybe Message

getUpdates

type GetUpdatesAs a = "getUpdates" :> (ReqBody '[JSON] GetUpdatesRequest :> Get '[JSON] (Response [a]))

type GetUpdates = GetUpdatesAs Update

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.

getUpdatesAsValue :: GetUpdatesRequest -> ClientM (Response [Value])

More liberal version of getUpdates funcion.

It's useful when you aren't sure that you can parse all the types of updates, so you would recieve a list of Value with updates, that you can parse later.

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 Int

  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

FromJSON GetUpdatesRequest

Defined in Telegram.Bot.API.GettingUpdates

Methods

parseJSON :: Value -> Parser GetUpdatesRequest

parseJSONList :: Value -> Parser [GetUpdatesRequest]

omittedField :: Maybe GetUpdatesRequest

ToJSON GetUpdatesRequest

Defined in Telegram.Bot.API.GettingUpdates

Methods

toJSON :: GetUpdatesRequest -> Value

toEncoding :: GetUpdatesRequest -> Encoding

toJSONList :: [GetUpdatesRequest] -> Value

toEncodingList :: [GetUpdatesRequest] -> Encoding

omitField :: GetUpdatesRequest -> Bool

Generic GetUpdatesRequest

Defined in Telegram.Bot.API.GettingUpdates

Associated Types

type Rep GetUpdatesRequest :: Type -> Type

Methods

from :: GetUpdatesRequest -> Rep GetUpdatesRequest x

to :: Rep GetUpdatesRequest x -> GetUpdatesRequest

type Rep GetUpdatesRequest

Defined in Telegram.Bot.API.GettingUpdates

type Rep GetUpdatesRequest = D1 ('MetaData "GetUpdatesRequest" "Telegram.Bot.API.GettingUpdates" "telegram-bot-api-7.4.3-38UQu7GyDDHHZ1He0cP5zf" '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 Int))) :*: (S1 ('MetaSel ('Just "getUpdatesTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Seconds)) :*: S1 ('MetaSel ('Just "getUpdatesAllowedUpdates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [UpdateType])))))

data UpdateType

Constructors

UpdateMessage

UpdateEditedMessage

UpdateChannelPost

UpdateEditedChannelPost

UpdateBusinessConnection

UpdateBusinessMessage

UpdateEditedBusinessMessage

UpdateDeletedBusinessMessages

UpdateMessageReaction

UpdateMessageReactionCount

UpdateInlineQuery

UpdateChosenInlineResult

UpdateCallbackQuery

UpdateShippingQuery

UpdatePreCheckoutQuery

UpdatePoll

UpdatePollAnswer

UpdateMyChatMember

UpdateChatMember

UpdateChatJoinRequest

UpdateChatBoost

UpdateRemovedChatBoost

Instances

FromJSON UpdateType

Defined in Telegram.Bot.API.GettingUpdates

Methods

parseJSON :: Value -> Parser UpdateType

parseJSONList :: Value -> Parser [UpdateType]

omittedField :: Maybe UpdateType

ToJSON UpdateType

Defined in Telegram.Bot.API.GettingUpdates

Methods

toJSON :: UpdateType -> Value

toEncoding :: UpdateType -> Encoding

toJSONList :: [UpdateType] -> Value

toEncodingList :: [UpdateType] -> Encoding

omitField :: UpdateType -> Bool

Generic UpdateType

Defined in Telegram.Bot.API.GettingUpdates

Associated Types

type Rep UpdateType :: Type -> Type

Methods

from :: UpdateType -> Rep UpdateType x

to :: Rep UpdateType x -> UpdateType

type Rep UpdateType

Defined in Telegram.Bot.API.GettingUpdates

type Rep UpdateType = D1 ('MetaData "UpdateType" "Telegram.Bot.API.GettingUpdates" "telegram-bot-api-7.4.3-38UQu7GyDDHHZ1He0cP5zf" 'False) ((((C1 ('MetaCons "UpdateMessage" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UpdateEditedMessage" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UpdateChannelPost" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UpdateEditedChannelPost" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UpdateBusinessConnection" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "UpdateBusinessMessage" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UpdateEditedBusinessMessage" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UpdateDeletedBusinessMessages" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "UpdateMessageReaction" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UpdateMessageReactionCount" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UpdateInlineQuery" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "UpdateChosenInlineResult" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UpdateCallbackQuery" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UpdateShippingQuery" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UpdatePreCheckoutQuery" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UpdatePoll" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "UpdatePollAnswer" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UpdateMyChatMember" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UpdateChatMember" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "UpdateChatJoinRequest" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "UpdateChatBoost" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UpdateRemovedChatBoost" 'PrefixI 'False) (U1 :: Type -> Type))))))

defGetUpdates :: GetUpdatesRequest