README

以下是用于与TestTaskSDK通知服务一起工作的PHP语言的软件包。

要安装此软件包，只需将以下数据添加到您的composer.json中

{
    "require": {
        "beter/test-task-sdk": "2.*"
    }
}

之后，运行php composer.phar update。这样就完成了。

用法

要开始使用TestTaskSDK服务SDK，请在您的应用程序中编写以下代码。

<?php

use TestTaskSdkClient\TTClient;

$endpoint = '...'; // insert endpoint that was given to you by TestTaskSDK client's manager
$token = '...'; // insert token that was given to you by TestTaskSDK client's manager
$message = 'Hi all! Hot vacancy! Beter is hiring developers!';

$sdkClient = new TTClient($endpoint, $token);
$authKey = $sdkClient->auth();

// now you may create a job!

$jobId = $sdkClient->createJob($authKey, $message);

之后，将创建作业，您可以通过调用checkJobStatus方法来检查作业的状态

$status = $sdkClient->checkJobStatus($authKey, $jobId);

if ($status === TTClient::JOB_STATUS_DONE) {
    echo "Success!!";
}

方法

__construct($endpoint, $token)

设置端点和令牌，搞定！

setTimeout($timeout)

在派发作业之前调用此方法。这将限制auth、createJob、checkJobStatus方法的执行时间。可重用，因此只需设置一次。

auth()

返回必须用于后续SDK调用（如createJob、checkJobStatus）的authKey。

createJob($authKey, $message)

创建了一个作业。作业是发送消息的任务。消息可能需要一段时间才能发送，因此此方法立即返回。如果作业成功排队等待派发，则方法返回jobId。此方法不保证jobId将被派发。要检查作业状态，请使用checkJobStatus方法。

如果TestTaskSDK服务不可用，将抛出异常。

checkJobStatus($authKey, $jobId)

返回作业的状态（指定为jobId）。状态是以下硬编码常量之一

TTClient::JOB_STATUS_DONE - 当消息成功派发并扣费时；
TTClient::JOB_STATUS_IN_PROGRESS - 当消息仍在队列中时；
TTClient::JOB_STATUS_FAILED - 当消息未送达时，因此您的余额不会扣费。

如果出现问题，方法可能抛出异常。

beter / test-task-sdk

维护者

详细信息