README

这是一个适用于 Laravel 4 和 5 的 HipChat PHP 客户端包装器

安装

在 composer.json 文件的 "require" 部分中包含 "hernandev/hipchat-laravel"

    ...
    "require": {
        ...,
        "hernandev/hipchat-laravel": "~2.0"
    }
    ...

运行以下命令更新 composer 依赖项：
```
composer update
```
在 app/config/app.php 文件的 'providers' 数组中插入 'Hernandev\HipchatLaravel\HipchatLaravelServiceProvider',
```
...
'providers' => [
    ...
    Hernandev\HipchatLaravel\HipchatLaravelServiceProvider::class,
],
```

在 app/config/app.php 文件的 'aliases' 数组中插入 'HipChat' => Hernandev\HipchatLaravel\Facade\HipChat:class,

...
'aliases' => [
    ...
    'HipChat'         => Hernandev\HipchatLaravel\Facade\HipChat::class,
],

要发布所需的配置文件，请运行：
```
php artisan vendor:publish --tag=laravel
```

编辑 app/config/hipchat.php 文件，更新您的凭据/配置

'api_token' => 'insert_your_api_token',
'app_name' => 'Your App Name',
'default_room' => null, // this is optional

用法

注意：当在配置文件中设置了 'default_room' 时，不需要调用 ::setRoom('room_name')，仅在需要与不是默认房间的工作时使用。

在房间中通知

HipChat::setRoom('RoomName');
HipChat::sendMessage('My Message');

// you have two optional parameters, `color` and `notify`
// the 'red' will set the message color, and the third parameter when `true` notify all users on the room

HipChat::sendMessage('My Message', 'red', true);

获取房间详情

HipChat::setRoom('RoomName');
HipChat::getRoom(); // StdObject

验证房间是否存在

HipChat::setRoom('RoomName');
HipChat::roomExists(); // boolean

获取房间列表
```
HipChat::getRooms(); // json
```

获取房间消息历史记录

HipChat::setRoom('RoomName');
return HipChat::getRoomsHistory(); // json

更改房间主题

HipChat::setRoom('RoomName');
return HipChat::setRoomTopic('New Topic via API'); // boolean

获取用户列表
```
HipChat::getUsers(); // json
```

获取用户详情

HipChat::setUser('me@me.com'); // you can use id, email or @mention_name
HipChat::getUser(); // StdObject

创建房间

HipChat::setUser('me@me.com'); // you can use id, email or @mention_name
// see optional fields on code
HipChat::createRoom('New Room Name'); // boolean

获取用户列表
```
HipChat::getUsers(); // json
```

删除房间

HipChat::setRoom('RoomName');
HipChat::deleteRoom(); // boolean

创建用户

// email, first_name last_name, mention_name, title
HipChat::createUser('me2@me2.com', 'First Last', 'mention', 'title'); // boolean

更新用户信息

 // you can use email, mention name or user_id
HipChat::setUser('me@me.com');

// same signature as create_user method, pass null the fields you dont want to update
HipChat::updateUser(null, 'NewFirst New Last'); // boolean

hernandev / hipchat-laravel

维护者

详细信息

README

安装

用法