status-im/wiki.status.im
2
0
Fork 0
mirror of https://github.com/status-im/wiki.status.im.git synced 2025-02-24 10:08:31 +00:00
Code Issues Projects Releases Wiki Activity

Deployed bceb868 with MkDocs version: 0.16.1

Browse Source
This commit is contained in:
Jarrad Hope 2017-01-30 13:23:52 +07:00
parent 073854e7e5
commit 94b6c45d33
4 changed files with 63 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
index.html
View File

@ -359,5 +359,5 @@ Without the dedication of these fine gentleman, Status would not exist.</p>
<!--
MkDocs version : 0.16.1
Build Date UTC : 2017-01-29 08:59:25
Build Date UTC : 2017-01-30 06:23:52
-->

27
mkdocs/search_index.json
View File

@ -742,7 +742,7 @@
},
{
"location": "/proposals/chat-api/",
"text": "Chat API\n\n\nInterface Anatomy\n\n\nThis anatomy establishes the different sections of the chat interface and establishes a common verbiage. The main components being:\n\n\n\n\nMessage\n\n\nInput\n\n\nKeyboard\n\n\nSuggestions\n\n\n\n\n\n\nCommands\n\n\n!init (hidden)\n\n - if it exists run on open chat session, only in 1-to-1 chats.\n\n!help\n\n!settings\n\n\nExplicitly calling commands\n\n\nDApps are namespaced with @dappname!command, which can be useful if same commands used by multiple bots are available, alternatively these can be used for commands when bot is not actually in the chat, ie @wallet!send\n\n\nCustom Keyboards\n\n\nParameters use custom keyboards (instead of types, we adapt our types to be keyboards themselves?) \n\n\nMake our emoji/sticker market with this, otherwise accessible through commands\nie !init command with param that opens up a config\n\n\nMessages\n\n\n\n\nsubscription to message feed\n\n\napi for sending messages, and setting things like \"typing\"\n\n\nnot available in group\n\n\n\n\nPrivacy\n\n\n\n\nby default does not receive all messages in group chat\n\n\nonly commands and in 1-to-1",
"text": "Chat API\n\n\nInterface Anatomy\n\n\nThis anatomy establishes the different sections of the chat interface and establishes a common verbiage. The main components being:\n\n\n\n\nMessage\n\n\nInput\n\n\nKeyboard\n\n\nSuggestions\n\n\n\n\n\n\nAccessing a bot\n\n\n/global\n (hidden)\nUniversal command for the bot, allows the bot command to be referenced in any chat via \n@botname\n.\n\n\n/init\n (hidden)\n\nRun on open chat session, only in 1-to-1 chats. \n\n\n/\ncommand\n bots can register a command handler of any ASCII title, which then Status repeats\n\n\n@botname/command\n if there is multiple bots in a chat context, then the \n@botname\n can be used to make the distinction (or alternatively a suggestions/commands list should appear to help with the distinction)\n\n\nBot Message\n a bot can send a message that can only be read by another instance of itself in chat history. This message can send markup to draw and contain data. It is activated by a user tapping on it.\n\n\nA message parsed from chat history\n on 1-to-1 chats, any message the user send can be read by the bot and can activate code via \nstatus.on('chat-update', function () { ... } );\n handler.\n\n\nBot Messages\n\n\nA Bot Message can contain it's own markup and a data payload, this message can be transmitted to the chat context. If it is interactable then the interaction (what we currently call response handler) handles the message when tapped. \n\n\nIf the user does not have the bot installed, then we display a custom keyboard that shows the bot name, its reviews/ reputation and a \"Install / Add to Contacts\" button, which the user can either cancel or install and continue with response flow.\n\n\nCommand Handlers\n\n\nOnce a command handler is invoked it is passed the current text / data payload of the message, and is required to return the paramaters (and their placeholder information). The return of the handler must include \n- \nmarkup\n or a \nstatus component(data)\n for the suggestions area \n- \nmarkup\n or a \nstatus component(data)\n for the the keyboard\n- an error object\n- the revised text / data payload.\n\n\nPrivacy\n\n\n\n\na bot can only be interacted with via commands or messages via in 1-to-1 chats\n\n\na bot can only see messages from itself and the current user in group chats.",
"title": "Chat API (WIP)"
},
{
@ -756,28 +756,23 @@
"title": "Interface Anatomy"
},
{
"location": "/proposals/chat-api/#commands",
"text": "!init (hidden) \n - if it exists run on open chat session, only in 1-to-1 chats. \n!help \n!settings",
"title": "Commands"
"location": "/proposals/chat-api/#accessing-a-bot",
"text": "/global (hidden)\nUniversal command for the bot, allows the bot command to be referenced in any chat via @botname . /init (hidden) \nRun on open chat session, only in 1-to-1 chats. / command bots can register a command handler of any ASCII title, which then Status repeats @botname/command if there is multiple bots in a chat context, then the @botname can be used to make the distinction (or alternatively a suggestions/commands list should appear to help with the distinction) Bot Message a bot can send a message that can only be read by another instance of itself in chat history. This message can send markup to draw and contain data. It is activated by a user tapping on it. A message parsed from chat history on 1-to-1 chats, any message the user send can be read by the bot and can activate code via status.on('chat-update', function () { ... } ); handler.",
"title": "Accessing a bot"
},
{
"location": "/proposals/chat-api/#explicitly-calling-commands",
"text": "DApps are namespaced with @dappname!command, which can be useful if same commands used by multiple bots are available, alternatively these can be used for commands when bot is not actually in the chat, ie @wallet!send",
"title": "Explicitly calling commands"
"location": "/proposals/chat-api/#bot-messages",
"text": "A Bot Message can contain it's own markup and a data payload, this message can be transmitted to the chat context. If it is interactable then the interaction (what we currently call response handler) handles the message when tapped. If the user does not have the bot installed, then we display a custom keyboard that shows the bot name, its reviews/ reputation and a \"Install / Add to Contacts\" button, which the user can either cancel or install and continue with response flow.",
"title": "Bot Messages"
},
{
"location": "/proposals/chat-api/#custom-keyboards",
"text": "Parameters use custom keyboards (instead of types, we adapt our types to be keyboards themselves?) Make our emoji/sticker market with this, otherwise accessible through commands\nie !init command with param that opens up a config",
"title": "Custom Keyboards"
},
{
"location": "/proposals/chat-api/#messages",
"text": "subscription to message feed api for sending messages, and setting things like \"typing\" not available in group",
"title": "Messages"
"location": "/proposals/chat-api/#command-handlers",
"text": "Once a command handler is invoked it is passed the current text / data payload of the message, and is required to return the paramaters (and their placeholder information). The return of the handler must include \n- markup or a status component(data) for the suggestions area \n- markup or a status component(data) for the the keyboard\n- an error object\n- the revised text / data payload.",
"title": "Command Handlers"
},
{
"location": "/proposals/chat-api/#privacy",
"text": "by default does not receive all messages in group chat only commands and in 1-to-1",
"text": "a bot can only be interacted with via commands or messages via in 1-to-1 chats a bot can only see messages from itself and the current user in group chats.",
"title": "Privacy"
},
{

45
proposals/chat-api/index.html
View File

@ -230,9 +230,9 @@
<ul class="nav bs-sidenav">
<li class="main active"><a href="#chat-api">Chat API</a></li>
<li><a href="#interface-anatomy">Interface Anatomy</a></li>
<li><a href="#commands">Commands</a></li>
<li><a href="#custom-keyboards">Custom Keyboards</a></li>
<li><a href="#messages">Messages</a></li>
<li><a href="#accessing-a-bot">Accessing a bot</a></li>
<li><a href="#bot-messages">Bot Messages</a></li>
<li><a href="#command-handlers">Command Handlers</a></li>
<li><a href="#privacy">Privacy</a></li>
</ul>
</div></div>
@ -253,27 +253,28 @@
<li>Suggestions</li>
</ul>
<p><img alt="" src="../img/chat-anatomy.png" /></p>
<h2 id="commands">Commands</h2>
<p>!init (hidden)<br />
- if it exists run on open chat session, only in 1-to-1 chats.<br />
!help<br />
!settings</p>
<h3 id="explicitly-calling-commands">Explicitly calling commands</h3>
<p>DApps are namespaced with @dappname!command, which can be useful if same commands used by multiple bots are available, alternatively these can be used for commands when bot is not actually in the chat, ie @wallet!send</p>
<h2 id="custom-keyboards">Custom Keyboards</h2>
<p>Parameters use custom keyboards (instead of types, we adapt our types to be keyboards themselves?) </p>
<p>Make our emoji/sticker market with this, otherwise accessible through commands
ie !init command with param that opens up a config</p>
<h2 id="messages">Messages</h2>
<ul>
<li>subscription to message feed</li>
<li>api for sending messages, and setting things like "typing"</li>
<li>not available in group</li>
</ul>
<h2 id="accessing-a-bot">Accessing a bot</h2>
<p><code>/global</code> (hidden)
Universal command for the bot, allows the bot command to be referenced in any chat via <code>@botname</code>.</p>
<p><code>/init</code> (hidden)<br />
Run on open chat session, only in 1-to-1 chats. </p>
<p><code>/&lt;command&gt;</code> bots can register a command handler of any ASCII title, which then Status repeats</p>
<p><code>@botname/command</code> if there is multiple bots in a chat context, then the <code>@botname</code> can be used to make the distinction (or alternatively a suggestions/commands list should appear to help with the distinction)</p>
<p><code>Bot Message</code> a bot can send a message that can only be read by another instance of itself in chat history. This message can send markup to draw and contain data. It is activated by a user tapping on it.</p>
<p><code>A message parsed from chat history</code> on 1-to-1 chats, any message the user send can be read by the bot and can activate code via <code>status.on('chat-update', function () { ... } );</code> handler.</p>
<h2 id="bot-messages">Bot Messages</h2>
<p>A Bot Message can contain it's own markup and a data payload, this message can be transmitted to the chat context. If it is interactable then the interaction (what we currently call response handler) handles the message when tapped. </p>
<p><strong>If the user does not have the bot installed, then we display a custom keyboard that shows the bot name, its reviews/ reputation and a "Install / Add to Contacts" button, which the user can either cancel or install and continue with response flow.</strong></p>
<h2 id="command-handlers">Command Handlers</h2>
<p>Once a command handler is invoked it is passed the current text / data payload of the message, and is required to return the paramaters (and their placeholder information). The return of the handler must include
- <code>markup</code> or a <code>status component(data)</code> for the suggestions area
- <code>markup</code> or a <code>status component(data)</code> for the the keyboard
- an error object
- the revised text / data payload.</p>
<h2 id="privacy">Privacy</h2>
<ul>
<li>by default does not receive all messages in group chat</li>
<li>only commands and in 1-to-1</li>
<li>a bot can only be interacted with via commands or messages via in 1-to-1 chats</li>
<li>a bot can only see messages from itself and the current user in group chats.</li>
</ul></div>
</div>

56
sitemap.xml
View File

@ -4,7 +4,7 @@
<url>
<loc>https://wiki.status.im/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
@ -13,37 +13,37 @@
<url>
<loc>https://wiki.status.im/getting-started/mission-and-core-values/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/getting-started/user-guide/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/getting-started/faq/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/getting-started/code-of-conduct/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/contributing/development/introduction/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/community/how-to-grow-our-community/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
@ -59,31 +59,31 @@
<url>
<loc>https://wiki.status.im/contributing/design-guidelines/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/contributing/testing-and-feedback/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/contributing/documenting/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/contributing/outreach/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/contributing/translations/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
@ -93,31 +93,31 @@
<url>
<loc>https://wiki.status.im/community/how-to-grow-our-community/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/community/slack/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/community/newsletter/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/community/blog/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/community/tell-a-friend/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
@ -127,55 +127,55 @@
<url>
<loc>https://wiki.status.im/proposals/commiteth/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/proposals/contact-sharing/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/proposals/chat-api/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/proposals/discover/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/proposals/messaging/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/proposals/erc20-exchange/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/proposals/sticker-market/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/proposals/visual-programming/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/proposals/moments/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
@ -185,13 +185,13 @@
<url>
<loc>https://wiki.status.im/licenses/mpl2/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://wiki.status.im/licenses/lgpl-v3.0-static/</loc>
<lastmod>2017-01-29</lastmod>
<lastmod>2017-01-30</lastmod>
<changefreq>daily</changefreq>
</url>