This package makes it easy to send Pusher Beams push notifications with Laravel.
Please note that this notification channel should not be confused with Pusher Channels.
Also please note that prior to version 2.0, this package integrated with Pusher's beta push notifications service that was part of Pusher Channels. Please see Pusher's migration guide for more information.
You can install the package via composer:
composer require laravel-notification-channels/pusher-push-notificationsBefore using this package you should set up a Pusher Beams account. Here are the steps required.
- Login to https://dash.pusher.com/
- Select the "Beams" product.
- Select your instance from the list or create a new instance.
- Click on the "Settings" tab.
- Upload your APNS Certificate and/or add your FCM Server key.
- Now select the "Credentials" tab.
- Copy your
Instance Id, andSecret Key. - Add a new entry to in your
config/services.phpfile:'pusher' => [ 'beams_instance_id' => 'Your Instance Id', 'beams_secret_key' => 'Your Secret Key', ],
- You're now good to go.
Now you can use the channel in your via() method inside the Notification class.
use NotificationChannels\PusherPushNotifications\PusherChannel;
use NotificationChannels\PusherPushNotifications\PusherMessage;
use Illuminate\Notifications\Notification;
class AccountApproved extends Notification
{
public function via($notifiable)
{
return [PusherChannel::class];
}
public function toPushNotification($notifiable)
{
return PusherMessage::create()
->iOS()
->badge(1)
->sound('success')
->body("Your {$notifiable->service} account was approved!");
}
}platform(''): Accepts a string value ofiOSorAndroid.iOS(): Sets the platform value to iOS.android(): Sets the platform value to Android.title(''): Accepts a string value for the title.body(''): Accepts a string value for the body.sound(''): Accepts a string value for the notification sound file. Notice that if you leave blank the default sound value will bedefault.icon(''): Accepts a string value for the icon file. (Android Only)badge(1): Accepts an integer value for the badge. (iOS Only)setOption($key, $value): Allows you to set any value in the message payload. See the request body section of the Pusher Beam docs for more information.
You can send a single message to an iOS device and an Android device at the same time using the withiOS() and withAndroid() method:
public function toPushNotification($notifiable)
{
$message = "Your {$notifiable->service} account was approved!";
return PusherMessage::create()
->iOS()
->badge(1)
->body($message)
->withAndroid(
PusherMessage::create()
->title($message)
->icon('icon')
);
}
- Notice that iOS is the default platform, which means you don't have to call
->iOS().- When using
withAndroid()orwithiOS()you don't have to define the platform, it's done behind the scenes for you.
By default the pusher "interest" messages will be sent to will be defined using the {notifiable}.{id} convention, for example App.User.1, however you can change this behaviour by including a routeNotificationForPusherPushNotifications() in the notifiable class method that returns the interest name.
Please see CHANGELOG for more information what has changed recently.
$ composer testIf you discover any security related issues, please email [email protected] instead of using the issue tracker.
Please see CONTRIBUTING for details.
The MIT License (MIT). Please see License File for more information.