README

简介

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

安装

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

composer require berkayk/onesignal-laravel

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

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

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

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

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

最后，再次从命令行运行

php artisan vendor:publish --tag=config

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

注意：如果之前的命令没有成功发布配置文件，请检查涉及 providers 和 aliases 的 config/app.php 文件中的步骤。

配置

您需要填写您的应用程序 config 目录中找到的 onesignal.php 文件。app_id 是您的 OneSignal 应用 ID，而 rest_api_key 是您的 REST API 密钥。

用法

向所有用户发送通知

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

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

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

基于标签/过滤器发送通知

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

OneSignal::sendNotificationUsingTags("Some Message", array("key" => "device_uuid", "relation" => "=", "value" => 123e4567-e89b-12d3-a456-426655440000), $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 了解所有可自定义参数。