android-notify 1.41__tar.gz → 1.50.1__tar.gz

{android_notify-1.41 → android_notify-1.50.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: android-notify
-Version: 1.41
+Version: 1.50.1
 Summary: A Python package that simpilfies creating Android notifications in Kivy apps.
 Home-page: https://github.com/fector101/android-notify
 Author: Fabian
@@ -47,6 +47,7 @@ Dynamic: summary
 
 - Also Compatible with Android 8.0+.
 - Supports including images in notifications.
+- All Notifications can take Functions (version 1.50+) [functions docs](#functions).
 - Support for multiple notification styles:
   - [Simple](#basic-usage)
   - [Progress](#progress-bar-notification)
@@ -278,6 +279,60 @@ notification = Notification(title="Silent Update")
 notification.send(silent=True)
 ```
 
+## Functions
+
+### NotificationHandler - To Attach Listener
+
+Add this to your main.py App Class so it runs Once, In later Versions It'll be Attached Automatical
+
+```python
+from kivymd.app import MDApp
+from android_notify import Notification, NotificationHandler
+
+class Myapp(MDApp):
+
+    def on_start(self):
+        # Is called Once when app is Starts up
+        NotificationHandler.bindNotifyListener() # if successfull returns True
+        Notification(title="Hello", message="This is a basic notification.",callback=self.doSomething).send()
+
+    def doSomething(self):
+        print("print in Debug Console")
+```
+
+### Get Which Notification was used to Open App - identifer (str)
+
+If you just want to get the Exact Notification Clicked to Open App, you can use NotificationHandler to get unique identifer
+
+```python
+from kivymd.app import MDApp
+from android_notify import Notification, NotificationHandler
+
+class Myapp(MDApp):
+    
+    def on_start(self):
+        
+        notify = Notification(title="Change Page", message="Click to change App page.", identifer='change_app_page')
+        notify.send()
+
+        notify1 = Notification(title="Change Colour", message="Click to change App Colour", identifer='change_app_color')
+        notify1.send()
+
+        NotificationHandler.bindNotifyListener()
+        
+    def on_resume(self):
+        # Is called everytime app is reopened
+        notify_identifer = NotificationHandler.getIdentifer()
+        if notify_identifer == 'change_app_page':
+            # Code to change Screen
+            pass
+        elif notify_identifer == 'change_app_color':
+            # Code to change Screen Color
+            pass
+```
+
+
+
 ### Assist
 
 - How to Copy image to app folder

{android_notify-1.41 → android_notify-1.50.1}/README.md

@@ -11,6 +11,7 @@
 
 - Also Compatible with Android 8.0+.
 - Supports including images in notifications.
+- All Notifications can take Functions (version 1.50+) [functions docs](#functions).
 - Support for multiple notification styles:
   - [Simple](#basic-usage)
   - [Progress](#progress-bar-notification)
@@ -242,6 +243,60 @@ notification = Notification(title="Silent Update")
 notification.send(silent=True)
 ```
 
+## Functions
+
+### NotificationHandler - To Attach Listener
+
+Add this to your main.py App Class so it runs Once, In later Versions It'll be Attached Automatical
+
+```python
+from kivymd.app import MDApp
+from android_notify import Notification, NotificationHandler
+
+class Myapp(MDApp):
+
+    def on_start(self):
+        # Is called Once when app is Starts up
+        NotificationHandler.bindNotifyListener() # if successfull returns True
+        Notification(title="Hello", message="This is a basic notification.",callback=self.doSomething).send()
+
+    def doSomething(self):
+        print("print in Debug Console")
+```
+
+### Get Which Notification was used to Open App - identifer (str)
+
+If you just want to get the Exact Notification Clicked to Open App, you can use NotificationHandler to get unique identifer
+
+```python
+from kivymd.app import MDApp
+from android_notify import Notification, NotificationHandler
+
+class Myapp(MDApp):
+    
+    def on_start(self):
+        
+        notify = Notification(title="Change Page", message="Click to change App page.", identifer='change_app_page')
+        notify.send()
+
+        notify1 = Notification(title="Change Colour", message="Click to change App Colour", identifer='change_app_color')
+        notify1.send()
+
+        NotificationHandler.bindNotifyListener()
+        
+    def on_resume(self):
+        # Is called everytime app is reopened
+        notify_identifer = NotificationHandler.getIdentifer()
+        if notify_identifer == 'change_app_page':
+            # Code to change Screen
+            pass
+        elif notify_identifer == 'change_app_color':
+            # Code to change Screen Color
+            pass
+```
+
+
+
 ### Assist
 
 - How to Copy image to app folder

android_notify-1.50.1/android_notify/__init__.py

@@ -0,0 +1,4 @@
+""""For Easier Imports For Public Classes"""
+from .core import send_notification
+from .styles import NotificationStyles
+from .sword import Notification,NotificationHandler

{android_notify-1.41 → android_notify-1.50.1}/android_notify/sword.py

@@ -1,6 +1,6 @@
 """This Module Contain Class for creating Notification With Java"""
 import difflib
-import random
+import traceback
 import os
 import re
 
@@ -9,7 +9,11 @@ ON_ANDROID = False
 
 try:
     from jnius import autoclass,cast  # Needs Java to be installed pylint: disable=W0611, C0114
+    from android import activity # pylint: disable=import-error
+    from android.config import ACTIVITY_CLASS_NAME # pylint: disable=import-error
+
     # Get the required Java classes
+    Bundle = autoclass('android.os.Bundle')
     PythonActivity = autoclass('org.kivy.android.PythonActivity')
     String = autoclass('java.lang.String')
     Intent = autoclass('android.content.Intent')
@@ -56,18 +60,21 @@ class Notification:
     :param style: Style of the notification 
     ('simple', 'progress', 'big_text', 'inbox', 'big_picture', 'large_icon', 'both_imgs').
     both_imgs == using lager icon and big picture
-    :param big_picture_path: Path to the image resource.
-    :param large_icon_path: Path to the image resource.
+    :param big_picture_path: Relative Path to the image resource.
+    :param large_icon_path: Relative Path to the image resource.
+    :param callback: Function for notification Click.
     ---
     (Advance Options)
-    :param channel_name: Defaults to "Default Channel"
-    :param channel_id: Defaults to "default_channel"
+    :param channel_name: - str Defaults to "Default Channel"
+    :param channel_id: - str Defaults to "default_channel"
     ---
     (Options during Dev On PC)
-    :param logs: Defaults to True
+    :param logs: - Bool Defaults to True
     """
-    notification_ids=[]
-    button_ids=[]
+    notification_ids=[0]
+    button_ids=[0]
+    btns_box={}
+    main_functions={}
     style_values=[
                   '','simple',
                   'progress','big_text',
@@ -86,6 +93,8 @@ class Notification:
         'channel_name':'Default Channel',
         'channel_id':'default_channel',
         'logs':True,
+        "identifer": '',
+        'callback': None
     }
     # During Development (When running on PC)
     logs=not ON_ANDROID
@@ -99,15 +108,23 @@ class Notification:
         self.big_picture_path=''
         self.progress_current_value=0
         self.progress_max_value=0
+
+        # For Nofitication Functions
+        self.identifer=''
+        self.callback = None
+
         # Advance Options
         self.channel_name='Default Channel'
         self.channel_id='default_channel'
         self.silent=False
+
         # During Dev on PC
         self.logs=self.logs
+
         # Private (Don't Touch)
         self.__id = self.__getUniqueID()
         self.__setArgs(kwargs)
+
         if not ON_ANDROID:
             return
         # TODO make send method wait for __asks_permission_if_needed method
@@ -139,7 +156,7 @@ class Notification:
         """message defaults to last message"""
         if not ON_ANDROID:
             return
-            
+
         if self.logs:
             print(f'Progress Bar Update value: {current_value}')
         self.__builder.setProgress(self.progress_max_value, current_value, False)
@@ -203,7 +220,11 @@ class Notification:
             checkInReference([inputted_kwargs['style']],self.style_values,'values')
 
     def __setArgs(self,options_dict:dict):
+        non_string_keys=['progress_max_value','progress_current_value','callback','logs']
+
         for key,value in options_dict.items():
+            if key not in non_string_keys: # Fixing Types
+                value = str(value)
             if key == 'channel_name' and value.strip():
                 setattr(self,key, value[:40])
             elif key == 'channel_id' and value.strip(): # If user input's a channel id (i format properly)
@@ -234,8 +255,8 @@ class Notification:
 
         # Build the notification
         # self.__builder = NotificationCompatBuilder(context, self.channel_id)# pylint: disable=E0606
-        self.__builder.setContentTitle(self.title)
-        self.__builder.setContentText(self.message)
+        self.__builder.setContentTitle(str(self.title))
+        self.__builder.setContentText(str(self.message))
         self.__builder.setSmallIcon(context.getApplicationInfo().icon)
         self.__builder.setDefaults(NotificationCompat.DEFAULT_ALL) # pylint: disable=E0606
         self.__builder.setPriority(NotificationCompat.PRIORITY_DEFAULT if self.silent else NotificationCompat.PRIORITY_HIGH)
@@ -283,7 +304,7 @@ class Notification:
                 big_pic_bitmap = self.__getBitmap(big_pic_javapath)
                 big_picture_style = NotificationCompatBigPictureStyle().bigPicture(big_pic_bitmap)
                 self.__builder.setStyle(big_picture_style)
-            elif large_icon_javapath:
+            if large_icon_javapath:
                 large_icon_bitmap = self.__getBitmap(large_icon_javapath)
                 self.__builder.setLargeIcon(large_icon_bitmap)
         elif self.style == 'progress':
@@ -298,10 +319,7 @@ class Notification:
     #     return self.__builder
 
     def __getUniqueID(self):
-        reasonable_amount_of_notifications=101
-        notification_id = random.randint(1, reasonable_amount_of_notifications)
-        while notification_id in self.notification_ids:
-            notification_id = random.randint(1, reasonable_amount_of_notifications)
+        notification_id = self.notification_ids[-1] + 1
         self.notification_ids.append(notification_id)
         return notification_id
 
@@ -352,9 +370,15 @@ class Notification:
         # Remove leading/trailing underscores
         channel_id = channel_id.strip('_')
         return channel_id[:50]
+
     def __addIntentToOpenApp(self):
         intent = Intent(context, PythonActivity)
-        intent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP | Intent.FLAG_ACTIVITY_SINGLE_TOP)
+        action = str(self.identifer) or f"ACTION_{self.__id}"
+        intent.setAction(action)
+        self.__addDataToIntent(intent)
+        self.main_functions[action]=self.callback
+        intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP)
+
         pending_intent = PendingIntent.getActivity(
                             context, 0,
                             intent, PendingIntent.FLAG_IMMUTABLE if BuildVersion.SDK_INT >= 31 else PendingIntent.FLAG_UPDATE_CURRENT
@@ -362,13 +386,17 @@ class Notification:
         self.__builder.setContentIntent(pending_intent)
         self.__builder.setAutoCancel(True)
 
+    def __addDataToIntent(self,intent):
+        """Persit Some data to notification object for later use"""
+        bundle = Bundle()
+        bundle.putString("title",  self.title or 'Title Placeholder')
+        bundle.putInt("notify_id", self.__id)
+        intent.putExtras(bundle)
+
     def __getIDForButton(self):
-        reasonable_amount_of_notifications=101
-        btn_id = random.randint(1, reasonable_amount_of_notifications)
-        while btn_id in self.button_ids:
-            btn_id = random.randint(1, reasonable_amount_of_notifications)
+        btn_id = self.button_ids[-1] + 1
         self.button_ids.append(btn_id)
-        return str(btn_id)
+        return btn_id
 
     def addButton(self, text:str,on_release):
         """For adding action buttons
@@ -376,21 +404,40 @@ class Notification:
         Args:
             text (str): Text For Button
         """
+        if self.logs:
+            print('Added Button: ', text)
+
         if not ON_ANDROID:
             return
 
-        if self.logs:
-            print('Added Button: '+text)
+        btn_id= self.__getIDForButton()
+        action = f"BTN_ACTION_{btn_id}"
+
         action_intent = Intent(context, PythonActivity)
-        action_intent.setAction("ACTION "+ self.__getIDForButton())
+        action_intent.setAction(action)
+        action_intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP)
+        bundle = Bundle()
+        bundle.putString("title", self.title or 'Title Placeholder')
+        bundle.putInt("key_int", 123)
+        action_intent.putExtras(bundle)
+        action_intent.putExtra("button_id", btn_id)
+
+        self.btns_box[action] = on_release
+        # action_intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK | Intent.FLAG_ACTIVITY_CLEAR_TOP)
+
+        if self.logs:
+            print('Button id: ',btn_id)
         pending_action_intent = PendingIntent.getActivity(
             context,
             0,
             action_intent,
-            PendingIntent.FLAG_IMMUTABLE
+            PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE
         )
         # Convert text to CharSequence
         action_text = cast('java.lang.CharSequence', String(text))
+
+
+
         # Add action with proper types
         self.__builder.addAction(
             int(context.getApplicationInfo().icon),  # Cast icon to int
@@ -399,38 +446,98 @@ class Notification:
         )
         # Set content intent for notification tap
         self.__builder.setContentIntent(pending_action_intent)
-                # on_release()
-
-# def buttonsListener():
-#     """Handle notification button clicks"""
-#     try:
-#         intent = context.getIntent()
-#         action = context.getAction()
-#         print("The Action --> ",action)
-#         intent.setAction("")
-#         context.setIntent(intent)
-#     except Exception as e:
-#         print("Catching Intents Error ",e)
-
-#     notify=Notification(titl='My Title',channel_name='Go')#,logs=False)
-#     # notify.channel_name='Downloads'
-#     notify.message="Blah"
-#     notify.send()
-#     notify.updateTitle('New Title')
-#     notify.updateMessage('New Message')
-#     notify.send(True)
-# except Exception as e:
-#     print(e)
-
-# notify=Notification(title='My Title1')
-# # notify.updateTitle('New Title1')
-# notify.send()
-
-
-# Notification.logs=False # Add in Readme
-# notify=Notification(style='large_icon',title='My Title',channel_name='Some thing about a thing ')#,logs=False)
-# # notify.channel_name='Downloads'
-# notify.message="Blah"
-# notify.send()
-# notify.updateTitle('New Title')
-# notify.updateMessage('New Message')
+
+
+class NotificationHandler:
+    """For Notification Operations """
+    __identifer = None
+
+    @classmethod
+    def getIdentifer(cls):
+        """Returns identifer for Clicked Notification."""
+        if not cls.is_on_android():
+            return "Not on Android"
+
+        saved_intent = cls.__identifer
+        if not saved_intent or (isinstance(saved_intent, str) and saved_intent.startswith("android.intent")):
+            # All other notifications are not None after First notification opens app
+            # NOTE these notifications are also from Last time app was opened and they Still Give Value after first one opens App
+            # TODO Find a way to get intent when App if Swiped From recents
+            __PythonActivity = autoclass(ACTIVITY_CLASS_NAME)
+            __mactivity = __PythonActivity.mActivity
+            __context = cast('android.content.Context', __mactivity)
+            __Intent = autoclass('android.content.Intent')
+            __intent = __Intent(__context, __PythonActivity)
+            action = __intent.getAction()
+            print('Start up Intent ----', action)
+            print('start Up Title --->',__intent.getStringExtra("title"))
+
+        return saved_intent
+
+    @classmethod
+    def __notificationHandler(cls,intent):
+        """Calls Function Attached to notification on click.
+            Don't Call this function manual, it's Already Attach to Notification.
+        
+        Returns:
+            str: The Identiter of Nofication that was clicked.
+        """
+        if not cls.is_on_android():
+            return "Not on Android"
+        buttons_object=Notification.btns_box
+        notifty_functions=Notification.main_functions
+        if DEV:
+            print("notifty_functions ",notifty_functions)
+            print("buttons_object", buttons_object)
+        action = None
+        try:
+            action = intent.getAction()
+            cls.__identifer = action
+
+            print("The Action --> ",action)
+            if action == "android.intent.action.MAIN": # Not Open From Notification
+                return 'Not notification'
+
+            print(intent.getStringExtra("title"))
+            try:
+                if action in notifty_functions and notifty_functions[action]:
+                    notifty_functions[action]()
+                elif action in buttons_object:
+                    buttons_object[action]()
+            except Exception as e: # pylint: disable=broad-exception-caught
+                print('Failed to run function: ', traceback.format_exc())
+                print("Error Type ",e)
+        except Exception as e: # pylint: disable=broad-exception-caught
+            print('Notify Hanlder Failed ',e)
+        return action
+
+    @classmethod
+    def bindNotifyListener(cls):
+        """This Creates a Listener for All Notification Clicks and Functions"""
+        if not cls.is_on_android():
+            return "Not on Android"
+        #Beta TODO Automatic bind when Notification object is called the first time use keep trying BroadcastReceiver
+        try:
+            activity.bind(on_new_intent=cls.__notificationHandler)
+            return True
+        except Exception as e: # pylint: disable=broad-exception-caught
+            print('Failed to bin notitfications listener',e)
+            return False
+    @classmethod
+    def unbindNotifyListener(cls):
+        """Removes Listener for Notifications Click"""
+        if not cls.is_on_android():
+            return "Not on Android"
+
+        #Beta TODO use BroadcastReceiver
+        try:
+            activity.unbind(on_new_intent=cls.__notificationHandler)
+            return True
+        except Exception as e: # pylint: disable=broad-exception-caught
+            print("Failed to unbind notifications listener: ",e)
+            return False
+
+    @staticmethod
+    def is_on_android():
+        """Utility to check if the app is running on Android."""
+        return ON_ANDROID

{android_notify-1.41 → android_notify-1.50.1}/android_notify.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: android-notify
-Version: 1.41
+Version: 1.50.1
 Summary: A Python package that simpilfies creating Android notifications in Kivy apps.
 Home-page: https://github.com/fector101/android-notify
 Author: Fabian
@@ -47,6 +47,7 @@ Dynamic: summary
 
 - Also Compatible with Android 8.0+.
 - Supports including images in notifications.
+- All Notifications can take Functions (version 1.50+) [functions docs](#functions).
 - Support for multiple notification styles:
   - [Simple](#basic-usage)
   - [Progress](#progress-bar-notification)
@@ -278,6 +279,60 @@ notification = Notification(title="Silent Update")
 notification.send(silent=True)
 ```
 
+## Functions
+
+### NotificationHandler - To Attach Listener
+
+Add this to your main.py App Class so it runs Once, In later Versions It'll be Attached Automatical
+
+```python
+from kivymd.app import MDApp
+from android_notify import Notification, NotificationHandler
+
+class Myapp(MDApp):
+
+    def on_start(self):
+        # Is called Once when app is Starts up
+        NotificationHandler.bindNotifyListener() # if successfull returns True
+        Notification(title="Hello", message="This is a basic notification.",callback=self.doSomething).send()
+
+    def doSomething(self):
+        print("print in Debug Console")
+```
+
+### Get Which Notification was used to Open App - identifer (str)
+
+If you just want to get the Exact Notification Clicked to Open App, you can use NotificationHandler to get unique identifer
+
+```python
+from kivymd.app import MDApp
+from android_notify import Notification, NotificationHandler
+
+class Myapp(MDApp):
+    
+    def on_start(self):
+        
+        notify = Notification(title="Change Page", message="Click to change App page.", identifer='change_app_page')
+        notify.send()
+
+        notify1 = Notification(title="Change Colour", message="Click to change App Colour", identifer='change_app_color')
+        notify1.send()
+
+        NotificationHandler.bindNotifyListener()
+        
+    def on_resume(self):
+        # Is called everytime app is reopened
+        notify_identifer = NotificationHandler.getIdentifer()
+        if notify_identifer == 'change_app_page':
+            # Code to change Screen
+            pass
+        elif notify_identifer == 'change_app_color':
+            # Code to change Screen Color
+            pass
+```
+
+
+
 ### Assist
 
 - How to Copy image to app folder

{android_notify-1.41 → android_notify-1.50.1}/setup.py

@@ -1,4 +1,4 @@
-""" For Packing"""
+""" For Packing """
 from setuptools import setup, find_packages
 
 with open("README.md", "r", encoding="utf-8") as readme_data:
@@ -6,7 +6,7 @@ with open("README.md", "r", encoding="utf-8") as readme_data:
 
 setup(
     name="android-notify",
-    version="1.41",
+    version="1.50.1",
     author="Fabian",
     author_email='fector101@yahoo.com',
     description="A Python package that simpilfies creating Android notifications in Kivy apps.",

android_notify-1.41/android_notify/__init__.py

@@ -1,3 +0,0 @@
-from .core import send_notification
-from .styles import NotificationStyles
-from .sword import Notification