Notifications

Wirechat keeps you connected to your conversations even when you're not actively using the app. Unlike in-app alerts, these are global notifications that appear in your browser’s notification tray. By harnessing the power of Service Workers and the Web Notifications API, Wirechat ensures you never miss an important message, no matter which tab or application you're using.

#How It Works

Wirechat’s service worker manages notifications by:

• Displaying alerts when the app isn’t in focus.
• Automatically dismissing notifications when the related conversation is opened.
• Using tags based on conversation IDs to prevent duplicate alerts.

#Installation

Publish the required service worker scripts with:

php artisan wirechat:setup-notifications

This command will:

• Publish Wirechat’s service worker to public/js/wirechat/sw.js.
• Publish the main service worker script to public/sw.js.

#Importing Wirechat's Service Worker

If you have a custom sw.js, simply import Wirechat’s service worker by adding:

importScripts('/js/wirechat/sw.js');

#Enabling Notifications

Update your Wirechat configuration file to enable notifications:

return [
    //...
    'notifications' => [
        'enabled' => true,
        'main_sw_script' => 'sw.js', // Relative to the public folder
    ],
];

#Requesting Permissions

Before sending any alerts, Wirechat prompts users for notification permissions automatically.

#Notification Lifecycle

When a new message arrives while you’re away from the conversation, a notification is triggered. These notifications:

• Appear in the browser’s tray without cluttering your interface.
• Use tags to prevent duplicates.
• Automatically close when clicked, redirecting you to the corresponding conversation in a new or existing tab.

#Limitations

#Notification API

• User Permissions & Settings:
  Notifications require explicit permission, and users might need to enable them in their browser or system settings.
• Policy Constraints:
  Notification behavior (such as sound, display duration, and interactions) is controlled by browser and OS policies.

#Service Worker API

• Secure Context:
  Service Workers only run on HTTPS (except on localhost during development).
• Lifecycle & Support:
  They’re event-driven and may be terminated when idle, with feature support varying across browsers.

#Conclusion

Wirechat offers a streamlined solution for real-time notifications, ensuring your users stay informed with minimal setup. Enjoy a smart, unobtrusive notification system that keeps your conversations accessible at all times.