README

简介

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

安装

首先，您需要使用 Composer 引入此包

composer require vtmdev/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 --provider="Berkayk\OneSignal\OneSignalServiceProvider" --tag="config"

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

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

配置

您需要在 .env 文件中填写 OneSignal 的 App ID 和 REST API 密钥，如下所示

ONESIGNAL_APP_ID=xxxxxxxxxxxxxxxxxxxx
ONESIGNAL_REST_API_KEY=xxxxxxxxxxxxxxxxxx

您可以通过在 .env 文件中添加以下内容来控制 OneSignalClient 使用的 Guzzle 客户端超时时间

ONESIGNAL_GUZZLE_CLIENT_TIMEOUT=integer_value

当您计划通过 Laravel 队列发送推送通知时，此参数很有用

用法

向所有用户发送通知

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

    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" => "tag", "key" => "email", "relation" => "=", "value" => "email21@example.com"],
            ["field" => "tag", "key" => "email", "relation" => "=", "value" => "email1@example.com"],
            ...
        ),
        $url = null,
        $data = null,
        $buttons = null,
        $schedule = null
    );

示例 2

    OneSignal::sendNotificationUsingTags(
        "Some Message",
        array(
            ["field" => "tag", "key" => "session_count", "relation" => ">", "value" => '2'],
            ["field" => "tag", "key" => "first_session", "relation" => ">", "value" => '2000'],
        ),
        $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/add-user-data-tags 获取更多详细信息。$url、$data、$buttons 和 $schedule 字段是特例。如果您提供 $url 参数，则用户将被重定向到该 URL。

向特定外部用户（用户添加的自定义用户 ID）发送通知

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

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

$userId 是用户注册通知的唯一的用户外部 ID（用户添加的自定义 ID）。阅读 https://documentation.onesignal.com/docs/add-user-data-tags 获取更多详细信息。$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);

发送异步自定义通知

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

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

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

示例

有些人发现示例令人困惑，因此我将提供一些我在应用程序中使用的详细示例。这些示例可能会指导您如何自定义通知。有关自定义参数，请参阅 https://documentation.onesignal.com/reference/create-notification。

1) 向带有自定义图标和自定义图标颜色的段发送消息

在发送通知之前，您需要自定义 android_accent_color 和 small_icon 的值。这些是在发送通知时需要指定的 参数。

use OneSignal;

$params = [];
$params['android_accent_color'] = 'FFCCAA72'; // argb color value
$params['small_icon'] = 'ic_stat_distriqt_default'; // icon res name specified in your app

$message = "Test message to send";
$segment = "Testers";
OneSignal::addParams($params)->sendNotificationToSegment(
                $message,
                $segment
            );

// or to all users 
OneSignal::addParams($params)->sendNotificationToAll($message);

2. 以高优先级发送消息

这次，我们将逐个指定参数。

use OneSignal;

$message = "Test message to send";
$segment = "Testers";
OneSignal::setParam('priority', 10)->sendNotificationToSegment(
                $message,
                $segment
            );

// You can chain as many parameters as you wish

OneSignal::setParam('priority', 10)->setParam('small_icon', 'ic_stat_onesignal_default')->setParam('led_color', 'FFAACCAA')->sendNotificationToAll($message);

3. 发送带有自定义标题和副标题的消息

use OneSignal;

OneSignal::sendNotificationToSegment(
                "Test message with custom heading and subtitle",
                "Testers", 
                null, null, null, null, 
                "Custom Heading", 
                "Custom subtitle"
            );

4. 向具有许多自定义参数的特定用户发送延迟消息

use OneSignal;

$userId = "3232331-1722-4fee-943d-23123asda123"; 
$params = []; 
$params['include_player_ids'] = [$userId]; 
$contents = [ 
   "en" => "Some English Message", 
   "tr" => "Some Turkish Message"
]; 
$params['contents'] = $contents; 
$params['delayed_option'] = "timezone"; // Will deliver on user's timezone 
$params['delivery_time_of_day'] = "2:30PM"; // Delivery time

OneSignal::sendNotificationCustom($params);

vtmdev / onesignal-laravel

维护者

详情