https://github.com/enniel/laravel-fcm-notification-channel

https://github.com/enniel/laravel-fcm-notification-channel

farebase laravel notifications

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/enniel/laravel-fcm-notification-channel
• Owner: enniel
• License: mit
• Created: 2016-12-20T12:42:25.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-24T13:56:02.000Z (over 4 years ago)
• Last Synced: 2024-10-29T00:55:45.953Z (2 months ago)
• Topics: farebase, laravel, notifications
• Language: PHP
• Size: 19.5 KB
• Stars: 22
• Watchers: 4
• Forks: 23
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# FCM notification channel for Laravel 5.3

This package makes it easy to send notifications using [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) (FCM) with Laravel 5.3.

This package is based on [brozot/laravel-fcm](https://github.com/brozot/Laravel-FCM), so please read that documentation for more information.

## Contents

- [Installation](#installation)

- [Usage](#usage)

    - [Available message types](#available-message-types)

    - [Available message methods](#available-message-methods)

- [Testing](#testing)

- [Credits](#credits)

- [Support](#support)

- [License](#license)

## Installation

You can install this package via composer:

``` bash

composer require enniel/laravel-fcm-notification-channel:1.*

```

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:

```php

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.

### 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](https://github.com/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

```

## Credits

- [Evgeni Razumov](https://github.com/enniel)

- [All Contributors](../../contributors)

## Support

Having trouble? Open an issue!

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.