Références

Vous trouverez dans cette section toutes les fonctions et paramètres disponibles sur le framework BotFrame.

  1. Bot
  2. Human
  3. Button
  4. Input
  5. Dropdown
  6. RemoveLast

Bot

La fonction bot() accepte trois paramètres : message, délai, true/false.

Le paramètre message est ce qui est récupéré est affiché à l'écran.

Le délai doit être défini en millisecondes. C'est le délai d'attente que va prendre BotFrame avant d'afficher le message.

Le troisième paramètre qui peut être à true/false, concerne l'affichage d'une animation de chargement pendant que le bot "écrit" son message.

La fonction peut accepter du contenu html. De cette manière vous pouvez également afficher des images, un lecteur audio, vidéo, etc.

Son utilisation se fait comme suit :

					
	bot("Message à afficher", 1500) // ce message est affiché dans une seconde et demie.

	bot('<img src="https://exemple.com/image.jpg" alt="Image d\'exemple">', 500) // Affiche une image au bout de 500 millisecondes

	bot("Message qui affiche une animation de chargement", 1500, true) // ce message affiche une animation de chargement avant l'écriture du message
					
				

Human

La fonction human() est identique à bot() à l'exception que les messages qui vont s'afficher proviendront de l'utilisateur, et apparaitront à droite.

Cette fonction accepte trois paramètres : message, délai et true/false.

Le paramètre message est ce qui est récupéré est affiché à l'écran.

Le délai doit être défini en millisecondes. C'est le délai d'attente que va prendre BotFrame avant d'afficher le message.

Le troisième paramètre qui peut être à true/false, concerne l'affichage d'une animation de chargement pendant que le programme "écrit" son message.

La fonction peut accepter du contenu html. De cette manière vous pouvez également afficher des images, un lecteur audio, vidéo, etc.

Son utilisation se fait comme suit :

					
	human("Message à afficher", 1500) // ce message est affiché dans une seconde et demie.

	human('<img src="https://exemple.com/image.jpg" alt="Image d\'exemple">', 500) // Affiche une image au bout de 500 millisecondes

	human("Message qui affiche une animation de chargement", 1500, true) // ce message affiche une animation de chargement avant l'écriture du message
					
				

Button

La fonction button() permet d'afficher des boutons à l'utilisateur afin qu'il puisse faire un choix.

Cette fonction ne prend qu'un seul paramètre : opts.

Le paramètre transmis doit être de type array.

Le array passé en paramètre peut contenir :

  1. Text : Qui permet de récupérer le contenu qui sera affiché sur le bouton
  2. Value : La fonction qui sera lancée lorsque l'utilisateur clique sur le bouton
  3. Param : Le paramètre qui sera envoyé à la fonction qui sera lancée par l'utilisateur

Son utilisation se fait comme suit :

					
	button({
		action: [
			{
				text : "Message à afficher.",
				value: "goNext",
				param: "Nouveau message à afficher."
			}
		]
	})

	function goNext(message)
	{
		bot(message, 300) // Affiche "Nouveau message à afficher"
	}
						
				

Input

La fonction input() permet d'afficher un champ de texte à l'utilisateur.

Cette fonction prend trois paramètres de type string.

  1. Name : C'est le name du champ input.
  2. Placeholder : Rempli le placeholder
  3. Fonction : La fonction qui sera exécutée à la validation du champ.

La réponse est transmise au format string et peut être récupérée dans la fonction exécutée.

Son utilisation se fait comme suit :

					
	input("age", "Entrez votre date de naissance", "calculAge")

	function calculAge(dateNaissance)
	{		
		var td = new Date();// Le date d'ouverture de la page (aujourd'hui)
		var dtn =  dateNaissance // on lit la date de naissance
		var an = dtn.substr(6,4); // l'année (les quatre premiers caractères de la chaîne à partir de 6)
		var mois = dtn.substr(3,2);// On selectionne le mois de la date de naissance
		var day = dtn.substr(0,2); // On selectionne la jour de la date de naissance
		var age = td.getFullYear()-an; // l'âge du patient

		var mMois=td.getMonth()-mois; // On calcul le mois de la date - le mois de la date de naissance


		if(mMois < 0) // s'il est strictement inférieur a 0
		{
			age=age-1; // On enlève 1 ans à l'age
		}  
		else
		{
			if(mMois == 0)// s'il est égal à 0 on est sur le même mois
			{
				var mDate=td.getDay()-day;
				if(mDate < 0)
				{
					age=age-1;
				}

			}
		}

		bot("Je vois, vous avez donc "+age+" an(s).", 500);

	}
					
				

La fonction dropdown() permet d'afficher une liste déroulante à l'utilisateur.

Vous devez assigner une fonction à la liste déroulante, c'est celle-ci qui sera exécutée lorsqu'un choix sera effectué par l'utilisateur.

La fonction prend deux paramètres. Le premier paramètre transmis est de type array et doit contenir :

  1. Text : Qui permet de récupérer le contenu et l'afficher dans la liste déroulante.
  2. Value : La valeur qui sera récupérée si l'utilisateur choisi cette option.

Le deuxième paramètre est de type string, c'est le nom de la fonction à lancer.

Son utilisation se fait comme suit :

					
	bot("Avez-vous plus de 18 ans ?", 500)
	.then(function(){
		return dropdown({
			action: [
				{
					text: "Oui, j'ai plus de 18 ans.",
					value: "oui" // valeur récupérée
				},
				{
					text: "Non, j'ai moins de 18 ans.",
					value: "non" // valeur récupérée
				}
			]
		}, afficheMessage) // Fonction à lancer
	})

	function afficheMessage(res)
	{
		if(res == "oui")
			bot("C'est parfait, vous pouvez entrer !", 500)

		if(res == "non")
			bot("Hop hop ! On file d'ici !", 500)
	}
	
					
				

removeLast

La fonction removeLast() supprime la dernière ligne de texte, dropdown ou input.

L'appelle à cette fonction est systématique lors d'un choix sur un button().

Si vous souhaitez faire disparaitre un champ de texte ou une liste déroulante après avoir complété l'action, vous devez faire appelle à la fonction removeLast().

Son utilisation se fait comme suit :

					
	bot("Avez-vous plus de 18 ans ?", 500)
	.then(function(){
		return dropdown({
			action: [
				{
					text: "Oui, j'ai plus de 18 ans.",
					value: "oui" // valeur récupérée
				},
				{
					text: "Non, j'ai moins de 18 ans.",
					value: "non" // valeur récupérée
				}
			]
		}, afficheMessage) // Fonction à lancer
	})

	function afficheMessage(res)
	{
		removeLast() // Supprime le dropdown


		if(res == "oui")
			bot("C'est parfait, vous pouvez entrer !", 500)

		if(res == "non")
			bot("Hop hop ! On file d'ici !", 500)
	}