README

这是一个简单的 PHP 库，旨在帮助集成 HipChat v2 API。此库可用于网站和创建 HipChat 插件。

安装

composer require mlinek/hipchat-v2-php

用法

实例化库

// Authorization method
$auth = new Bearer("<your access token>");

// HTTP client, implements HttpInterface, you can create your own implementation if you wish
$guzzle = new Guzzle("https://api.hipchat.com/");

// Client will configure the library on instantiation
$client = new ClientV2($auth, $guzzle);

加载房间

// Make API call to load all rooms
$rooms = $client->rooms()->loadAll();

// Display first room name
echo $rooms[0]->name;

加载用户

// Make API call to load all users
$users = $client->users()->loadAll();
echo $users[0]->mentionName; // mention_name is correct as well 

通过房间 ID 加载房间参与者

// Instantiate Room model and set it's id to existing room's id
$room = new Room(['id' => 123]);

// Make API call to retrieve room's participants
$participants = $room->participants();

// Iterate over participants collection
foreach ($participants as $participant) {
    // $participant is a User model
    echo $participant->mentionName . ", ";
}

端点状态

功能

• 获取功能 ✔
• 获取插件功能模式 ✔

表情符号

• 获取表情符号 ✔
• 获取所有表情符号 ✔

扩展

• 获取/创建/删除全局操作 ✘
• 获取/创建/删除全局对话框 ✘
• 获取/创建/删除全局外部页面 ✔
• 获取/创建/删除全局预览 ✘
• 获取/创建/删除全局网络面板 ✘
• 获取/创建/删除全局 webhook ✘

组

• 查看组 ✔
• 获取组头像 ✔
• 更新/删除组头像 ✘
• 组统计信息 ✔

集成

• 获取可安装的集成数据 ✘
• 调用/创建/删除集成链接 ✘
• 插件 UI 更新 ✘
• 房间插件 UI 更新 ✘
• 用户在房间中的插件 UI 更新 ✘
• 用户插件 UI 更新 ✘

邀请

• 邀请用户到组 ✘

OAuth 会话

• 获取/删除会话 ✘
• 生成令牌 ✔

公共偏好设置

• 获取自动加入的房间 ✘

房间

• 获取/更新/删除房间 ✔
• 获取所有房间 ✔
• 获取/创建/删除房间动作 ✘
• 获取/创建/删除房间对话框 ✘
• 获取/创建/删除房间外部页面 ✔
• 获取/创建/删除房间预览 ✘
• 获取/创建/删除房间网络面板 ✘
• 获取/创建/删除房间 webhook ✔
• 获取房间消息 ✔
• 查看房间历史记录 ✔
• 查看最近房间历史记录 ✔
• 邀请用户 ✔
• 添加/删除成员 ✔
• 获取所有成员 ✔
• 发送消息 ✔
• 发送房间通知 ✔
• 获取所有参与者 ✔
• 回复消息 ✔
• 与房间共享文件 ✔
• 与房间分享链接 ✔
• 获取房间统计数据 ✔
• 设置主题 ✔
• 获取所有webhooks ✔
• 获取/创建/删除webhook ✔

用户

• 获取所有用户 ✔
• 创建/查看/更新/删除用户 ✔
• 获取私聊消息 ✔
• 查看私聊历史记录 ✔
• 查看最近的私聊历史记录 ✔
• 给用户发送私信 ✔
• 获取/更新/删除照片 ✘
• 获取自动加入的房间 ✘
• 与用户分享文件 ✔
• 与用户分享链接 ✔