README

简介

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

安装

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

composer require berkayk/onesignal-laravel

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

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

然后，更新 config/app.php 文件，添加服务提供者的条目。

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

然后，在别名部分添加一个条目以注册类别名

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

最后，再次从命令行运行

php artisan vendor:publish --tag=config

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

注意：如果上一个命令未能成功发布配置文件，请检查 config/app.php 文件中涉及 providers 和 aliases 的步骤。

配置

您需要填写位于您的应用程序 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。

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

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

示例 1

    OneSignal::sendNotificationUsingTags(
        "Some Message",
        array(
            ["key" => "email", "relation" => "=", "value" => "email21@example.com"],
            ["key" => "email", "relation" => "=", "value" => "email1@example.com"],
            ...
        ),
        $url = null,
        $data = null,
        $buttons = null,
        $schedule = null
    );

示例 2

    OneSignal::sendNotificationUsingTags(
        "Some Message",
        array(
            ["key" => "session_count", "relation" => ">", "value" => '2'],
            ["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/web-push-tagging-guide。 $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/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);

发送异步自定义通知

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

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

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

依赖云/ onesignal-laravel

维护者

详细信息