README

简介

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

安装

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

composer require MichelMelo/onesignal-laravel

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

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

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

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

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

最后，再次从命令行运行 php artisan vendor:publish 以发布默认配置文件。这将发布一个名为 onesignal.php 的配置文件，其中包含您的 OneSignal 授权密钥。

配置

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

用法

向所有用户发送通知

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

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

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

向特定用户发送通知

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

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

$userId 是用户注册通知的唯一的 ID。有关详细信息，请参阅 https://documentation.onesignal.com/docs/website-sdk-api#getUserId。 $url、$data 和 $buttons 字段是特例。如果您提供 $url 参数，用户将被重定向到该 URL。

向特定段发送通知

您可以使用以下方式简单地向特定段发送通知

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

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

发送自定义通知

您可以使用以下方式发送自定义消息

OneSignal::sendNotificationCustom($parameters);

请参阅 https://documentation.onesignal.com/docs/notifications-create-notification 了解所有可定制的参数。