rhincodon/gitter-api

PHP 包,用于与 Gitter REST API 交互。

1.0.2 2015-09-21 02:40 UTC

This package is not auto-updated.

Last update: 2024-09-28 18:21:23 UTC


README

PHP 包,用于与 Gitter REST API 交互。

Latest Version on Packagist Software License Build Status Total Downloads

安装

通过 Composer

$ composer require rhincodon/gitter-api

使用方法

// Get new gitter instance
$gitter = new GitterApi($token);

// You can change token
$gitter->setToken($token);

// List of rooms for current user
$rooms = $gitter->rooms();

// Get room or join
$room = $gitter->room($roomId|$roomUrl);

// List of room users
$roomUsers = $room->users();

// List of room channels
$roomChannels = $room->channels();

// List of room messages
$roomMessages = $room->messages()->skip(10)->take(5)->before($messageId|$message)->after($messageId|$message)->get();

// Send message to the room
$message = $room->sendMessage($text);

// Update sent message
$message->update($text);

// Get message author
$messageAuthor = $message->author();

// Get message mentioned users
$messageMentions = $message->mentions();

// Get current user
$currentUser = $gitter->currentUser();

// Current user resources
$userRooms = $currentUser->rooms();
$userOrgs = $currentUser->organizations();
$userRepos = $currentUser->repositories();
$userChannels = $currentUser->channels();

贡献

请参阅 CONTRIBUTING 了解详情。

测试

在 .env 文件中设置 gitter 令牌并运行

$ composer test

许可协议

MIT 许可协议(MIT)。请参阅 许可文件 获取更多信息。