README

此包使您能够使用 Laravel 5.6 简单地通过 Intercom 发送通知。

已放弃

当前项目已放弃。请现在使用来自 laravel-notification-channels/intercom 的官方发布版。

如何迁移？

• 更新您的 composer.json：将 "ftw-soft/intercom-notification-channel": "*" 更改为 "laravel-notification-channels/intercom": "^1.0"
• 在您的项目目录中运行 $ composer update
• 在您的整个项目中替换所有对 FtwSoft\NotificationChannels 的引用到 NotificationChannels
• ...
• 搞定！

内容

• 安装
  • 设置 Intercom 服务
• 用法
  • 可用的消息方法
• 变更日志
• 测试
• 安全性
• 贡献
• 致谢
• 许可证

安装

您可以通过 composer 安装此包

composer require ftw-soft/intercom-notification-channel

设置 Intercom 服务

安装完成后，您需要将服务提供者注册到应用程序中。打开 config/app.php 并找到 providers 键。

'providers' => [

    \FtwSoft\NotificationChannels\Intercom\IntercomServiceProvider::class,

]

将以下内容放入您的 config/services.php

'intercom' => [
    'token' => env('INTERCOM_API_KEY')
]

将您的 Intercom Token 添加到 .env

INTERCOM_API_KEY=xxx

用法

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

use FtwSoft\NotificationChannels\Intercom\Contracts\IntercomNotification;
use FtwSoft\NotificationChannels\Intercom\IntercomChannel;
use FtwSoft\NotificationChannels\Intercom\IntercomMessage;
use Illuminate\Notifications\Notification;

class TestNotification extends Notification implements IntercomNotification
{
    public function via($notifiable)
    {
        return ["intercom"];
    }

    public function toIntercom($notifiable): IntercomMessage
    {
        return IntercomMessage::create("Hey User!")
            ->from(123)
            ->toUserId(321);
    }
}

可用方法

• body(''): 接受一个字符串值作为 Intercom 消息正文
• email(): 接受一个字符串值作为 Intercom 消息类型 email
• inapp(): 接受一个字符串值作为 Intercom 消息类型 inapp（默认）
• subject(''): 接受一个字符串值作为 Intercom 消息正文（使用与 email 类型一起）
• plain(): 接受一个字符串值作为 Intercom 消息纯模板
• personal(): 接受一个字符串值作为 Intercom 消息个人模板
• from('123'): 接受一个字符串值作为管理员的 id（发送者）
• to(['type' => 'user', 'id' => '321']): 接受一个数组值作为收件人数据
• toUserId(''): 接受一个字符串值作为通过 id 的 Intercom 消息的收件人
• toUserEmail(''): 接受一个字符串值作为通过电子邮件的 Intercom 消息的收件人
• toContactId(''): 接受一个字符串值作为通过 id 的 Intercom 消息的联系人收件人

有关字段的更多信息，请参阅 Intercom API 参考

变更日志

请参阅变更日志获取更多关于最近更改的信息。

测试

$ composer test

安全

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

贡献

有关详细信息，请参阅贡献指南。

致谢

• Andrey Telesh
• 所有贡献者

许可协议

MIT 许可协议 (MIT)。有关更多信息，请参阅许可文件。