Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freyo/xinge
📲 Tencent Xinge PHP SDK for Laravel
https://github.com/freyo/xinge
laravel tencent-xinge xgpush xinge
Last synced: 3 months ago
JSON representation
📲 Tencent Xinge PHP SDK for Laravel
- Host: GitHub
- URL: https://github.com/freyo/xinge
- Owner: freyo
- License: mit
- Created: 2017-07-22T03:28:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-03T07:18:49.000Z (over 6 years ago)
- Last Synced: 2024-10-04T10:41:49.726Z (4 months ago)
- Topics: laravel, tencent-xinge, xgpush, xinge
- Language: PHP
- Homepage: http://xg.qq.com
- Size: 35.2 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tencent Xinge PHP SDK for Laravel
[](https://packagist.org/packages/freyo/xinge)
[](LICENSE.md)
[](https://packagist.org/packages/freyo/xinge)
腾讯移动推送（XinGe Push，即 XGPush）
This package makes it easy to send notifications using Tencent Xinge with Laravel.
## Installation
You can install this package via composer:
``` bash
composer require freyo/xinge
```
Next add the service provider and facade to your `config/app.php`:
```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](http://xg.qq.com/) 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:
```php
...
'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](https://laravel.com/docs/notifications) to add the channel to your Notification class.
Example: [AndroidPushSingleAccount](https://github.com/freyo/xinge/blob/master/src/Notifications/AndroidPushSingleAccount.php), [iOSPushSingleAccount](https://github.com/freyo/xinge/blob/master/src/Notifications/iOSPushSingleAccount.php).
#### Facade
```php
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);
```
[FULL API DOCUMENT](http://docs.developer.qq.com/xg/server_api/rest.html)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.