laravel-notification-channels/gitter

Laravel 的 Gitter 通知通道

维护者

详细信息

github.com/laravel-notification-channels/gitter

主页

源代码

问题

安装次数: 188

依赖者: 0

建议者: 0

安全: 0

星标: 10

关注者: 5

分支: 3

开放问题: 0

v2.2.0 2020-09-12 05:35 UTC

Requires

Requires (Dev)

MIT 10d5c346f06def4e095c8a568f91929d2410171c

  • JhaoDa <jhaoda.woop@gmail.com>

notificationslaravelgitter.im

This package is auto-updated.

Last update: 2024-09-12 13:57:43 UTC

README

Latest Version on Packagist Software License Build Status StyleCI SensioLabsInsight Quality Score Code Coverage Total Downloads

此包简化了使用 Gitter.im 在 Laravel 5.5+、6.x 和 7.x 中发送通知的过程。

内容

安装

使用 Composer 安装此包

composer require laravel-notification-channels/gitter

如果你使用的是 Laravel 5.x，你还需要指定版本约束

composer require laravel-notification-channels/gitter -v 1.0.1

设置 Gitter 服务

为了向 Gitter 房间发送消息，你需要获取个人访问令牌或应用程序令牌。

用法

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

use Illuminate\Notifications\Notification;
use NotificationChannels\Gitter\GitterMessage;
use NotificationChannels\Gitter\GitterChannel;

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

    public function toGitter($notifiable)
    {
        return GitterMessage::create("Task #{$notifiable->id} is complete!")
            ->room('room_id') // optional
            ->from('user_or_app_access_token');
    }
}

为了让通知知道你要针对哪个 Gitter 房间，将 routeNotificationForGitter 方法添加到你的 Notifiable 模型中

public function routeNotificationForGitter()
{
    return 'room_id';
}

可用方法

from(): 设置发送者的访问令牌。

room(): 指定要发送通知到的房间 ID（如果为空，则会被 routeNotificationForGitter 覆盖）。

content(): 设置通知消息的内容。支持 Github 风格的 markdown。

变更日志

请参阅变更日志以获取更多信息。

测试

$ composer test

安全

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

贡献

请参阅贡献指南以获取详细信息。

致谢

许可

MIT 许可证 (MIT)。请参阅许可文件以获取更多信息。