Updating messages

stopMessageLiveLocation()

Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

parameters

parametertyperequireddescription
business_connection_idstringoptionalUnique identifier of the business connection on behalf of which the message to be edited was sent
chat_idnumber | stringoptionalRequired if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
message_idnumberoptionalRequired if inline_message_id is not specified. Identifier of the message with live location to stop.
inline_message_idstringoptionalRequired if chat_id and message_id are not specified. Identifier of the inline message.
reply_markupInlineKeyboardMarkupoptionalA JSON-serialized object for a new inline keyboard

returns

Message | boolean

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts
import type { Message, StopMessageLiveLocationParams } from "@yaebal/types";

await bot.api.call<Message | boolean>("stopMessageLiveLocation", {} satisfies StopMessageLiveLocationParams);

context shortcut

also available as ctx.stopMessageLiveLocation() on 16 context types — see @yaebal/contexts.

context shortcut
/** Use this method to stop updating a live location message before *live\_period* expires. On success, if the message is not an inline message, the edited [Message](https://core.telegram.org/bots/api/#message) is returned, otherwise *True* is returned. */
ctx.stopMessageLiveLocation(params: Omit<StopMessageLiveLocationParams, "chat_id" | "message_id">)