Exponent push notifications channel for Laravel 5.3
Contents
Installation
You can install the package via composer:
composer require alymosul/laravel-exponent-push-notifications
You must install the service provider:
// config/app.php
'providers' => [
...
NotificationChannels\ExpoPushNotifications\ExpoPushNotificationsServiceProvider::class,
],
Usage
use NotificationChannels\ExpoPushNotifications\ExpoChannel;
use NotificationChannels\ExpoPushNotifications\ExpoMessage;
use Illuminate\Notifications\Notification;
class AccountApproved extends Notification
{
public function via($notifiable)
{
return [ExpoChannel::class];
}
public function toExpoPush($notifiable)
{
return ExpoMessage::create()
->badge(1)
->enableSound()
->body("Your {$notifiable->service} account was approved!");
}
}
Available Message methods
A list of all available options
body('')
: Accepts a string value for the body.enableSound()
: Enables the notification sound.disableSound()
: Mutes the notification sound.badge(1)
: Accepts an integer value for the badge.ttl(60)
: Accepts an integer value for the time to live.
Managing Recipients
This package registers two endpoints that handle the subscription of recipients, the endpoints are defined in src/Http/routes.php file, used by ExpoController and all loaded through the package service provider.
Routing a message
By default the exponent "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 routeNotificationForExpoPushNotifications()
in the notifiable class method that returns the interest name.
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.