README

此库未维护。请查看 solutionDrive 的分支。

PHP 库，用于处理对 Hipchat v2 REST API 的调用

此包仍在开发中，某些功能尚不可用。

安装

推荐通过 Composer 安装 Hipchatv2ApiClient。要安装此库，请运行以下命令并获取最新版本：

composer require gorkalaucirica/hipchat-v2-api-client

用法

所有查询都需要以下两行。第一行用于验证您的身份，第二行创建一个客户端，API 类使用该客户端执行 API 请求。现在，请查看 API 调用部分以了解如何使用 $client 向 API 发送请求。

use GorkaLaucirica\HipchatAPIv2Client\Auth\OAuth2;
use GorkaLaucirica\HipchatAPIv2Client\Client;

$auth = new OAuth2('tokenYouCanGetInHipchatSite');
$client = new Client($auth);

私有实例客户端

从版本 1.5.0 开始，您可以在构造函数中设置 URL 以更改客户端使用的基 URL（默认为 https://api.hipchat.com）。

$client = new Client($auth, null, 'https.//api.yourdomain.com');

API 调用

所有 API 调用方法都位于 API 文件夹中。所有方法都已记录，并链接到 Hipchat v2 API 文档。以下是一些示例：

通过提及名称获取用户

use GorkaLaucirica\HipchatAPIv2Client\API\UserAPI;

$userAPI = new UserAPI($client);
$user = $userAPI->getUser('@gorkalaucirica');

获取所有房间

use GorkaLaucirica\HipchatAPIv2Client\API\RoomAPI;

$roomAPI = new RoomAPI($client);
$room = $roomAPI->getRooms(array('max-results' => 30));

当前状态

以下列表显示了可用的方法和缺失的方法

附加组件

• 获取可安装的附加组件数据
• 创建附加组件链接
• 调用附加组件链接
• 删除附加组件链接

能力

• 获取能力

表情符号

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

OAuth 会话

• 生成令牌
• 获取会话
• 删除会话

房间

• 获取所有房间
• 创建房间
• 获取房间
• 更新房间
• 删除房间
• 获取头像
• 更新头像
• 删除头像
• 获取房间消息
• 查看房间历史记录
• 查看最近的房间历史记录
• 邀请用户
• 添加成员
• 移除成员
• 获取所有成员
• 发送消息
• 发送房间通知
• 获取所有参与者
• 回复消息
• 与房间共享文件
• 获取房间统计信息
• 设置主题
• 获取 webhook
• 删除 webhook
• 获取所有 webhook
• 创建 webhook

用户

• 获取所有用户
• 创建用户
• 查看用户
• 更新用户
• 删除用户
• 获取私密聊天消息
• 查看最近的私密聊天历史记录
• 向用户发送私密消息
• 获取照片
• 上传照片
• 删除照片
• 获取自动加入的房间
• 与用户共享文件
• 与用户共享链接