2017 © Pedro Peláez
 

library gcm

Android GCM Push Notification Channel

image

laravel-notification-channels/gcm

Android GCM Push Notification Channel

  • Friday, March 23, 2018
  • by Barryvdh
  • Repository
  • 7 Watchers
  • 37 Stars
  • 32,036 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 15 Forks
  • 6 Open issues
  • 7 Versions
  • 16 % Grown

The README.md

Laravel GCM (Google Cloud Messaging) Notification Channel

Latest Version on Packagist Software License Build Status StyleCI SensioLabsInsight Quality Score Code Coverage Total Downloads, (*1)

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

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

Google has deprecated/discontinued GCM as of April 11, 2019. As such, this package is also considered deprecated., (*4)

Contents

Installation

Install this package with Composer:, (*5)

composer require laravel-notification-channels/gcm

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

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/, (*7)

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

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

Usage

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

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()
            ->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., (*10)

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

Available methods

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

Changelog

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

Testing

bash $ composer test, (*12)

Security

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

Contributing

Please see CONTRIBUTING for details., (*14)

Credits

License

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

The Versions