Current File : /var/www/html/diaspora/api/vendor/benwilkins/laravel-fcm-notification/README.md
# laravel-fcm-notification
Laravel FCM (Firebase Cloud Messaging) Notification Channel
[](https://github.com/benwilkins/laravel-fcm-notification/releases)
[](LICENSE.md)
Use this package to send push notifications via Laravel to Firebase Cloud Messaging. Laravel 5.3+ required.
This package works only with [Legacy HTTP Server Protocol](https://firebase.google.com/docs/cloud-messaging/http-server-ref)
## Install
This package can be installed through Composer.
``` bash
composer require benwilkins/laravel-fcm-notification:dev-master
```
If installing on < Laravel 5.5 then add the service provider:
```php
// config/app.php
'providers' => [
...
Benwilkins\FCM\FcmNotificationServiceProvider::class,
...
];
```
Add your Firebase API Key in `config/services.php`.
```php
return [
...
...
/*
* Add the Firebase API key
*/
'fcm' => [
'key' => ''
]
];
```
## Example Usage
Use Artisan to create a notification:
```bash
php artisan make:notification SomeNotification
```
Return `[fcm]` in the `public function via($notifiable)` method of your notification:
```php
public function via($notifiable)
{
return ['fcm'];
}
```
Add the method `public function toFcm($notifiable)` to your notification, and return an instance of `FcmMessage`:
```php
use Benwilkins\FCM\FcmMessage;
...
public function toFcm($notifiable)
{
$message = new FcmMessage();
$message->content([
'title' => 'Foo',
'body' => 'Bar',
'sound' => '', // Optional
'icon' => '', // Optional
'click_action' => '' // Optional
])->data([
'param1' => 'baz' // Optional
])->priority(FcmMessage::PRIORITY_HIGH); // Optional - Default is 'normal'.
return $message;
}
```
When sending to specific device, make sure your notifiable entity has `routeNotificationForFcm` method defined:
```php
/**
* Route notifications for the FCM channel.
*
* @param \Illuminate\Notifications\Notification $notification
* @return string
*/
public function routeNotificationForFcm($notification)
{
return $this->device_token;
}
```
When sending to a topic, you may define so within the `toFcm` method in the notification:
```php
use Benwilkins\FCM\FcmMessage;
...
public function toFcm($notifiable)
{
$message = new FcmMessage();
$message->to('the-topic', $recipientIsTopic = true)
->content([...])
->data([...]);
return $message;
}
```
Or when sending with a condition:
```php
use Benwilkins\FCM\FcmMessage;
...
public function toFcm($notifiable)
{
$message = new FcmMessage();
$message->contentAvailable(true)
->priority('high')
->condition("'user_".$notifiable->id."' in topics")
->data([...]);
return $message;
}
```
## Interpreting a Response
To proccess any laravel notification channel response check [Laravel Notification Events](https://laravel.com/docs/5.5/notifications#notification-events)
This channel return a json array response:
```json
{
"multicast_id": "number",
"success": "number",
"failure": "number",
"canonical_ids": "number",
"results": "array",
}
```
Check [FCM Legacy HTTP Server Protocol](https://firebase.google.com/docs/cloud-messaging/http-server-ref#interpret-downstream)
for response interpreting documentation.
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.
Mini Shell