Sample Renderer for Symphony Elements
Project description
sms-sdk-renderer-python
SDK renders symphony messages using precompiled Handlebars templates both in bots and in applications.
User Guide
Now, there are several message templates that you can choose:
Name | Description |
---|---|
SIMPLE | Renders a message in simple format |
ALERT | Renders a message formatted as an alert |
INFORMATION | Renders a general information messages |
NOTIFICATION | Renders a message formatted as a notification |
TABLE | Renders a collection of objects in the table format |
LIST_TEMPLATE | Renders a list of values |
BUTTON | Renders a button element |
TEXTFIELD | Renders a textfield element |
CHECKBOX | Renders a checkbox element |
TEXTAREA | Renders a textarea element |
RADIOBUTTON | Renders a radio button element |
PERSONSELECTOR | Renders a person selector element |
DROPDOWN_MENU | Renders a dropdown menu element |
TABLE_SELECT | Renders a table element |
Prerequisites
Please make sure the following tools are installed:
- pybars3==0.9.6
Install SDK
$ pip install sms-sdk-renderer-python
How to use
- Import the sdk:
import sms_sdk_renderer_python.lib.sms_sdk_renderer as SmsRenderer
- Create a message object like that, for the ALERT template:
alert_data = {
"title": 'Informaiton Title',
"content": 'This is a information message',
"description": 'Information message description'
}
In the bot
- In the code, compile your message using the command:
alert_message = SmsRenderer.renderInBot(alert_data, SmsRenderer.smsTypes['ALERT'])
- Send the message with Symphony API SDK:
self.bot_client.get_message_client().send_msg(msg['stream']['streamId'], alert_message)
In the client application
- In the code, in the
render
function of theentity
service, compile your message using the command:
compiledMessage = SmsRenderer.renderInApp(myMessageData, SmsRenderer.smsTypes.ALERT);
- In the same
render
method, return the message like that:
return {
template: compiledMessage
};
SDK API
Template type names are accessible by SmsRenderer.smsTypes
constant, like so:
simpleMessageTemplate = SmsRenderer.smsTypes.SIMPLE;
Possible values are SIMPLE, ALERT, INFORMATION, NOTIFICATION, TABLE, LIST_TEMPLATE, BUTTON, TEXTFIELD, CHECKBOX, TEXTAREA, RADIOBUTTON, PERSONSELECTOR, DROPDOWN_MENU, TABLE_SELECT
.
To get the compiled template in MessageML
format, use the functions:
Syntax | Parameters | Where to use |
---|---|---|
SmsRenderer.renderInApp() | messageData, messageType | Extension application |
SmsRenderer.renderInBot() | messageData, messageType | Bot |
The complete list of message data object properties can be seen in the test examples:
- SIMPLE message example
- ALERT message example
- INFORMATION message example
- NOTIFICATION message example
- TABLE message example
- LIST_TEMPLATE message example
- BUTTON message example
- TEXTFIELD message example
- RADIOBUTTON message example
- PERSONSELECTOR message example
- DROPDOWN_MENU message example
- TABLE_SELECT message example
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sms_sdk_renderer_python-0.1.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d046515103cd98f87b23b5c42ed89177af2bb566bbd57ceb23b45918235a925 |
|
MD5 | 8fb6dafba8fe5ec12766a569030e0455 |
|
BLAKE2b-256 | e6f73c0a083e2a722759ddcca2cb651d39ff1668fa0bc2202dbed3922196ee3e |
Hashes for sms_sdk_renderer_python-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5700170efded60d718f86948d72947c4e91372cf34afc9133b950fcebe1d790 |
|
MD5 | 5add4cfa23bbf290bb03f3d8323d6bec |
|
BLAKE2b-256 | d44da0b6c04fd0caa42a06028b2c36abe50f7818907ad80a7b90c7954e479a41 |