Ability to send messages w/o notifying the user

Implemented in:
- send
- send_photo
- send_audio
- send_voice
- send_video
- send_file
- send_location
- send_sticker
- forward_to

Closes: #30

Author: thesharp

botogram/objects/mixins.py

@@ -23,7 +23,7 @@ def __(self, *args, **kwargs):
 class ChatMixin:
     """Add some methods for chats"""
 
-    def _get_call_args(self, reply_to, extra):
+    def _get_call_args(self, reply_to, extra, notify=True):
         """Get default API call arguments"""
         # Convert instance of Message to ids in reply_to
         if hasattr(reply_to, "message_id"):
@@ -41,14 +41,16 @@ def _get_call_args(self, reply_to, extra):
             args["reply_to_message_id"] = reply_to
         if extra is not None:
             args["reply_markup"] = extra.serialize()
+        if not notify:
+            args["disable_notification"] = True
 
         return args
 
     @_require_api
     def send(self, message, preview=True, reply_to=None, syntax=None,
-             extra=None):
+             extra=None, notify=True):
         """Send a message"""
-        args = self._get_call_args(reply_to, extra)
+        args = self._get_call_args(reply_to, extra, notify)
         args["text"] = message
         args["disable_web_page_preview"] = not preview
 
@@ -59,9 +61,10 @@ def send(self, message, preview=True, reply_to=None, syntax=None,
         self._api.call("sendMessage", args)
 
     @_require_api
-    def send_photo(self, path, caption=None, reply_to=None, extra=None):
+    def send_photo(self, path, caption=None, reply_to=None, extra=None,
+                   notify=True):
         """Send a photo"""
-        args = self._get_call_args(reply_to, extra)
+        args = self._get_call_args(reply_to, extra, notify)
         if caption is not None:
             args["caption"] = caption
 
@@ -70,9 +73,9 @@ def send_photo(self, path, caption=None, reply_to=None, extra=None):
 
     @_require_api
     def send_audio(self, path, duration=None, performer=None, title=None,
-                   reply_to=None, extra=None):
+                   reply_to=None, extra=None, notify=True):
         """Send an audio track"""
-        args = self._get_call_args(reply_to, extra)
+        args = self._get_call_args(reply_to, extra, notify)
         if duration is not None:
             args["duration"] = duration
         if performer is not None:
@@ -85,9 +88,9 @@ def send_audio(self, path, duration=None, performer=None, title=None,
 
     @_require_api
     def send_voice(self, path, duration=None, title=None, reply_to=None,
-                   extra=None):
+                   extra=None, notify=True):
         """Send a voice message"""
-        args = self._get_call_args(reply_to, extra)
+        args = self._get_call_args(reply_to, extra, notify)
         if duration is not None:
             args["duration"] = duration
 
@@ -96,9 +99,9 @@ def send_voice(self, path, duration=None, title=None, reply_to=None,
 
     @_require_api
     def send_video(self, path, duration=None, caption=None, reply_to=None,
-                   extra=None):
+                   extra=None, notify=True):
         """Send a video"""
-        args = self._get_call_args(reply_to, extra)
+        args = self._get_call_args(reply_to, extra, notify)
         if duration is not None:
             args["duration"] = duration
         if caption is not None:
@@ -108,26 +111,27 @@ def send_video(self, path, duration=None, caption=None, reply_to=None,
         self._api.call("sendVideo", args, files)
 
     @_require_api
-    def send_file(self, path, reply_to=None, extra=None):
+    def send_file(self, path, reply_to=None, extra=None, notify=True):
         """Send a generic file"""
-        args = self._get_call_args(reply_to, extra)
+        args = self._get_call_args(reply_to, extra, notify)
 
         files = {"document": open(path, "rb")}
         self._api.call("sendDocument", args, files)
 
     @_require_api
-    def send_location(self, latitude, longitude, reply_to=None, extra=None):
+    def send_location(self, latitude, longitude, reply_to=None, extra=None,
+                      notify=True):
         """Send a geographic location"""
-        args = self._get_call_args(reply_to, extra)
+        args = self._get_call_args(reply_to, extra, notify)
         args["latitude"] = latitude
         args["longitude"] = longitude
 
         self._api.call("sendLocation", args)
 
     @_require_api
-    def send_sticker(self, sticker, reply_to=None, extra=None):
+    def send_sticker(self, sticker, reply_to=None, extra=None, notify=True):
         """Send a sticker"""
-        args = self._get_call_args(reply_to, extra)
+        args = self._get_call_args(reply_to, extra, notify)
 
         files = {"sticker": open(sticker, "rb")}
         self._api.call("sendSticker", args, files)
@@ -137,16 +141,19 @@ class MessageMixin:
     """Add some methods for messages"""
 
     @_require_api
-    def forward_to(self, to):
+    def forward_to(self, to, notify=True):
         """Forward the message to another user"""
         if hasattr(to, "id"):
             to = to.id
 
-        self._api.call("forwardMessage", {
-            "chat_id": to,
-            "from_chat_id": self.chat.id,
-            "message_id": self.message_id,
-        })
+        args = dict()
+        args["chat_id"] = to
+        args["from_chat_id"] = self.chat.id
+        args["message_id"] = self.message_id
+        if not notify:
+            args["disable_notification"] = True
+
+        self._api.call("forwardMessage", args)
 
     @_require_api
     def reply(self, *args, **kwargs):

docs/api/bot.rst

@@ -286,7 +286,7 @@ components.
 
       :return: A frozen instance of the current bot.
 
-   .. py:method:: send(chat, message[, preview=True, reply_to=None, syntax=None, extra=None])
+   .. py:method:: send(chat, message[, preview=True, reply_to=None, syntax=None, extra=None, notify=True])
 
       This method sends a message to a specific chat. The chat must be
       identified by its ID, and Telegram applies some restrictions on the chats
@@ -306,14 +306,18 @@ components.
       processed by Telegram (:ref:`learn more about rich formatting
       <tricks-messages-syntax>`).
 
+      The *notify* parameter is for defining if your message should trigger
+      a notification on the client side (yes by default).
+
       :param int chat: The ID of the chat which should receive the message.
       :param str messgae: The message you want to send.
       :param bool preview: If you want to show the link preview.
       :param int reply_to: The ID of the message this one is replying to.
       :param string syntax: The name of the syntax you used for the message.
       :param object extra: An extra object you want to attach (see above).
+      :param bool notify: If you want to trigger the client notification.
 
-   .. py:method:: send_photo(chat, path[, caption="", reply_to=None, extra=None])
+   .. py:method:: send_photo(chat, path[, caption="", reply_to=None, extra=None, notify=True])
 
       This method sends a photo to a specific chat. The chat must be identified
       by its ID, and Telegram applies some restrictions on the chats allowed to
@@ -328,13 +332,17 @@ components.
       * :py:class:`botogram.ReplyKeyboardHide`
       * :py:class:`botogram.ForceReply`
 
+      The *notify* parameter is for defining if your message should trigger
+      a notification on the client side (yes by default).
+
       :param int chat: The ID of the chat which should receive the photo.
       :param str path: The path to the photo you want to send.
       :param str caption: An optional caption for the photo.
       :param int reply_to: The ID of the message this one is replying to.
       :param object extra: An extra object you want to attach (see above).
+      :param bool notify: If you want to trigger the client notification.
 
-   .. py:method:: send_audio(chat, path, [duration=None, performer=None, title=None, reply_to=None, extra=None])
+   .. py:method:: send_audio(chat, path, [duration=None, performer=None, title=None, reply_to=None, extra=None, notify=True])
 
       This method sends an audio track to a specific chat. The chat must be
       identified by its ID, and Telegram applies some restrictions on the chats
@@ -352,15 +360,19 @@ components.
       * :py:class:`botogram.ReplyKeyboardHide`
       * :py:class:`botogram.ForceReply`
 
+      The *notify* parameter is for defining if your message should trigger
+      a notification on the client side (yes by default).
+
       :param int chat: The ID of the chat which should receive the photo.
       :param str path: The path to the audio track
       :param int duration: The track duration, in seconds
       :param str performer: The name of the performer
       :param str title: The title of the track
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object extra: An extra reply interface object to attach
+      :param bool notify: If you want to trigger the client notification.
 
-   .. py:method:: send_voice(chat, path, [duration=None, reply_to=None, extra=None])
+   .. py:method:: send_voice(chat, path, [duration=None, reply_to=None, extra=None, notify=True])
 
       This method sends a voice message to a specific chat. The chat must be
       identified by its ID, and Telegram applies some restrictions on the chats
@@ -378,13 +390,17 @@ components.
       * :py:class:`botogram.ReplyKeyboardHide`
       * :py:class:`botogram.ForceReply`
 
+      The *notify* parameter is for defining if your message should trigger
+      a notification on the client side (yes by default).
+
       :param int chat: The ID of the chat which should receive the photo.
       :param str path: The path to the voice message
       :param int duration: The message duration, in seconds
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object extra: An extra reply interface object to attach
+      :param bool notify: If you want to trigger the client notification.
 
-   .. py:method:: send_video(chat, path, [duration=None, caption=None, reply_to=None, extra=None])
+   .. py:method:: send_video(chat, path, [duration=None, caption=None, reply_to=None, extra=None, notify=True])
 
       This method sends a video to a specific chat. The chat must be identified
       by its ID, and Telegram applies some restrictions on the chats allowed to
@@ -402,14 +418,18 @@ components.
       * :py:class:`botogram.ReplyKeyboardHide`
       * :py:class:`botogram.ForceReply`
 
+      The *notify* parameter is for defining if your message should trigger
+      a notification on the client side (yes by default).
+
       :param int chat: The ID of the chat which should receive the video
       :param str path: The path to the video
       :param int duration: The video duration, in seconds
       :param str caption The caption of the video
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object extra: An extra reply interface object to attach
+      :param bool notify: If you want to trigger the client notification.
 
-   .. py:method:: send_file(chat, path, [reply_to=None, extra=None])
+   .. py:method:: send_file(chat, path, [reply_to=None, extra=None, notify=True])
 
       This method sends a generic file to a specific chat. The chat must be
       identified by its ID, and Telegram applies some restrictions on the chats
@@ -426,12 +446,16 @@ components.
       * :py:class:`botogram.ReplyKeyboardHide`
       * :py:class:`botogram.ForceReply`
 
+      The *notify* parameter is for defining if your message should trigger
+      a notification on the client side (yes by default).
+
       :param int chat: The ID of the chat which should receive the file
       :param str path: The path to the file
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object extra: An extra reply interface object to attach
+      :param bool notify: If you want to trigger the client notification.
 
-   .. py:method:: send_location(chat, latitude, longitude, [reply_to=None, extra=None])
+   .. py:method:: send_location(chat, latitude, longitude, [reply_to=None, extra=None, notify=True])
 
       This method sends a geographic location to a specific chat. The chat must
       be identified by its ID, and Telegram applies some restrictions on the
@@ -448,13 +472,17 @@ components.
       * :py:class:`botogram.ReplyKeyboardHide`
       * :py:class:`botogram.ForceReply`
 
+      The *notify* parameter is for defining if your message should trigger
+      a notification on the client side (yes by default).
+
       :param int chat: The ID of the chat which should receive the location
       :param float latitude: The latitude of the location
       :param float longitude: The longitude of the location
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object extra: An extra reply interface object to attach
+      :param bool notify: If you want to trigger the client notification.
 
-   .. py:method:: send_sticker(sticker, [reply_to=None, extra=None])
+   .. py:method:: send_sticker(sticker, [reply_to=None, extra=None, notify=True])
 
       This method sends a sticker to a specific chat chat (in webp format). The
       chat must be identified by its ID, and Telegram applies some restrictions
@@ -471,7 +499,11 @@ components.
       * :py:class:`botogram.ReplyKeyboardHide`
       * :py:class:`botogram.ForceReply`
 
+      The *notify* parameter is for defining if your message should trigger
+      a notification on the client side (yes by default).
+
       :param int chat: The ID of the chat which should receive the location
       :param str sticker: The path to the webp-formatted sticker
       :param int reply_to: The ID of the :py:class:`~botogram.Message` this one is replying to
       :param object extra: An extra reply interface object to attach
+      :param bool notify: If you want to trigger the client notification.