overmob/pusher-push-notifications

Pusher native Push Notifications driver.

Pusher push notifications channel for Laravel 5.5

, _(*1)

This package makes it easy to send Pusher push notifications with Laravel 5.5., _(*2)

Contents

• Installation
  • Setting up your Pusher account
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:, _(*3)

``` bash composer require overmob/pusher-push-notifications:dev-master, <sub>(*4)</sub>

You could install the service provider:

```php
// config/app.php
'providers' => [
    ...
    NotificationChannels\PusherPushNotifications\PusherPushNotificationsServiceProvider::class,
],

Setting up your Pusher account

Before using this package you should set up a Pusher account. Here are the steps required., <sub>(*5)</sub>

• Login to https://dashboard.pusher.com/
• Select your app from the sidebar or create a new app.
• Click on the "Push Notifications" tab.
• Upload your APNS Certificate or add your GCM API key.
• Now select the "App Keys" tab.
• Copy your app_id, key, and secret.
• Update the values in your config/broadcasting.php file under the pusher connection.
• You're now good to go.

Usage

Now you can use the channel in your via() method inside the Notification class., <sub>(*6)</sub>

``` php use NotificationChannels\PusherPushNotifications\PusherChannel; use NotificationChannels\PusherPushNotifications\PusherMessage; use Illuminate\Notifications\Notification;, <sub>(*7)</sub>

class AccountApproved extends Notification { public function via($notifiable) { return [PusherChannel::class]; }, <sub>(*8)</sub>

public function toPushNotification($notifiable)
{
    return PusherMessage::create()
        ->android()
        ->title('')
        ->icon('')
        ->badge(1)
        ->sound('success')
        ->body("Your {$notifiable->service} account was approved!");
}

}, <sub>(*9)</sub>

### Available Message methods

- `platform('')`: Accepts a string value of `iOS` or `Android`.
- `iOS()`: Sets the platform value to iOS.
- `android()`: Sets the platform value to Android.
- `title('')`: Accepts a string value for the title.
- `body('')`: Accepts a string value for the body.
- `sound('')`: Accepts a string value for the notification sound file. Notice that if you leave blank the default sound value will be `default`.
- `icon('')`: Accepts a string value for the icon file. (Android Only)
- `badge(1)`: Accepts an integer value for the badge. (iOS Only)
- `setOption($key, $value)`: Allows you to set any value in the message payload. For more information [check here for iOS](https://pusher.com/docs/push_notifications/ios/server), [or here for Android](https://pusher.com/docs/push_notifications/android/server).

### Sending to multiple platforms

You can send a single message to an iOS device and an Android device at the same time using the `withiOS()` and `withAndroid()` method:

```php
public function toPushNotification($notifiable)
{
    $message = "Your {$notifiable->service} account was approved!";

    return PusherMessage::create()
        ->iOS()
        ->badge(1)
        ->body($message)
        ->withAndroid(
            PusherMessage::create()
                ->title($message)
                ->icon('icon')
        );
}

• Notice that iOS is the default platform, which means you don't have to call ->iOS().
• When using withAndroid() or withiOS() you don't have to define the platform, it's done behind the scenes for you.

Routing a message

By default the pusher "interest" messages will be sent to will be defined using the {notifiable}.{id} convention, for example App.User.1, however you can change this behaviour by including a routeNotificationForPusherPushNotifications() in the notifiable class method that returns the interest name., <sub>(*10)</sub>

Changelog

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

Testing

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

Security

If you discover any security related issues, please email themsaid@gmail.com instead of using the issue tracker., <sub>(*13)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*14)</sub>

Credits

• Mohamed Said
• Marcel Pociot
• Freek Van der Herten
• Sebastian De Deyne
• All Contributors

License

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