README

简介

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

安装

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

composer require marcelopetrucio/onesignal-laravel

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

如果您的 Laravel 版本低于 5.5，您需要执行以下操作:

然后，通过在 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 的配置文件，其中包含您的应用程序 ID 和 OneSignal 授权密钥。

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

配置

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

用法

向所有用户发送通知

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

    OneSignal::app("appNumberOne")
        ->message("Some Message")                    
        ->send();

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

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

示例 1

    OneSignal::app("appNumberOne")
        ->message("Some Message") 
        ->filters(
	    array(
	        ["field" => "email", "relation" => "=", "value" => "email21@example.com"],
	        ["field" => "email", "relation" => "=", "value" => "email1@example.com"],
	    )
        )->send();

示例 2

    OneSignal::app("appNumberOne")
        ->message("Some Message") 
        ->filters(
	    array(
	        ["field" => "session_count", "relation" => ">", "value" => '2'],
	        ["field" => "first_session", "relation" => ">", "value" => '2000'],
	    )
        )->send();

向特定用户发送通知

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

    OneSignal::app("app_teste")
        ->message("Some Message") 
        ->includePlayerIds("ID_USER")
        ->send();

ID_USER 是用户注册通知时唯一的用户 ID。有关更多信息，请参阅 https://documentation.onesignal.com/docs/web-push-tagging-guide。

向特定段发送通知

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

    OneSignal::app("app_teste")
    	->message("Some Message") 
    	->includedSegments("SEGMENT")
    	->send();

发送自定义通知

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

    OneSignal::sendNotificationCustom($parameters);

发送自定义通知

发送异步自定义通知

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

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

有关所有可自定义参数的信息，请参阅 https://documentation.onesignal.com/reference。