README

Valotalive - My Content API的PHP客户端

这是一个用于Valotalive数字标牌Valotalive和My Content API的辅助库。您必须在我们的系统中至少激活一个My Content才能使用此库。

需求

见composer.json中的require

安装

使用Composer
composer require valota/my-content-client

使用方法

// Initialize your client
$myClient = new Valota\MyContentAPI\Client(_API_KEY, _API_SECRET);


// get basic information
$response =$myClient->information();

// Post
$postMessage = new Valota\MyContentAPI\PostMessage();
$postMessage->setTitle('Title'); 
$postMessage->setMessage('Message');
$postMessage->setMedia('/path/to/image.or.video.jpg'); 
$postMessage->setDisplayTime(10); //seconds 
$postMessage->setSchedule([["from"=>1670615272, "to"=>1680615273]]);
// All are optional, but post has to have at least one of title, message or media.
$response = $myClient->post($postMessage);
//$response will be id of the new message. e.g. 123

// Edit
$editMessage = new Valota\MyContentAPI\EditMessage(174);
$editMessage->setTitle('Edited title'); // empty string unsets
$editMessage->setMessage('Edited message'); // empty string unsets
$editMessage->setDisplayTime(0); // 0 unsets
$postMessage->setSchedule([]); // empty array unsets
// All are optional. Only changes the values that are set.
$response = $myClient->edit($editMessage);


// List all messages
$response =$myClient->list($archive = false, $page = null);

// Get one message
$response =$myClient->get($message_id);

// Archive a message
$response =$myClient->archive($message_id);

// Restore a message from the archive
$response =$myClient->restore($message_id);

// Delete a message permanently
$response =$myClient->delete($message_id);

API描述在https://github.com/Valota/my-content-api提供了关于响应和参数的详细信息

链接

• Valotalive: https://valota.live
• My Content Channel: https://valota.live/apps/my-content/
• My Content API描述: https://github.com/Valota/my-content-api