xsloom/xatbotstat

一个用于xat BOTSTAT API的PHP库。

维护者

详细信息

github.com/xSlOom/xatBotstat

源代码

问题

安装: 7

依赖项: 0

建议者: 0

安全: 0

星级: 0

关注者: 2

分支: 1

开放性问题: 0

类型:项目

1.0.1 2019-04-28 15:29 UTC

Requires

  • php: >=7.1

Requires (Dev)

MIT 56066001400bd7c7a0e0c33d82734e89dcb86ded

  • SLOom Clément <admin.woop@illuxat.com>

phpapixatxatechbotstat

This package is auto-updated.

Last update: 2024-09-14 07:27:51 UTC

README

Build Status

这是一个用于xat botstat API的PHP库。此存储库的目标是让开发者能够更简单地正确使用botstat API。

需求

  • PHP 7.2
  • Composer

入门

要开始使用，请克隆此存储库并运行 composer install

如果您没有正在运行的项目，您可以运行以下命令

composer create-project xsloom/xatbotstat.

或者将其添加到您的项目中

composer require xsloom/xatbotstat.

如何使用？

以下是一个使用示例

require_once 'vendor/autoload.php';

use xatBotstat\Botstat;

$botStat = new Botstat('MYTOKEN', 5, 110110);
$botStat::setUserName('SLOOM');
$botStat::setUserAvatar('https://i.imgur.com/mwfzvKw.png');
$result = $botStat::sendToXat();

echo ($result['error'] ? 'An error occured: ' . $result['message'] : 'OK');

Botstat类需要3个参数

  • 令牌 - 您可以在xat.com/login上获取它，并用您的令牌替换"MYTOKEN"
  • 房间ID
  • 用户ID

功能

setUsername($name)

这允许您设置新的名称。

setUserAvatar($avatar)

这允许您设置新的头像。

setUserHomepage($home)

这允许您设置新的主页。

setUserStatus($status)

这允许您设置新的状态。注意：您不能同时设置名称和状态。

sendToXat()

这将当前数据集发送到botstat API。

错误

与世界上的所有API一样，当出现问题时，它们通常会返回错误。错误代码通常在错误消息的开头。

以下是错误列表

  • ERROR 1: 未找到所选房间。
  • ERROR 5: 在聊天室中未找到用户。
  • ERROR 6: 用户需要启用/设置状态权限。
  • ERROR 7: 用户需要botstat权限。
  • ERROR 9: 请求过多。每20秒3个数据包。
  • ERROR 10: 没有要做的事。您没有提供正确的参数。

贡献

我们知道事情永远不会完美。如果您发现问题或有任何改进建议，请随时提交pull request，我会尽快查看。

作者

许可协议

本项目采用MIT许可协议 - 详细内容请参阅LICENSE文件