README

感谢 berkayk 开发此包

简介

这是一个简单的 OneSignal 包装库，用于 Laravel。它通过定义的方法简化了基本的通知流程。您可以向所有用户发送消息，也可以通知单个用户。在开始安装此服务之前，请先在 https://onesignal.com 完成您的 OneSignal 设置，并完成所有必要的步骤以获取应用程序 ID 和 REST API 密钥。

安装

首先，您需要使用 Composer 需求此包

composer require stojankukrika/onesignal-laravel

然后，从您的命令行运行 composer update。

然后，通过在 config/app.php 中添加服务提供者条目来更新它。

'providers' => [
	// ...
	stojankukrika\OneSignal\OneSignalServiceProvider::class
];

然后，通过在别名部分添加条目来注册类别名

'aliases' => [
	// ...
	'OneSignal' => stojankukrika\OneSignal\OneSignalFacade::class
];

最后，再次从命令行运行以下命令

php artisan vendor:publish --tag=config

以发布默认配置文件。这将发布一个名为 onesignal.php 的配置文件，其中包含您的 OneSignal 授权密钥。

注意：如果前面的命令未能成功发布配置文件，请检查涉及 提供者 和 别名 的步骤，这些步骤在 config/app.php 文件中。

配置

您需要填写位于您应用程序 config 目录中的 onesignal.php 文件。 app_id 是您的 OneSignal 应用程序 ID，rest_api_key 是您的 REST API 密钥。如果您想设置图标颜色，可以设置 icon_color。

用法

向所有用户发送通知

您可以使用以下命令轻松地向所有注册用户发送消息

OneSignal::sendNotificationToAll("Some Message", $url = null, $data = null, $buttons = null, $schedule = null);

$url、$data、$buttons 和 $schedule 字段是特例。如果您提供 $url 参数，则用户将被重定向到该 URL。

根据标签/过滤器发送通知

您可以使用以下命令根据一组标签发送消息

#####示例 1: OneSignal::sendNotificationUsingTags("Some Message", array(["field" => "email", "relation" => "=", "value" => "someone@example.com"]), $url = null, $data = null, $buttons = null, $schedule = null);

#####示例 2: OneSignal::sendNotificationUsingTags("Some Message", array(["field" => "session_count", "relation" => ">", "value" => '2']), $url = null, $data = null, $buttons = null, $schedule = null);

向特定用户发送通知

在将用户的令牌存储在表中后，您可以使用以下命令发送消息

OneSignal::sendNotificationToUser("Some Message", $userId, $url = null, $data = null, $buttons = null, $schedule = null);

$userId 是用户注册通知的唯一 ID。请阅读 https://documentation.onesignal.com/docs/web-push-tagging-guide 获取更多信息。$url、$data、$buttons 和 $schedule 字段是特例。如果您提供 $url 参数，则用户将被重定向到该 URL。

向特定段发送通知

您可以使用以下命令向特定段发送通知

OneSignal::sendNotificationToSegment("Some Message", $segment, $url = null, $data = null, $buttons = null, $schedule = null);

$url、$data、$buttons 和 $schedule 字段是特例。如果您提供 $url 参数，则用户将被重定向到该 URL。

发送自定义通知

您可以使用以下命令发送自定义消息

OneSignal::sendNotificationCustom($parameters);

### Sending a Custom Notification

发送异步自定义通知

您可以使用以下命令发送异步自定义消息

OneSignal::async()->sendNotificationCustom($parameters);

请参阅 https://documentation.onesignal.com/reference 了解所有可定制的参数。

创建玩家（将用户添加到 OneSignal）

您可以使用以下请求发送

OneSignal::createPlayer($parameters);

请参阅https://documentation.onesignal.com/reference#add-a-device获取所有可自定义参数。

编辑玩家（在OneSignal中编辑用户）

您可以发送请求editPlayer（在数组$parameters中添加带有'id'参数的值）

OneSignal::editPlayer($parameters);

请参阅https://documentation.onesignal.com/reference#edit-device获取所有可自定义参数。

查看设备

您可以使用以下请求发送

OneSignal::getPlayer($device_id);

请参阅https://documentation.onesignal.com/reference#view-device获取所有可自定义参数。

获取所有玩家（OneSignal中的用户）

您可以使用以下请求发送

OneSignal::getAllPlayers($limit, $offset);

请参阅https://documentation.onesignal.com/reference#view-devices获取所有可自定义参数。