ramforth/pytchat-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Modify README table

Browse Source
This commit is contained in:
55448286+taizan-hokuto@users.noreply.github.com
2019-11-03 09:02:06 +09:00
parent 582c1606c1
commit 056f6fd704
1 changed files with 99 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
README.md
View File

@@ -87,30 +87,107 @@ while chat.is_alive():
## Chatdata Structure of Default Processor ## Chatdata Structure of Default Processor
Structure of each item which got from items() function. Structure of each item which got from items() function.
|name|type|remarks| <table>
|:----|:----|:----| <tr>
|type|str|"superChat","textMessage","superSticker","newSponsor"| <th>name</th>
|id|str|| <th>type</th>
|message|str|emojis are represented by ":(shortcut text):"| <th>remarks</th>
|datetime|str|YYYY-mm-dd HH:MM:SS format| </tr>
|timestamp|int|unixtime milliseconds| <tr>
|amountValue|float|ex. 1,234.0| <td>type</td>
|amountString|str|ex. "$ 1,234"| <td>str</td>
|currency|str|ex. "USD"| <td>"superChat","textMessage","superSticker","newSponsor"</td>
|author|object|see below| </tr>
<tr>
<td>id</td>
<td>str</td>
<td></td>
</tr>
<tr>
<td>message</td>
<td>str</td>
<td>emojis are represented by ":(shortcut text):"</td>
</tr>
<tr>
<td>timestamp</td>
<td>int</td>
<td>unixtime milliseconds</td>
</tr>
<tr>
<td>amountValue</td>
<td>float</td>
<td>ex. 1,234.0</td>
</tr>
<tr>
<td>amountString</td>
<td>str</td>
<td>ex. "$ 1,234"</td>
</tr>
<tr>
<td>currency</td>
<td>str</td>
<td>ex. "USD"</td>
</tr>
<tr>
<td>author</td>
<td>object</td>
<td>see below</td>
</tr>
</table>
Structure of author object. Structure of author object.
|name|type|remarks| <table>
|:----|:----|:----| <tr>
|name|str|| <th>name</th>
|channelId|str|authorExternalChannelId| <th>type</th>
|channelUrl|str|| <th>remarks</th>
|imageUrl|str|| </tr>
|badgeUrl|str|| <tr>
|isVerified|bool|| <td>name</td>
|isChatOwner|bool|| <td>str</td>
|isChatSponsor|bool|| <td></td>
|isChatModerator|bool|| </tr>
<tr>
<td>channelId</td>
<td>str</td>
<td></td>
</tr>
<tr>
<td>channelUrl</td>
<td>str</td>
<td></td>
</tr>
<tr>
<td>imageUrl</td>
<td></td>
<td></td>
</tr>
<tr>
<td>badgeUrl</td>
<td></td>
<td></td>
</tr>
<tr>
<td>isVerified</td>
<td>bool</td>
<td></td>
</tr>
<tr>
<td>isChatOwner</td>
<td>bool</td>
<td></td>
</tr>
<tr>
<td>isChatSponsor</td>
<td>bool</td>
<td></td>
</tr>
<tr>
<td>isChatModerator</td>
<td>bool</td>
<td></td>
</tr>
</table>
## Licence ## Licence
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)