python-telegram-bot/telegram/inline/inlinequeryresultlocation.py

89 lines
3.8 KiB
Python
Raw Normal View History

2016-04-12 06:12:35 +02:00
#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
2020-02-02 22:08:54 +01:00
# Copyright (C) 2015-2020
2016-04-12 06:12:35 +02:00
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser Public License for more details.
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
2017-09-01 08:43:08 +02:00
"""This module contains the classes that represent Telegram InlineQueryResultLocation."""
from telegram import InlineQueryResult
class InlineQueryResultLocation(InlineQueryResult):
"""
Represents a location on a map. By default, the location will be sent by the user.
Alternatively, you can use :attr:`input_message_content` to send a message with the specified
content instead of the location.
2016-10-17 22:44:40 +02:00
Attributes:
type (:obj:`str`): 'location'.
id (:obj:`str`): Unique identifier for this result, 1-64 bytes.
latitude (:obj:`float`): Location latitude in degrees.
longitude (:obj:`float`): Location longitude in degrees.
title (:obj:`str`): Location title.
2017-10-14 20:03:02 +02:00
live_period (:obj:`int`): Optional. Period in seconds for which the location can be
updated, should be between 60 and 86400.
reply_markup (:class:`telegram.InlineKeyboardMarkup`): Optional. Inline keyboard attached
2016-10-17 22:44:40 +02:00
to the message.
input_message_content (:class:`telegram.InputMessageContent`): Optional. Content of the
2016-10-17 22:44:40 +02:00
message to be sent instead of the location.
thumb_url (:obj:`str`): Optional. Url of the thumbnail for the result.
thumb_width (:obj:`int`): Optional. Thumbnail width.
thumb_height (:obj:`int`): Optional. Thumbnail height.
2016-10-17 22:44:40 +02:00
Args:
id (:obj:`str`): Unique identifier for this result, 1-64 bytes.
latitude (:obj:`float`): Location latitude in degrees.
longitude (:obj:`float`): Location longitude in degrees.
title (:obj:`str`): Location title.
2017-10-14 20:03:02 +02:00
live_period (:obj:`int`, optional): Period in seconds for which the location can be
updated, should be between 60 and 86400.
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): Inline keyboard attached
2016-10-17 22:44:40 +02:00
to the message.
input_message_content (:class:`telegram.InputMessageContent`, optional): Content of the
2016-10-17 22:44:40 +02:00
message to be sent instead of the location.
thumb_url (:obj:`str`, optional): Url of the thumbnail for the result.
thumb_width (:obj:`int`, optional): Thumbnail width.
thumb_height (:obj:`int`, optional): Thumbnail height.
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
2016-10-17 22:44:40 +02:00
"""
2016-05-15 03:46:40 +02:00
2016-04-16 17:49:07 +02:00
def __init__(self,
id,
latitude,
longitude,
title,
2017-10-14 20:03:02 +02:00
live_period=None,
2016-04-16 17:49:07 +02:00
reply_markup=None,
input_message_content=None,
thumb_url=None,
thumb_width=None,
thumb_height=None,
**kwargs):
2016-04-16 17:49:07 +02:00
# Required
super().__init__('location', id)
2016-04-16 17:49:07 +02:00
self.latitude = latitude
self.longitude = longitude
self.title = title
# Optionals
self.live_period = live_period
self.reply_markup = reply_markup
self.input_message_content = input_message_content
self.thumb_url = thumb_url
self.thumb_width = thumb_width
self.thumb_height = thumb_height