README

基于 gorkalaucirica/HipchatAPIv2Client

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

此软件包处于开发中，某些功能尚不可用。

安装

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

composer require solutiondrive/hipchat-v2-api-client

用法

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

use SolutionDrive\HipchatAPIv2Client\Auth\OAuth2;
use SolutionDrive\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 SolutionDrive\HipchatAPIv2Client\API\UserAPI;

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

获取所有房间

use SolutionDrive\HipchatAPIv2Client\API\RoomAPI;

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

当前状态

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

附加组件/集成

功能

获取功能

表情符号

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

OAuth 会话

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

房间

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

用户

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

solutiondrive / hipchat-v2-api-client

维护者

详细信息