enniel/laravel-fcm-notification-channel

Firebase Cloud Messages Notification Driver

FCM notification channel for Laravel 5.3

This package makes it easy to send notifications using Firebase Cloud Messaging (FCM) with Laravel 5.3. This package is based on brozot/laravel-fcm, so please read that documentation for more information., _(*1)

Contents

• Installation
• Usage
  • Available message types
  • Available message methods
• Testing
• Credits
• Support
• License

Installation

You can install this package via composer:, _(*2)

``` bash composer require enniel/laravel-fcm-notification-channel:1.*, <sub>(*3)</sub>

Register the provider directly in your app configuration file `config/app.php`:
``` php
'providers' => [
    // ...

    NotificationChannels\FCM\ServiceProvider::class 
]

Usage

Now you can use the channel in your via() method inside the notification:, <sub>(*4)</sub>

use NotificationChannels\FCM\FCMMessage;
use Illuminate\Notifications\Notification;

class ExampleNotification extends Notification
{
    public function via($notifiable)
    {
        return ['fcm'];
    }

    public function toFCM($notifiable)
    {
        return (new FCMMessage())
            ->notification([
                'title' => 'Notification title',
                'body' => 'Notification body',
            ]);
    }
}

Available message types:

• FCMMessage: Send notifications to device(s).
• FCMMessageTopic: Send notifications to topic(s).
• FCMMessageGroup: Send notifications to group(s).

In order for your notice to know who to send messages, you must add routeNotificationForFCM method to your notification model., <sub>(*5)</sub>

Available message methods

• data(): Notification data. array | LaravelFCM\Message\PayloadData | LaravelFCM\Message\PayloadDataBuilder
• options(): Notification options. array | LaravelFCM\Message\Options | LaravelFCM\Message\OptionsBuilder
• notification(): Notification content. array | LaravelFCM\Message\PayloadNotification | LaravelFCM\Message\PayloadNotificationBuilder

Proxy methods. See brozot/laravel-fcm for more information about this methods.

• setDryRun
• setPriority
• setTimeToLive
• setCollapseKey
• setDelayWhileIdle
• setMutableContent
• setContentAvailable
• setRestrictedPackageName
• isDryRun
• getPriority
• getTimeToLive
• getCollapseKey
• isDelayWhileIdle
• isMutableContent
• isContentAvailable
• getRestrictedPackageName
• setTag
• setBody
• setIcon
• setTitle
• setSound
• setBadge
• setColor
• setChannelId
• setClickAction
• setBodyLocationKey
• setBodyLocationArgs
• setTitleLocationKey
• setTitleLocationArgs
• getTag
• getBody
• getIcon
• getTitle
• getSound
• getBadge
• getColor
• getChannelId
• getClickAction
• getBodyLocationKey
• getBodyLocationArgs
• getTitleLocationKey
• getTitleLocationArgs

Testing

bash $ composer test, <sub>(*6)</sub>

Credits

• Evgeni Razumov
• All Contributors

Support

Having trouble? Open an issue!, <sub>(*7)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*8)</sub>