lucasformiga/discord-notification-channel

Laravel 的 Discord 通知频道。

dev-master 2020-03-05 21:47 UTC

This package is auto-updated.

Last update: 2024-09-06 07:17:47 UTC


README

Total Downloads Latest Stable Version License

摘要

安装

您可以使用 composer 安装此包

composer require lucasformiga/discord-notification-channel

安装包后,您需要您的频道的 webhook URL。 这篇文章将帮助您 在 Discord 频道中设置和添加 webhook 连接器。

设置连接器

// config/services.php
'discord' => [
    'notification_webhook' => env('DISCORD_NOTIFICATION_WEBHOOK')
],

此外,您需要在 .env 文件中添加 DISCORD_NOTIFICATION_WEBHOOK 以及之前生成的 webhook url。确保您的 .env.example 与 .env 变量同步。

使用

现在,您可以将此包用作通知的通道,只需在 via() 方法中将返回值更改为 ['discord']

可用方法

  • content() 方法将接收一个字符串并添加文本到您的消息中。
  • name() 方法将接收一个字符串并更改消息的用户名。
  • avatar() 方法将接收一个字符串作为 URL 并更改消息的用户头像。
  • isTts():您也可以发送语音消息!
  • card() 方法将接收两个必需的字符串作为参数,第一个参数将是卡片标题,第二个参数将是卡片内容。其他三个参数将是颜色、作者和页脚。(如果您想添加作者和页脚,请遵循此指南:嵌入作者结构 嵌入页脚结构)。您只能添加 10 张卡片(包括信息、成功、警告和危险卡片)。
  • info() 方法将接收两个必需的字符串作为参数,第一个参数将是卡片标题,第二个参数将是卡片内容。其他两个参数将是作者和页脚。
  • success() 方法将接收两个必需的字符串作为参数,第一个参数将是卡片标题,第二个参数将是卡片内容。其他两个参数将是作者和页脚。
  • warning() 方法将接收两个必需的字符串作为参数,第一个参数将是卡片标题,第二个参数将是卡片内容。其他两个参数将是作者和页脚。
  • danger() 方法将接收两个必需的字符串作为参数,第一个参数将是卡片标题,第二个参数将是卡片内容。其他两个参数将是作者和页脚。

可用颜色

  • 浅蓝
  • 绿
  • 深灰
  • 海军蓝
  • 深浅蓝
  • 深绿
  • 深蓝
  • 深紫
  • 深金
  • 深橙
  • 深红
  • 深灰
  • 亮灰
  • 深海军蓝
  • 亮粉
  • 深粉

只需使用 DiscordMessage::COLOR 与您的卡片方法。

贡献

许可证

Discord Notification Channel 是开源软件,受 MIT 许可证 许可。