Telegram.Bot.API.Methods.SendLocation

sendLocation

data SendLocationRequest

Request parameters for sendLocation.

Constructors

SendLocationRequest

Fields

• sendLocationChatId :: SomeChatId

  Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• sendLocationMessageThreadId :: Maybe MessageThreadId

  Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

• sendLocationLatitude :: Float

  Latitude of new location

• sendLocationLongitude :: Float

  Longitude of new location

• sendLocationHorizontalAccuracy :: Maybe Float

  The radius of uncertainty for the location, measured in meters; 0-1500

• sendLocationLivePeriod :: Int

  Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.)

• sendLocationHeading :: Maybe Int

  Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.

• sendLocationProximityAlertRadius :: Maybe Int

  Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.

• sendLocationDisableNotification :: Maybe Bool

  Sends the message silently. Users will receive a notification with no sound.

• sendLocationProtectContent :: Maybe Bool

  Protects the contents of the sent message from forwarding and saving

• sendLocationReplyToMessageId :: Maybe MessageId

  If the message is a reply, ID of the original message

• sendLocationAllowSendingWithoutReply :: Maybe Bool

  Pass True, if the message should be sent even if the specified replied-to message is not found

• sendLocationReplyMarkup :: Maybe InlineKeyboardMarkup

  Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Instances

FromJSON SendLocationRequest

Defined in Telegram.Bot.API.Methods.SendLocation

Methods

parseJSON :: Value -> Parser SendLocationRequest

parseJSONList :: Value -> Parser [SendLocationRequest]

ToJSON SendLocationRequest

Defined in Telegram.Bot.API.Methods.SendLocation

Methods

toJSON :: SendLocationRequest -> Value

toEncoding :: SendLocationRequest -> Encoding

toJSONList :: [SendLocationRequest] -> Value

toEncodingList :: [SendLocationRequest] -> Encoding

Generic SendLocationRequest

Defined in Telegram.Bot.API.Methods.SendLocation

Associated Types

type Rep SendLocationRequest :: Type -> Type

Methods

from :: SendLocationRequest -> Rep SendLocationRequest x

to :: Rep SendLocationRequest x -> SendLocationRequest

type Rep SendLocationRequest

Defined in Telegram.Bot.API.Methods.SendLocation

type Rep SendLocationRequest = D1 ('MetaData "SendLocationRequest" "Telegram.Bot.API.Methods.SendLocation" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "SendLocationRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendLocationChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: (S1 ('MetaSel ('Just "sendLocationMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId)) :*: S1 ('MetaSel ('Just "sendLocationLatitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float))) :*: (S1 ('MetaSel ('Just "sendLocationLongitude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float) :*: (S1 ('MetaSel ('Just "sendLocationHorizontalAccuracy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Float)) :*: S1 ('MetaSel ('Just "sendLocationLivePeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))) :*: ((S1 ('MetaSel ('Just "sendLocationHeading") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "sendLocationProximityAlertRadius") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "sendLocationDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "sendLocationProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendLocationReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :*: (S1 ('MetaSel ('Just "sendLocationAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendLocationReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

type SendLocation = "sendLocation" :> (ReqBody '[JSON] SendLocationRequest :> Post '[JSON] (Response Message))

sendLocation :: SendLocationRequest -> ClientM (Response Message)

Use this method to send point on the map. On success, the sent Message is returned.