mprince/one-signal

Laravel 8+ 对 OneSignal 的包装。

维护者

详情

github.com/mprince2k18/larasignal

源代码

问题

安装: 1

依赖者: 0

建议者: 0

安全: 0

星星: 0

关注者: 2

分支: 0

开放问题: 0

dev-main 2021-10-16 08:57 UTC

Requires

Requires (Dev)

MIT 8b8c094fc6f05135e1e6519affdc51565e503ad1

  • Shailesh Ladumor <shaileshmladumor.woop@gmail.com>

phpnotificationlaravelpushone-signal

This package is auto-updated.

Last update: 2024-09-16 15:03:41 UTC

README

Laravel One Signal 是 Laravel 对 One Signal 的包装。One Signal 是向您的用户发送推送通知的绝佳平台。

由 One Signal 分支而来

内容

安装

使用以下命令安装包：

composer require mprince/one-signal

发布配置文件

运行以下命令发布配置文件：

php artisan vendor:publish --provider="Ladumor\OneSignal\OneSignalServiceProvider"

添加提供者

如果您使用的是低于 Laravel 的版本，请将提供者添加到您的 config/app.php 中的 provider 部分：

Ladumor\OneSignal\OneSignalServiceProvider::class,

添加外观

将外观添加到您的 config/app.php 中的 aliases 部分：

'OneSignal' => \Ladumor\OneSignal\OneSignal::class,

添加 ENV 数据

将您的 API 密钥和 OneSignal 应用 ID 添加到您的 .env 中：

ONE_SIGNAL_APP_ID=XXXXXX-XXXXXX-XXXXXX-XXXXXX  (YOUR APP ID)
ONE_SIGNAL_AUTHORIZE=XXXXXX                    (REST API KEY)
ONE_SIGNAL_AUTH_KEY=XXXXXXX                    (YOUR USER AUTH KEY)

您可以在代码中使用以下方式调用它们：

用法

发送推送通知

要发送推送通知，请通过调用 sendPush 方法：

$fields['include_player_ids'] = ['xxxxxxxx-xxxx-xxx-xxxx-yyyyyyyyy'];
$message = 'hey!! this is test push.!'   

OneSignal::sendPush($fields, $message);

可选地，您可以通过这种方式获取通知的 ID：

$notificationID = OneSignal::sendPush($fields, $message);
echo $notificationID["id"];

取消通知

要取消通知，请通过调用 cancelNotification 方法：

$notificationID = 'xxxxxxxx-xxxx-xxx-xxxx-yyyyyyyyy';

OneSignal::cancelNotification($notificationID);

自定义内容

您可以在字段中自定义内容并传递它。当您传递内容时，message 不必要求

$fields['include_player_ids'] = ['xxxxxxxx-xxxx-xxx-xxxx-yyyyyyyyy'];
$fields['contents'] = array(
                          "en" => 'English Message',
                          "es" => 'Spanish Message',
                      );
OneSignal::sendPush($fields);

获取所有通知

要检索所有通知，请通过调用 getNotifications 方法：

OneSignal::getNotifications();

您可以在此处查看返回的响应格式。

获取单个通知

要检索单个通知，请通过调用带有 id 参数的 getNotification 方法：

OneSignal::getNotification($notificationId);

您可以在此处查看返回的响应格式。

获取所有设备

要检索所有用户设备，请通过调用 getDevices 方法：

OneSignal::getDevices();

您可以在此处查看返回的响应格式。

获取单个设备

要检索单个设备，请通过调用带有 id 参数的 getDevice 方法：

OneSignal::getDevice($deviceId);

您可以在此处查看返回的响应格式。

创建设备

要在您的应用程序中添加设备，请通过调用 addDevice 方法，如果您想在不同应用程序中创建设备，可以在 $fields 数组中指定 app_id。

 $fields = [
        'device_type'  => 0,
        'identifier'   => '7abcd558f29d0b1f048083e2834ad8ea4b3d87d8ad9c088b33c132706ff445f0',
        'timezone'     => '-28800',
        'game_version' => '1.1',
        'device_os'    => '7.0.4',
        'test_type'    => 1,
        'device_model' => "iPhone 8,2",
        'tags'         => array("foo" => "bar")
    ];
    
 return OneSignal::addDevice($fields);

您可以在此处查看支持的参数和指南。

更新设备

要在您的应用程序中更新设备，请通过调用 addDevice 方法，如果您想在不同应用程序中更新设备，可以在 $fields 数组中指定 app_id。

 $fields = [
        'device_type'  => 0,
        'identifier'   => '7abcd558f29d0b1f048083e2834ad8ea4b3d87d8ad9c088b33c132706ff445f0',
        'timezone'     => '-28800',
        'game_version' => '1.1',
        'device_os'    => '7.0.4',
        'test_type'    => 1,
        'device_model' => "iPhone 8,2",
        'tags'         => array("foo" => "bar")
    ];
    
 $playerId = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
    
 return OneSignal::updateDevice($fields, $playerId);

您可以在此处查看支持的参数和指南。

创建分段

注意：需要 ONE-SIGNAL 付费计划

要为您的应用程序添加新的分段，请通过调用 createSegment 方法：

 $fields = [
         'name' => 'iOS, Android, Web',
         "filters" => array("field" => "device_type", "relation" => "=", "value" => "Android"),
     ];

return OneSignal::createSegment($fields);

您可以在此处查看支持的参数和指南。

OneSignal::deleteSegment('YOUR_SEGMENT_ID')

删除段

注意：需要 ONE-SIGNAL 付费计划

您可以在这里找到更多指南。

应用

注意*：认证密钥必须在one-signal.php中设置如何获取认证密钥？

查看应用

查看您当前所有OneSignal应用的详细信息

 $apps = OneSignal::getApps();

您可以在这里查看API响应。

查看应用

通过传递应用ID，查看您当前OneSignal应用或其它应用的详细信息。

 // It's return default site which is configured in config.
 $app = OneSignal::getApp();
 
 // you can specify app id as wel but it's optional
 $app = OneSignal::getApp('YOUR_APP_ID');

您可以在这里查看API响应。

创建应用

创建一个新的OneSignal应用。

 $fields = array(
        'name' => "TestByMe"
    );

 OneSignal::createApp($fields);

您可以在这里查看支持的参数和指南。

更新应用

更新一个新的OneSignal应用。

 $fields = array(
        'name' => "TestByMe"
    );

 OneSignal::updateApp($fields);
 // you can pass second param as a appId if you want to update other app.. default take from config.

您可以在这里查看支持的参数和指南。

用户设备

您可以通过一条命令生成用户设备API，

php artisan one-signal.userDevice:publish

此命令会生成以下文件，

  • UserDeviceAPIController
  • UserDeviceAPIRepository
  • UserDevice (模型)
  • 迁移

另外，不要忘记在api.php文件中添加以下路由。

use App\Http\Controllers\API\UserDeviceAPIController;

  Route::post('user-device/register', [UserDeviceAPIController::class, 'registerDevice']);
  Route::get('user-device/{playerId}/update-status', [UserDeviceAPIController::class, 'updateNotificationStatus']);

变更日志

请在此变更日志中查看。

许可证

MIT许可证（MIT）。请查看许可证文件以获取更多信息。