README

这个库允许你与 Flowdock API 交互。Flowdock 客户端是 Flowdock 的分支。

基本文档

• 安装
• 推送 API
• 贡献

安装

只需一步

使用 composer 下载 Flowdock

在 composer.json 中添加 Flowdock

{
    "require": {
        "php-censor/flowdock-client": "dev-master"
    }
}

现在运行以下命令告诉 composer 下载库：

$ php composer.phar update php-censor/flowdock-client

Composer 会将库安装到你的项目 vendor/php-censor 目录。

推送 API

聊天

<?php

use FlowdockClient\Api\Push\ChatMessage;
use FlowdockClient\Api\Push\Push;

$message = ChatMessage::create()
    ->setContent('This message has been sent with php-censor/flowdock-client PHP library')
    ->setExternalUserName('php-censor)
    ->addTag('#hello-world');

$push = new Push('your_flow_api_token');

if (!$push->sendChatMessage($message, array('connect_timeout' => 1, 'timeout' => 1))) {
    // handle errors...
    $message->getResponseErrors();
}

你也可以在控制台操作，查看帮助信息

$ bin/flowdock send-chat-message --help

一些参数是必填的

$ bin/flowdock send-chat-message your_flow_api_token "This message has been sent with php-censor/flowdock-client PHP library" php-censor

一些选项是可用的

$ bin/flowdock send-chat-message your_flow_api_token "This message has been sent with php-censor/flowdock-client PHP library" php-censor --message-id=12 --tags="#hello" --tags="#world" --options='{"connect_timeout":1,"timeout":1}'

团队收件箱

<?php

use FlowdockClient\Api\Push\Push;
use FlowdockClient\Api\Push\TeamInboxMessage;

$message = TeamInboxMessage::create()
    ->setSource('source')
    ->setFromAddress('test@test.com')
    ->setSubject('subject')
    ->setContent('This message has been sent with php-censor/flowdock-client PHP library');

$push = new Push('your_flow_api_token');

if (!$push->sendTeamInboxMessage($message, array('connect_timeout' => 1, 'timeout' => 1))) {
    // handle errors...
    $message->getResponseErrors();
}

你也可以在控制台操作，查看帮助信息

$ bin/flowdock send-team-inbox-message --help

一些参数是必填的

$ bin/flowdock send-team-inbox-message your_flow_api_token source "test@test.com" subject "This message has been sent with php-censor/flowdock-client PHP library"

一些选项是可用的

$ bin/flowdock send-team-inbox-message your_flow_api_token source "test@test.com" subject "This message has been sent with php-censor/flowdock-client PHP library" --from-name=php-censor --reply-to="test@test.com" --project=project --format=html --link="http://www.flowdock.com/" --tags="#hello" --tags="#world" --options='{"connect_timeout":1,"timeout":1}'

...更多功能即将推出...

贡献

有任何问题或反馈？请提出问题，我会尽快回复。

这里缺少某个功能？请自由创建 pull request 解决它！

希望这对你有所帮助，如果有的话，请分享和推荐！ :)