Download the PHP package laravel-notification-channels/pushwoosh without Composer
On this page you can find all versions of the php package laravel-notification-channels/pushwoosh. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download laravel-notification-channels/pushwoosh
More information about laravel-notification-channels/pushwoosh
Files in laravel-notification-channels/pushwoosh
Package pushwoosh
Short Description Pushwoosh notification channel for Laravel
License MIT
Informations about the package pushwoosh
Pushwoosh notification channel for Laravel
This package makes sending notifications using Pushwoosh a breeze.
Contents
- Requirements
- Installation
- Usage
- Routing notifications
- Sending notifications
- Available methods
- Changelog
- Testing
- Security
- Contributing
- Credits
- License
Requirements
This make use of this package you need:
- Laravel 5.5 or higher
- PHP 7.1 or higher
- An active Pushwoosh subscription (and use at least one Pushwoosh SDK)
Installation
To install this package run the following command:
Next, add the following lines to your config/services.php
:
You can now add the PUSHWOOSH_APP_CODE
(found here) and the
PUSHWOOSH_TOKEN
(found here) to your environment file.
Usage
Using this package, you can use Pushwoosh just like any other notification channel within Laravel. For more information about Laravel's notification system, see the official documentation.
Note that before you can start sending pushes you must first register users to your application using one of Pushwoosh's SDKs.
Routing notifications
In order for Pushwoosh to know to what devices it needs to send to, you will need to add the
routeNotificationForPushwoosh
to your notifiable model(s), for example:
The routeNotificationForPushwoosh
method may return a string, an array of strings or a PushwooshRecipient
instance.
For more information about the PushwooshRecipient
class refer to the available methods section.
Sending notifications
Sending a pushwoosh message is easy, add pushwoosh
to your notification's via method and implement the toPushwoosh
method, for example:
The
toPushwoosh
method may return a string or an instance of thePushwooshMessage
class, for more information on thePushwooshMessage
class refer to the available methods section.
You can then send a push to one user:
Or to multiple users:
Unknown devices
When you reference devices that do not exist (anymore), a NotificationChannels\Pushwoosh\Events\UnknownDevices
event
will be dispatched.
You can easily hook into this event like so:
Available methods
This section details the public API of this package.
PushwooshMessage
Below is a list of available methods on the PushwooshMessage
class.
Method | Description |
---|---|
campaign($campaign) |
Set the Pushwoosh campaign code |
content($content[, $language]) |
Set the message content (optionally for a specific language) |
deliverAt($when[, $timezone]) |
Set the delivery moment |
identifier($identifier) |
Set the Pushwoosh unique identifier (defaults to the notification ID) |
preset($preset) |
Set the Pushwoosh preset code |
throttle($limit) |
Throttle the rollout (100-1000 pushes per second) |
title($title) |
Set the message title (only on Chrome, Firefox, iOS and Safari) |
url($url[, $shorten]) |
Set the URL the message should link to |
useRecipientTimezone() |
Respect the recipients' timezone when delivering the message |
with($key, $value[, $platform]) |
Add a root level parameter. |
PushwooshRecipient
Below is a list of available methods on the PushwooshRecipient
class.
Method | Description |
---|---|
device($device[, ...]) |
Limit the delivery to the given device(s) |
platform($platform[, ...]) |
Limit the delivery to the given platform(s) |
user($user[, ...]) |
Limit the delivery to the given user(s) |
within($lat, $lng, $range) |
Limit the delivery to the given geo zone |
Platforms
Below is a list of supported platforms, for the PushwooshRecipient::platform
method.
- Amazon
- Android
- Blackberry
- Chrome
- Firefox
- iOS
- Mac
- Safari
- Windows
- Windows Phone
Changelog
Please see the changelog for more information on what has changed recently.
Testing
Contributing
If you want to contribute to this package, take a look at the contribution guide.
Credits
- Choraimy Kroonstuiver
- All Contributors
License
This product is licensed under the MIT License (MIT). Please see the License File for more information.
All versions of pushwoosh with dependencies
ext-json Version *
guzzlehttp/guzzle Version ^6.2 || ^7.0
guzzlehttp/psr7 Version ^1.0 || ^2.0
laravel/framework Version ^5.5 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0