README

一个用于Laravel 5.x的HipChat API包装器，使用Guzzle实现了一个简单的房间通知接口，设计用于与房间授权令牌一起使用。

由 Simon Hampel 提供。

此包提供了一个简单的Laravel服务提供者和外观，用于我们的基础HipChat通知API包装器包 hampel/hipchat-notify - 请参阅该包的文档以获取如何使用此API包装器的说明。

安装

安装HipChat Notify包的推荐方式是通过 Composer

通过Composer在您的 composer.json 文件中要求此包

:::json
{
    "require": {
        "hampel/hipchat-notify-laravel": "~1.0"
    }
}

运行Composer以更新新的需求。

:::bash
$ composer update

此包是为与Laravel 5框架一起使用而构建的。

打开您的Laravel配置文件 app/config/app.php 并在 $providers 数组中添加服务提供者

:::php
'providers' => array(

    ...

    'HipChat\HipChatServiceProvider'

),

您还可以选择性地在同一文件中的 $aliases 数组中添加别名条目以用于HipChat外观

:::php
"aliases" => array(

	...

	'HipChat'			  => 'HipChat\Facades\HipChat',

),

最后，为了使用HipChat API，您必须使用HipChat管理控制面板生成一个认证令牌，然后指定该令牌和您的房间ID到您的 .env 文件中

:::bash
HIPCHAT_ROOM_AUTH_TOKEN=your_hipchat_auth_token
HIPCHAT_ROOM_ID=your_hipchat_room_id

使用方法

使用Laravel的App外观在您的代码中获取服务提供者的访问权限

:::php
use HipChat\Message;

$hipchat = App::make('hipchat');
$hipchat->send(Message::createText('my notification message'));

... 或者直接使用外观

:::php
HipChat::send(Message::createText('my notification message'));

有关如何使用库的更多详细信息，请参阅 HipChat Notifier 存储库中的使用示例和代码。