antonioprimera/laravel-slack

此包已被弃用且不再维护。未建议替代包。

用于向Slack发送消息的工具

v1.1 2021-10-29 12:31 UTC

This package is auto-updated.

Last update: 2024-01-29 04:13:24 UTC


README

此包允许用户直接向Slack发送消息。它是Slack API的包装器,提供了流畅(类似Laravel)的方法调用。

安装

步骤 1. 使用Composer安装包

composer require antonioprimera/laravel-slack

步骤 2. 设置Slack WebHook并复制webhook URL。

如果您不知道如何操作,请参阅此文章:https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack

步骤 3. 在您的.env文件中创建一个包含webhook URL的环境变量。

SLACK_WEBHOOK_URL="https://hooks.slack.com/services/.../.../..."

步骤 4. 就这些。您现在可以开始向Slack发送消息了。

使用方法

您可以使用AntonioPrimera\Slack\Slack类上的一个静态方法,或者您自己实例化一个AntonioPrimera\Slack\SlackClient。我推荐第一种方法,以下将举例说明。

最基本的使用方法是将一条简单消息发送到默认通道,该通道是在定义Webhook URL时选择的。为此,您可以使用post方法。

use AntonioPrimera\Slack\Slack;

Slack::post('This is the most basic usage, and will post a message to Slack');

您可以为消息添加多个选项,以确定其发送位置、发送者名称、emoji等。以下示例将向“#my-channel”通道发送消息,消息来自用户“Antonio”,并将消息emoji设置为":happy-face:"。

use AntonioPrimera\Slack\Slack;

Slack::channel('my-channel')
    ->from('Antonio')
    ->emoji('happy-face')
    ->post('Hello Slack!');

您还可以通过以下两种方式之一向用户发送私信:

use AntonioPrimera\Slack\Slack;

Slack::channel('james', true)
    ->from('Antonio')
    ->post('Hello James!');

Slack::from('Antonio')
    ->directMessage('james', 'Hello James!');

未来开发

在未来版本中,我计划包括以下内容:

  • 可选地定义.env文件中的默认Slack通道
  • 可选地定义.env文件中的默认发送者
  • 可选地定义.env文件中的默认emoji
  • 向多个通道和/或用户发送消息
  • 有条件地向多个通道和/或用户发送消息