README

此包使您能够通过 Laravel 使用 Intercom 发送通知。

内容

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

安装

您可以通过 composer 安装此包。

composer require laravel-notification-channels/intercom

设置 Intercom 服务

将以下内容添加到您的 config/services.php

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

将您的 Intercom Token 添加到 .env

INTERCOM_API_KEY=xxx

使用方法

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

use NotificationChannels\Intercom\IntercomChannel;
use NotificationChannels\Intercom\IntercomMessage;
use Illuminate\Notifications\Notification;

class TestNotification extends Notification
{
    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）。有关更多信息，请参阅 许可证文件