Write formats

A conversation is also accompanied by graphic components. We can create formats with the format property.

In main.js

import code from './main.converse'

export default {
    code,
    formats: {
        smiley(text) {
            return text + ' :)'
        }
    }
}

In ConverseScript, let's use the @Format() decorator

@Event('start')
start() {
    @Format('smiley')
    > Hello
}

The decorator applies to the message to be sent. The result will be Hello :)

With parameters

Here is another example, more in depth:

import code from './main.converse'

export default {
    code,
    formats: {
        buttons(text, params) {
            return {
                buttons: params[0],
                size: params[1],
                text
            }
        }
    }
}

Here is the format

@Event('start')
start() {
    @Format('buttons', [
        {
            title: 'share',
            url: 'my.url.com'
        }
    ], 'medium')
    > Hello
}

At the exit, we will have:

{
    buttons: {
        title: 'share',
        url: 'my.url.com'
    },
    size: 'medium'
    text: 'Hello'
}

We can test it with newbot emulator

Return a promise

A format can return a promise if asynchronous notions are executed

import code from './main.converse'

export default {
    code,
    formats: {
        buttons(text, params) {
            return new Promise(resolve => {
                setTimeout(() => {
                    resolve({
                        buttons: params[0],
                        size: params[1],
                        text
                    })
                }, 2000)
            })
        }
    }
}

API

converse.format(nameFormat, (text, params, data, user) => {

})

Parameter	Type	Description
nameFormat	String	Format name
text	String	Text output
params	Array	Parameter table sent by the decorator @Format()
data	Object	Object sent in the exec() method
user	User	The user who reads the script