freyo / xinge
This package makes it easy to send notifications via Tencent Xinge with Laravel
Requires
- php: >=5.6.4
- illuminate/notifications: 5.3.*|5.4.*|5.5.*|5.6.*
- illuminate/support: 5.1.*|5.2.*|5.3.*|5.4.*|5.5.*|5.6.*
Requires (Dev)
- mockery/mockery: ^0.9.5
- phpunit/phpunit: 5.*
README
腾讯移动推送(XinGe Push,即 XGPush)
This package makes it easy to send notifications using Tencent Xinge with Laravel.
Installation
You can install this package via composer:
composer require freyo/xinge
Next add the service provider and facade to your config/app.php
:
... 'providers' => [ ... Freyo\Xinge\ServiceProvider::class, ], 'aliases' => [ ... 'Xinge' => Freyo\Xinge\Facade::class, ], ...
Laravel 5.5 uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.
Setting up the Xinge service
You will need to create a Xinge app in order to use this channel. Within in this app you will find the access id and access secret
. Place them inside your .env
file. In order to load them, add this to your config/services.php
file:
... 'xinge' => [ 'android' => [ 'access_id' => env('XINGE_ANDROID_ACCESS_ID'), 'secret_key' => env('XINGE_ANDROID_ACCESS_KEY') ], 'ios' => [ 'access_id' => env('XINGE_IOS_ACCESS_ID'), 'secret_key' => env('XINGE_IOS_ACCESS_KEY') ], ] ...
This will load the Xinge app data from the .env
file. Make sure to use the same keys you have used there like XINGE_IOS_ACCESS_ID
.
Usage
Notification
Follow Laravel's documentation to add the channel to your Notification class.
Example: AndroidPushSingleAccount, iOSPushSingleAccount.
Facade
Xinge::android()->PushSingleDevice($deviceToken, $message); Xinge::android()->PushSingleAccount($deviceType, $account, $message); Xinge::android()->PushAllDevices($deviceType, $message); Xinge::android()->PushTags($deviceType, $tagList, $tagsOp, $message); Xinge::android()->PushAccountList($deviceType, $accountList, $message); Xinge::ios()->PushSingleDevice($deviceToken, $message, $environment = 0); Xinge::ios()->PushSingleAccount($deviceType, $account, $message, $environment = 0); Xinge::ios()->PushAllDevices($deviceType, $message, $environment = 0); Xinge::ios()->PushTags($deviceType, $tagList, $tagsOp, $message, $environment = 0); Xinge::ios()->PushAccountList($deviceType, $accountList, $message, $environment = 0);
License
The MIT License (MIT). Please see License File for more information.