Creación de mini programas

Los mini programas le permiten ampliar la funcionalidad principal de Tommy de casi cualquier forma. Esta flexibilidad es una de las características clave de la plataforma Tommy.

Existen tres tipos de complementos que pueden utilizarse para diferentes fines:

Mini programa visual: mini programa que se integra con la interfaz de la aplicación Tommy y la amplía.
Complemento no visual: complementos que se integran con el Sistema de acciones de Tommy
Una combinación de visual y no visual.

Estructura de archivos

La estructura de carpetas del complemento es muy sencilla:

El mini programa más simple posible, que no tiene vistas ni tareas, podría componerse de un único archivo manifest.yml.

Continuemos con una explicación del archivo manifest.yml.

Archivo de manifiesto

El archivo de manifiesto manifest.yml es el archivo más importante de un mini programa. Cada mini programa debe contener un único archivo de manifiesto, que contiene toda la información de metadatos, las opciones de configuración y una lista de las vistas y acciones que expone su mini programa.

El manifiesto de ejemplo que aparece a continuación está tomado del mini programa muy básico Poke. Este mini programa contiene solo una vista, una tarea y una acción, y el archivo de manifiesto tiene este aspecto:

Las opciones del manifiesto son las siguientes:

title: (String) El nombre legible por humanos del mini programa.
package: (String) El nombre legible por máquina del mini programa en formato de guion bajo.
version: (String) El número de versión del lanzamiento (debe incrementarse en cada lanzamiento).
author: (String) El nombre del autor del complemento (puede ser un individuo o una organización).
private: (Boolean) El ajuste de privacidad que determina si otros usuarios de Tommy pueden utilizar este mini programa o no.
views: (Object) El objeto que contiene las vistas que se expondrán en la interfaz.
actions: (Object) El objeto que contiene las acciones predefinidas implementadas por el mini programa.
triggers: (Object) El objeto que contiene los disparadores de acción implementados por el mini programa.
conditions: (Object) El objeto que contiene las condiciones de acción implementadas por el mini programa.
activities: (Object) El objeto que contiene las actividades de acción implementadas por el mini programa.
roles: (Array) Puede ser cualquier rol que se haya asignado dinámicamente a un miembro del equipo, o uno de los roles integrados: «Miembro del equipo», «Gerente del equipo», «Administrador del equipo».

Vistas

Cada mini programa puede contener varias vistas que se expondrán en la interfaz. Las vistas se definen dentro de la opción views en el archivo manifest.yml.

Las opciones del manifiesto son las siguientes:

id: (String) El ID de la página de vista (debe ser único dentro del ámbito del complemento).
name: (String) El título de la página de vista.
file: (String) La ruta relativa de la vista al archivo HTML de la vista, es decir, client/main.html.
type: (String) El tipo de vista; actualmente se admiten page y form
index: (Boolean) Establézcalo en true para la vista principal que se cargará cuando se inicie el mini programa.
framed: (Boolean) Si la vista debe cargarse o no dentro de un iframe.
roles: (Array) Puede ser cualquier rol que se haya asignado dinámicamente a un miembro del equipo, o uno de los roles integrados: «Miembro del equipo», «Gerente del equipo», «Administrador del equipo».
lockable: (Boolean) Permite que la vista de índice muestre un diseño bloqueado.

Si desea que su vista se enmarque dentro de un iframe, puede hacerlo especificando la opción framed: true. Esto es bueno para la seguridad de los datos de su vista, pero tenga en cuenta que, dado que su vista se ejecutará en un entorno aislado (sandbox), no estará disponible para su uso ninguno de los elementos del entorno de Tommy, la instancia de la API ni los estilos CSS.