Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/larasoft-io/pusher-mobile-notifications
https://github.com/larasoft-io/pusher-mobile-notifications
ios laravel laravel-5-package laravel-framework laravel5 laravel55 notifications notifications-plugin pusher
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/larasoft-io/pusher-mobile-notifications
- Owner: larasoft-io
- License: mit
- Created: 2017-09-22T07:06:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-06T13:14:35.000Z (almost 5 years ago)
- Last Synced: 2024-10-12T11:42:18.095Z (2 months ago)
- Topics: ios, laravel, laravel-5-package, laravel-framework, laravel5, laravel55, notifications, notifications-plugin, pusher
- Language: PHP
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Pusher push notifications channel for Laravel 5.3.* | 5.4.* | 5.5.*
[](https://packagist.org/packages/laravel-notification-channels/pusher-push-notifications)
[](LICENSE.md)
[](https://travis-ci.org/laravel-notification-channels/pusher-push-notifications)
[](https://styleci.io/repos/65379321)
[](https://insight.sensiolabs.com/projects/9015691f-130d-4fca-8710-72a010abc684)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/pusher-push-notifications)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/pusher-push-notifications/?branch=master)
[](https://packagist.org/packages/laravel-notification-channels/pusher-push-notifications)
This package makes it easy to send [Pusher push notifications](https://pusher.com/docs/push_notifications) with Laravel 5.3.* | 5.4.* | 5.5.* | 6.0.*
## Contents
- [Installation](#installation)
- [Setting up your Pusher account](#setting-up-your-pusher-account)
- [Usage](#usage)
- [Available Message methods](#available-message-methods)
- [Changelog](#changelog)
- [Testing](#testing)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
You can install the package via composer:
``` bash
composer require larasoft-io/pusher-mobile-notifications
```
You must install the service provider:
```php
// config/app.php
'providers' => [
...
Larasoft\PusherPushNotifications\PusherPushNotificationsServiceProvider::class,
],
```
### Setting up your Pusher account
Before using this package you should set up a Pusher account. Here are the steps required.
- 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.
``` php
use Larasoft\PusherPushNotifications\PusherChannel;
use Larasoft\PusherPushNotifications\PusherMessage;
use Illuminate\Notifications\Notification;
class AccountApproved extends Notification
{
public function via($notifiable)
{
return [PusherChannel::class];
}
public function toPushNotification($notifiable)
{
return PusherMessage::create()
->iOS()
->badge(1)
->sound('success')
->body("Your {$notifiable->service} account was approved!");
}
}
```
### 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.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
$ composer test
```
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Mohamed Said](https://github.com/themsaid)
- [Marcel Pociot](https://github.com/mpociot)
- [Freek Van der Herten](https://github.com/freekmurze)
- [Sebastian De Deyne](https://github.com/sebastiandedeyne)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.