Définition d'un plugin

Développement d'une fonction

Création du Header du package #

Le Header d’un package correspond à son nom, sa description, sa version et à toutes les informations nécessaires pour le décrire en tant que tel.

Il faut commencer par créer une classe qui implémente l’interface com.yellowbox.plugin.v3.Header.
Pour ce faire, il faut cliquer droit sur le projet puis “New” -> “Class”.

Saisir un nom de package pour le plugin, par exemple “com.dimosoftware.example”, où “example” sera le nom de notre plugin.
Saisir un nom pour la classe, par exemple “ExampleHeader” puis cliquer sur “Add” dans la partie Interfaces, saisir “Header” et sélectionner l’interface com.yellowbox.plugin.v3.Header.

Cliquer sur “Finish” pour valider la création de la classe.

L’implémentation du Header est obligatoire dans le développement d’un plugin, ses différentes méthodes sont expliquées ci-dessous :

• getNom() doit retourner le nom du package tel qu’il sera visible dans le store
• getDescription() doit retourner une description du plugin telle qu’elle sera visible dans le store
• getId() doit retourner une référence UNIQUE du package, cette valeur sert de référence dans le store. Son unicité sera validée ou non lors de l’upload du package dans le store. Il est recommandé de la définir comme suit : com.<monEntreprise>.<nomPlugin> (dans notre exemple, “com.dimosoftware.example”).
• getVersion() doit retourner la version du package à l’aide d’un objet Version(X,X,X) comprenant trois niveaux : principale, majeur et mineur.
• getCodeVersion() doit retourner un numéro de version qui s’incrémente à chaque modification permettant ainsi de connaître quelle version est plus récente qu’une autre.
• getMinYellowboxVersion() doit retourner la version de YellowBox minimale pour exécuter ce package. L’objet de retour est également un objet Version(X,X,X).
• getLogo() doit retourner le chemin vers une image qui sera utilisée comme logo dans le store. Ce chemin est relatif par rapport au dossier “assets”, par exemple si mon image se nomme “logo.png” et qu’elle se trouve à la racine du dossier assets, la méthode doit retourner le String suivant : “logo.png”.
• getProvider() doit retourner le nom du créateur du plugin
• geteMail() doit retourner l’email de contact du développeur du plugin
• init(Version version, YellowboxEntryPoint entry) et onDelete(YellowboxEntryPoint entry) ne sont pas traitées aujourd’hui. Elles serviront à terme à définir des traitements à effectuer lors de l’intégration dans YellowBox, respectivement en phase d’installation et en phase de supression du package.

L’implémentation de ces méthodes, sauf les deux dernières, sont obligatoires au développement d’un Plugin.

Un package peut comporter une ou plusieurs fonctions et/ou un ou plusieurs composants.