demian/laravel-notifications-gcm

Android GCM Push Notification Channel

Laravel GCM (Google Cloud Messaging) Notification Channel

, _(*1)

This package makes it easy to send notifications using Google Cloud Messaging (GCM) with Laravel 5.3., _(*2)

This package is based on ZendService\Google\Gcm, so please read that documentation for more information., _(*3)

Contents

• Installation
  • Setting up the GCM service
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

Install this package with Composer:, _(*4)

composer require laravel-notification-channels/gcm

Register the ServiceProvider in your config/app.php:, _(*5)

NotificationChannels\Gcm\GcmServiceProvider::class,

Setting up the GCM service

You need to register for a server key for Google Cloud Messaging for your App in the Google API Console: https://console.cloud.google.com/apis/, _(*6)

Add the API key to your configuration in config/broadcasting.php, _(*7)

'connections' => [
  ....
  'gcm' => [
      'key' => env('GCM_KEY'),
  ],
  ...
]

Usage

You can now send messages to GCM by creating a GcmMessage:, _(*8)

use NotificationChannels\Gcm\GcmChannel;
use NotificationChannels\Gcm\GcmMessage;
use Illuminate\Notifications\Notification;

class AccountApproved extends Notification
{
    public function via($notifiable)
    {
        return [GcmChannel::class];
    }

    public function toGcm($notifiable)
    {
        return GcmMessage::create()
            ->badge(1)
            ->title('Account approved')
            ->message("Your {$notifiable->service} account was approved!");
    }
}

In your notifiable model, make sure to include a routeNotificationForGcm() method, which return one or an array of tokens., _(*9)

public function routeNotificationForGcm()
{
    return $this->gcm_token;
}

Available methods

• title($str)
• message($str)
• badge($integer)
• priorty(GcmMessage::PRIORITY_NORMAL or GcmMessage::PRIORITY_HIGH)
• data($key, $mixed)
• action($action, $params) (Will set an action data key)

Changelog

Please see CHANGELOG for more information what has changed recently., _(*10)

Testing

bash $ composer test, _(*11)

Security

If you discover any security related issues, please email info@fruitcake.nl instead of using the issue tracker., _(*12)

Contributing

Please see CONTRIBUTING for details., _(*13)

Credits

• Fruitcake
• All Contributors

License

The MIT License (MIT). Please see License File for more information., _(*14)