Download the PHP package jmrieger/onesignal-laravel without Composer
On this page you can find all versions of the php package jmrieger/onesignal-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package onesignal-laravel
OneSignal Push Notifications for Laravel 5
WARNING!
This project is not actively maintained as of 2018/12/12. I'd strongly urge you to consider a package that is, like berkayk/onesignal-laravel
Introduction
This project is a wrapper for the OneSignal v1 API. It supports all operations currently supported by the API.
Installation (Laravel and Lumen)
Require the package with composer.
Laravel Users:
Update config/app.php
by adding the following entries.
Lumen Users:
update bootstrap/app.php
, adding the following entry
Configuration
There are 3 settings that need to be updated: your default OneSignal app ID, the REST API key, and the User Auth Key. All of these items can be found in your Control Panel on the OneSignal site.
First, publish the onesignal config:
Place the 3 keys into your .env file, as such:
Usage
There is a function for each of the OneSignal API calls. They are broken down here.
Note: In all instances where an $app_id is asked for, omitting it will grab the default OneSignal App ID specified in the .env file
Apps
getApps() - Get all Apps for the user
getApp( $app_id ) - Get the given App
postapp( $data ) - Create a new App
putApp( $app_id, $data ) - Update an App
Players
getPlayers( $app_id, $limit, $offset ) - Get Players from an App
getPlayer( $id ) - Get Player of the given ID
postPlayer ( $data, $app_id ) - Add Player to an App
putPlayer( $data, $app_id ) - Update Player object for an App
postCSVExport( $app_id ) - Get a CSV dump of all Players for an App
postPlayerOnSession( $data ) - Start a new device session for this Player
postPlayerOnPurchase( $data ) - Track a new purchase for this Player
postPlayerOnFocus( $data ) - Increment the Players total session length
Notifications
getNotifications( $app_id, $limit, $offset ) - Get all Notifications for an App
getNotification( $id, $app_id ) - Get a Notification from an App
postNotification( $data, $app_id ) - Add a Notification to an App
putNotificationTrackOpen( $id, $app_id, $opened ) - Track whether a Notification was opened
deleteNotification( $id, $app_id ) - Delete a Notification from an App
References
The official OneSignal API documentation is listed here: https://documentation.onesignal.com/docs/server-api-overview
Acknowledgements
This project was inspired by, and evolved from, https://github.com/berkayk/laravel-onesignal
All versions of onesignal-laravel with dependencies
guzzlehttp/guzzle Version ^6.2
illuminate/support Version 4.*|5.*
symfony/psr-http-message-bridge Version ^0.2.0