README

此包使您能够通过Laravel 5.3+轻松发送OneSignal通知。

内容

安装
- 设置您的OneSignal账户
用法
变更日志
测试
安全
贡献
致谢
许可协议

安装

您可以通过composer安装此包。

$ composer require laravel-notification-channels/onesignal

如果您在Laravel 5.4或更低版本中安装此包，则必须导入服务提供者。

// config/app.php
'providers' => [
    ...
    NotificationChannels\OneSignal\OneSignalServiceProvider::class,
],

设置您的OneSignal账户

将OneSignal App ID和REST API密钥添加到您的config/services.php中。

// config/services.php
...
'onesignal' => [
    'app_id' => env('ONESIGNAL_APP_ID'),
    'rest_api_key' => env('ONESIGNAL_REST_API_KEY')
],
...

用法

现在您可以在通知中的via()方法中使用该通道。

use NotificationChannels\OneSignal\OneSignalChannel;
use NotificationChannels\OneSignal\OneSignalMessage;
use NotificationChannels\OneSignal\OneSignalWebButton;
use Illuminate\Notifications\Notification;

class AccountApproved extends Notification
{
    public function via($notifiable)
    {
        return [OneSignalChannel::class];
    }

    public function toOneSignal($notifiable)
    {
        return OneSignalMessage::create()
            ->setSubject("Your {$notifiable->service} account was approved!")
            ->setBody("Click here to see details.")
            ->setUrl('http://onesignal.com')
            ->webButton(
                OneSignalWebButton::create('link-1')
                    ->text('Click here')
                    ->icon('https://upload.wikimedia.org/wikipedia/commons/4/4f/Laravel_logo.png')
                    ->url('https://laravel.net.cn')
            );
    }
}

为了使您的通知知道您正在针对哪些OneSignal用户，请将routeNotificationForOneSignal方法添加到您的可通知模型中。

您可以选择返回一个player-id，或者如果您想通知多个player ID，只需返回包含所有ID的数组。

public function routeNotificationForOneSignal()
{
    return 'ONE_SIGNAL_PLAYER_ID';
}

如果您想根据OneSignal的"syncHashedEmail"功能发送通知，请返回包含索引"email"的数组。由于OneSignal API的限制，无法在一个过滤器中使用多个电子邮件。

public function routeNotificationForOneSignal()
{
    return ['email' => 'example@example.com'];
}

如果您想根据OneSignal的"Tags"功能发送通知，请返回包含索引"tags"的数组。

public function routeNotificationForOneSignal()
{
    return ['tags' => ['key' => 'device_uuid', 'relation' => '=', 'value' => '1234567890-abcdefgh-1234567']];
}

如果您想根据您使用setExternalUserId功能设置的外部用户ID发送通知，这将使您根据Laravel用户ID定位用户变得非常简单。

public function routeNotificationForOneSignal()
{
    return ['include_external_user_ids' => $this->id];
}

所有可用方法

setSubject('')：接受一个字符串值作为标题。
setBody('')：接受一个字符串值作为通知正文。
setIcon('')：接受一个图标url。
setUrl('')：接受一个通知点击事件的url。
webButton(OneSignalWebButton $button)：允许您向通知添加操作按钮（仅适用于Chrome 48+（Web推送））。
button(OneSignalButton $button)：允许您向通知添加按钮（支持iOS 8.0和Android 4.1+设备。图标仅适用于Android）。
setData($key, $value)：允许您为消息有效负载设置额外的数据。有关更多信息，请参阅OneSignal文档。
setParameter($key, $value)：允许您为消息有效负载设置额外的参数，这些参数在REST API中可用。有关更多信息，请参阅OneSignal文档。
setImageAttachments($imageUrl)：允许您设置一个图像作为所有可能的附件OneSignal附件文档。

按钮使用

OneSignalMessage::create()
    ->button(
        OneSignalButton::create('id')
            ->text('button text')
            ->icon('button icon')
    );

WebButton使用

OneSignalMessage::create()
    ->webButton(
        OneSignalWebButton::create('id')
            ->text('button text')
            ->icon('button icon')
            ->url('button url')
    );

变更日志

有关最近更改的更多信息，请参阅CHANGELOG。

测试

$ composer test

安全

如果您发现任何与安全相关的问题，请通过电子邮件m.pociot@gmail.com联系，而不是使用问题跟踪器。

tagmood / onesignal

维护者

详细信息