NoteFather/ExportData.html at master · aeurum/NoteFather · GitHub

1
<!doctype html><html><head><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>NoteFather ExportData</title><link href="https://fonts.googleapis.com/css?family=Inconsolata:400,700" rel="stylesheet"><style>body{margin:0;padding:0;line-height:20px;font-family:'Inconsolata',monospace}.container{width:90%;max-width:740px;min-width:580px;margin:0 auto;padding:20px;padding-top:80px;padding-bottom:20px}.head{color:#111111}.headline{margin-bottom:24px;font-size:24px;font-weight:700}.headtext{margin-bottom:16px;line-height:24px;font-size:17px}.data{}.list{margin-top:60px;margin-bottom:60px}.tb_name{margin-bottom:14px;font-size:20px;font-weight:700;color:#161616}.tb_text{margin-bottom:20px;font-size:18px;color:#222222}.item{padding-top:16px;padding-bottom:18px;border-bottom:1px solid #eeeeee}.cell{display:inline-block;vertical-align:top}.code,.name{color:#3283BA}.name{width:18%;margin-right:5%}.type{width:18%;color:#888888}.desc{width:54%;margin-left:5%;color:#222222}</style></head><body><div class='container'><div class='head headline'>NoteFather ExportData</div><div class='head headtext'>The NoteFather is a bot that allows to create reminders, notes, and task lists without leaving Telegram. In order to export all of your NoteFather data, send the command <span class='code'>/export</span> to the bot and download the file you shall receive in seconds. The file will contain a JSON‑serialized object consisting of 2 arrays that comprise your contents.</div><div class='data'><div class='list'><div class='tb_name'>Item</div><div class='tb_text'>This object represents an element of the “items” array.</div><div class="item"><div class='name cell'><b>Field</b></div><div class='type cell'><b>Type</b></div><div class='desc cell'><b>Description</b></div></div><div class="item"><div class='name cell'>chat_id</div><div class='type cell'>Integer</div><div class='desc cell'>Your Telegram identifier</div></div><div class="item"><div class='name cell'>id</div><div class='type cell'>Integer</div><div class='desc cell'>Unique item identifier</div></div><div class="item"><div class='name cell'>type</div><div class='type cell'>String</div><div class='desc cell'>Type of the item; can be either “reminder” or “note”</div></div><div class="item"><div class='name cell'>alert</div><div class='type cell'>Integer or NULL</div><div class='desc cell'>Date of the notification in Unix time; equal to NULL if <i>type</i> is “note”</div></div><div class="item"><div class='name cell'>priority</div><div class='type cell'>Integer</div><div class='desc cell'>Item priority; 1 for huge, 2 for high, 3 for medium, and 4 for low</div></div><div class="item"><div class='name cell'>data_type</div><div class='type cell'>String</div><div class='desc cell'>One of the <a href="https://core.telegram.org/bots/api#available-types" target="_blank">available Telegram data types</a></div></div><div class="item"><div class='name cell'>text</div><div class='type cell'>String or NULL</div><div class='desc cell'>Text of the item, 0–4096 characters</div></div><div class="item"><div class='name cell'>file_id</div><div class='type cell'>String or NULL</div><div class='desc cell'>Unique file identifier; equal to NULL if <i>date_type</i> is “text”, “location”, “venue”, or “contact”.</div></div><div class="item"><div class='name cell'>is_list</div><div class='type cell'>Boolean</div><div class='desc cell'><i>True</i> if the item contains a list</div></div><div class="item"><div class='name cell'>can_others_add</div><div class='type cell'>Boolean</div><div class='desc cell'><i>True</i> if anyone having access to the list may add new tasks thereto</div></div><div class="item"><div class='name cell'>is_repeat</div><div class='type cell'>Boolean</div><div class='desc cell'><i>True</i> if the reminder is repeating</div></div><div class="item"><div class='name cell'>repeat_number</div><div class='type cell'>JSON</div><div class='desc cell'>Represents a way the repeats shall stop; can be either a JSON‑serialized Boolean, String, or Integer:<br><br>1. if Boolean, repeats shall never stop;<br><br>2. if String, it represents the date in Unix time (converted to a string) when repeats shall stop;<br><br>3. if Integer, it represents a specific number of remaining repeats.</div></div><div class="item"><div class='name cell'>period_type</div><div class='type cell'>String or NULL</div><div class='desc cell'>Type of the repeat period; can be either “y”, “m”, “f”, “w”, “d”, “h”, or “i”, which stand for “years”, “months”, “fortnights”, “weeks”, “days”, “hours”, and “minutes”, respectively</div></div><div class="item"><div class='name cell'>period_range</div><div class='type cell'>JSON</div><div class='desc cell'>Represents an interval between repeats; can be either a JSON‑serialized Integer, Array, or String:<br><br>1. if Integer, it represents a number of <i>periods</i> that shall pass between every 2 repeats; e.g. if <i>period_type</i> is “d” and deserialized <i>period_range</i> is equal to 180, the reminder shall repeat every 180 days;<br><br>2. if Array, it represents a set of days or months when the reminder shall repeat; e.g. if <i>period_type</i> is “d” and deserialized <i>period_range</i> is like [1, 3, 5], the reminder shall repeat every Monday, Wednesday, and Friday;<br><br>3. if String, it can be either “e” or “o”, which stand for “even” and “odd”, so the reminder shall repeat every respective day.</div></div><div class="item"><div class='name cell'>is_paused</div><div class='type cell'>Boolean</div><div class='desc cell'><i>True</i> if repeats are currently paused</div></div><div class="item"><div class='name cell'>paused_until</div><div class='type cell'>Integer or NULL</div><div class='desc cell'>Date repeats shall be unpaused in Unix time; if NULL, repeats may be unpaused only manually by the user</div></div><div class="item"><div class='name cell'>is_sent</div><div class='type cell'>Boolean</div><div class='desc cell'><i>True</i> if the reminder is completed (not scheduled for a date in the future)</div></div><div class="item"><div class='name cell'>date</div><div class='type cell'>Integer</div><div class='desc cell'>Date the reminder was created in Unix time</div></div></div><div class='list'><div class='tb_name'>Task</div><div class='tb_text'>This object represents an element of the “tasks” array.</div><div class="item"><div class='name cell'><b>Field</b></div><div class='type cell'><b>Type</b></div><div class='desc cell'><b>Description</b></div></div><div class="item"><div class='name cell'>chat_id</div><div class='type cell'>Integer</div><div class='desc cell'>Your Telegram identifier</div></div><div class="item"><div class='name cell'>item_id</div><div class='type cell'>Integer</div><div class='desc cell'>Unique identifier of an item the task belongs to</div></div><div class="item"><div class='name cell'>id</div><div class='type cell'>Integer</div><div class='desc cell'>Unique task identifier</div></div><div class="item"><div class='name cell'>creator_id</div><div class='type cell'>Integer</div><div class='desc cell'>Telegram identifier of the user who added the task</div></div><div class="item"><div class='name cell'>creator_username</div><div class='type cell'>String</div><div class='desc cell'>Telegram username of the user who added the task</div></div><div class="item"><div class='name cell'>text</div><div class='type cell'>String</div><div class='desc cell'>Text of the task, 1–128 characters</div></div><div class="item"><div class='name cell'>done</div><div class='type cell'>Boolean</div><div class='desc cell'>Status of the task; <i>true</i> if the task marked as done</div></div><div class="item"><div class='name cell'>date</div><div class='type cell'>Integer</div><div class='desc cell'>Date the task was created in Unix time</div></div></div></div></div></body></html>