Create a notification and possibly listed & report about notification activity.
Parameters:
| Name |
Type |
Description |
Default |
config |
JSONNotificationConfig
|
The configuration of the notification to send.
|
required
|
queue_to_submit_events_to |
SimpleQueue | None
|
The Queue to submit user activity related to the callbacks to. If this argument is passed, it will start the event listener after it created the Notifications. If this is None, it will only create the notification.
|
required
|
Source code in mac_notifications/notification_sender.py
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108 | def create_notification(config: JSONNotificationConfig, queue_to_submit_events_to: SimpleQueue | None) -> Any:
"""
Create a notification and possibly listed & report about notification activity.
:param config: The configuration of the notification to send.
:param queue_to_submit_events_to: The Queue to submit user activity related to the callbacks to. If this argument
is passed, it will start the event listener after it created the Notifications. If this is None, it will only
create the notification.
"""
class MacOSNotification(NSObject):
def send(self):
"""Sending of the notification"""
notification = NSUserNotification.alloc().init()
notification.setIdentifier_(config.uid)
if config is not None:
notification.setTitle_(config.title)
if config.subtitle is not None:
notification.setSubtitle_(config.subtitle)
if config.text is not None:
notification.setInformativeText_(config.text)
if config.icon is not None:
url = NSURL.alloc().initWithString_(f"file://{config.icon}")
image = NSImage.alloc().initWithContentsOfURL_(url)
notification.setContentImage_(image)
# Notification buttons (main action button and other button)
if config.action_button_str:
notification.setActionButtonTitle_(config.action_button_str)
notification.setHasActionButton_(True)
if config.snooze_button_str:
notification.setOtherButtonTitle_(config.snooze_button_str)
if config.reply_callback_present:
notification.setHasReplyButton_(True)
if config.reply_button_str:
notification.setResponsePlaceholder_(config.reply_button_str)
NSUserNotificationCenter.defaultUserNotificationCenter().setDelegate_(self)
# Setting delivery date as current date + delay (in seconds)
notification.setDeliveryDate_(
NSDate.dateWithTimeInterval_sinceDate_(config.delay_in_seconds, NSDate.date())
)
# Schedule the notification send
NSUserNotificationCenter.defaultUserNotificationCenter().scheduleNotification_(notification)
# Wait for the notification CallBack to happen.
if queue_to_submit_events_to:
logger.debug("Started listening for user interactions with notifications.")
AppHelper.runConsoleEventLoop()
def userNotificationCenter_didDeliverNotification_(
self, center: "_NSConcreteUserNotificationCenter", notif: "_NSConcreteUserNotification" # type: ignore # noqa
) -> None:
"""Respond to the delivering of the notification."""
logger.debug(f"Delivered: {notif.identifier()}")
def userNotificationCenter_didActivateNotification_(
self, center: "_NSConcreteUserNotificationCenter", notif: "_NSConcreteUserNotification" # type: ignore # noqa
) -> None:
"""
Respond to a user interaction with the notification.
"""
identifier = notif.identifier()
response = notif.response()
activation_type = notif.activationType()
if queue_to_submit_events_to is None:
raise ValueError("Queue should not be None here.")
else:
queue: SimpleQueue = queue_to_submit_events_to
logger.debug(f"User interacted with {identifier} with activationType {activation_type}.")
if activation_type == 1:
# user clicked on the notification (not on a button)
pass
elif activation_type == 2: # user clicked on the action button
queue.put((identifier, "action_button_clicked", ""))
elif activation_type == 3: # User clicked on the reply button
queue.put((identifier, "reply_button_clicked", response.string()))
# create the new notification
new_notif = MacOSNotification.alloc().init()
# return notification
return new_notif
|