Twake public developers API v1

L'object message est l'objet central de Twake. Pour l'utilisateur c'est son principal moyen de communication que ce soit dans une chaîne publique, privée, en message privée de groupe ou en binôme. Les messages sont également utilisés en tant que commentaires des différents objets présent dans Twake comme les fichiers, les évènements, les tâches et même les messages eux mêmes qui peuvent contenir des commentaires (appelés réponses).

Si les utilisateurs ont la possibilité de créer des messages complexes grace au système de formatage intégré, les applications peuvent aller encore plus loin et proposer de nombreux types de messages tels que des messages systèmes pour des notifications ou des messages interactifs pour vos applications les plus avancées.

Twacode

Le Twacode est le langage utilisé pour la génération des messages par les applications. Voici un exemple de Twacode pour générer le message suivant : Bonjour Steve 😀 !

[
	"Bonjour ",
	{
		"type": "bold",
		"content": [
			{
				"type": "underline",
				"content": "S"
			},
			"teve"
		]
	},
	" ",
	{
		"type": "emoji",
		"content": "grinning"
	},
	" !"
]

Le Twacode n'est rien d'autre qu'une manière de décrire votre message sous forme de blocs d'une manière similaire à du HTML et ses balises. Une liste complète des blocs Twacode est disponible ici :

Twacode

Contenu des notifications

Les notifications push mobile, mail et desktop ne peuvent pas toujours afficher le formatage et le style de votre message. Pour afficher un message personnalisé, vous pouvez modifier le champ content de cette façon :

{
	"content": {
		"fallback_string": "@jeanne a ajouté un rappel.",
		"formatted": {"type": "attachment", "content": "..."}
	}
}

Options de messages

Vous pouvez configurer vos messages afin de désactiver les réactions, désactiver les réponses ou bien désactiver le déplacement de votre message dans un autre.

Ces paramètres peuvent être renseignés dans le champ hidden_data

"hidden_data": {
	"disable_responses": false,
	"disable_drag": false,
  "disable_reactions": false,
	"disable_pin": false,
	"allow_delete": "administrators"|"everyone"|false, //Si undefined ou false,
                                    //seul le sender peut supprimer le message
	"custom_icon": "[url]",
	"custom_title": "My app"
}

Messages éphémères

Les messages éphémères sont des messages non stockés par Twake, ils fonctionnent comme des messages classiques mais ne sont pas stockés et apparaissent toujours en bas de la liste des messages.