tschucki/laravel-notification-channel-pr0gramm

Laravel 通知驱动程序,用于 Pr0gramm。

0.0.1 2024-01-14 15:20 UTC

This package is auto-updated.

Last update: 2024-09-14 16:50:08 UTC


README

Latest Version on Packagist Software License StyleCI Total Downloads

此包通过 Laravel 轻松发送通知到 Pr0gramm 用户。

内容

安装

您可以通过 composer 安装此包

composer require tschucki/laravel-notification-channel-pr0gramm

接下来,如果您不使用自动发现,则必须加载服务提供者

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

设置 Pr0gramm 服务

建议使用机器人账户的凭证,因为您将无法解决所需的验证码。您可以在此处了解更多关于 Pr0gramm-API 和如何获取凭证的信息。

接下来,您必须在 config/services.php 中添加您的 Pr0gramm 凭证

// config/services.php
'pr0gramm' => [
	'username' => env('PR0GRAMM_USERNAME'),
	'password' => env('PR0GRAMM_PASSWORD'),
],

使用方法

在您希望通过 Pr0gramm 通知的每个模型中,您必须添加一个返回 Pr0gramm 上用户名称的 getPr0grammName 方法。

// app/Models/User.php
public function getPr0grammName(): string
{
	return $this->pr0grammName;
}

现在您可以在通知中的 via() 方法中使用此通道(您也可以使用 'pr0gramm' 作为通道名称)

use NotificationChannels\Pr0gramm\Pr0grammChannel;

public function via($notifiable)
{
	return [Pr0grammChannel::class];
}

接下来,您必须在通知中添加一个 toPr0gramm 方法,其中包含您希望发送给用户的消息

public function toPr0gramm($notifiable): string
{
	return 'Message from Laravel';
}

注意 - 速率限制:由于发送消息的速率限制相当低,您可能会遇到 Pr0grammRateLimitReached-Exception。

您可以通过 try catch 块处理此异常,或者在使用队列驱动程序时添加 failed 方法

好了,您就可以开始了!

变更日志

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

测试

$ composer test

安全

如果您发现任何安全相关的问题,请通过电子邮件info@marcelwagner.dev联系,而不是使用问题跟踪器。

贡献

有关详细信息,请参阅CONTRIBUTING

致谢

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅许可证文件