vasadibt / yii2-onesignal
This is a restful api to onesignal.
Installs: 1 740
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 3
Forks: 2
Open Issues: 0
Type:yii2-extension
Requires
- guzzlehttp/guzzle: ^6.3
- symfony/options-resolver: ^3.0
- yiisoft/yii2: ~2.0.0
This package is auto-updated.
Last update: 2024-11-10 21:57:46 UTC
README
This is a restful api to onesignal.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist vasadibt/yii2-onesignal "dev-master"
or add
"vasadibt/yii2-onesignal": "dev-master"
to the require section of your composer.json
file.
Config
Once the extension is installed, you have to configure the api component:
'components' => [ 'onesignal' => [ 'class' => '\vasadibt\onesignal\OneSignal', 'appId' => 'your-app-id-hash-code', 'appAuthKey' => 'SetYourAppAuthKey', 'userAuthKey' => 'SetYourUserAuthKey', 'enabled' => YII_ENV_PROD ? true : false, ], ],
Usage
Call api endpoints:
Yii::$app->onesignal->apps->getAll(); Yii::$app->onesignal->devices->getOne('asd-asd-asd-asd-asd-asd'); Yii::$app->onesignal->devices->getAll(); Yii::$app->onesignal->notifications->add([ 'include_player_ids' => ['player-hash-code-12345-123456789'], 'contents' => ["en" => 'New message'], ]); Yii::$app->onesignal->notifications->add([ 'included_segments' => ['All'], 'contents' => ["en" => 'New message'], ]);