YellowboxEntryPoint

YellowboxEntryPoint

Cet objet, accessible depuis le développement d’un plugin, permet d’accéder à un ensemble de propriétés et de services de YellowBox.

Propriétés #

• getCheminDocjoint() : cette méthode permet de récupérer le chemin d’accès au répertoire des documents joints, centralisé et accessible depuis YellowBox.
• getIdUtilisateur() : récupère la référence de l’utilisateur connecté, déclencheur du plugin
• getLangue() : récupère la langue de l’utilisateur déclencheur du plugin
• getIdTable() : récupère la référence interne de la table depuis laquelle est appelé le plugin
• get(String val) : permet de récupérer des variables de YellowBox, les valeurs possibles sont :
  • REF_FICHE : correspond à la variable ##reffiche$$ d’une recherche permettant de récupérer la référence interne de la fiche courante
  • CONTEXT : permet de récupérer le contexte du serveur sur lequel s’exécute YellowBox. Par exemple : /yellowbox

Méthode getLog() #

Cette méthode permet d’insérer, dans le développement de plugin, des logs qui seront disponibles lors de l’utilisation de ce plugin dans Yellowbox, dans la visualisation des logs des processus.

Son usage se fait de la manière suivante :

ILog logger = getYellowboxEntryPoint().getLog();
logger.putInfo(message);

Il existe 4 méthodes disponibles : putInfo, putDebug, putError et putWarning.

Méthode getNotification() #

Cette méthode permet d’insérer des notifications qui seront visualisées dans l’écran de YellowBox sous forme d’une pop up en haut de l’écran, suite à exécution d’une fonction.
Elle ne s’applique donc qu’aux fonctions exécutées manuellement par un utilisateur via un bouton.
Elle permet d’informer l’utilisateur, suite à exécution d’une fonction.
Dans votre source, il est possible de renseigner une notification via la commande :

INotif notification = getYellowboxEntryPoint().getNotification();
notification.addInfo(message);

Il existe 2 méthodes disponibles : addInfo et addError.
Les notifications de type info apparaîtront dans une pop up de couleur bleue et les notifications de type error dans une pop up rouge.

Méthode getServices() #

L’accès à l’ensemble des services de YellowBox est réalisé via cet appel. On retrouve toutes les méthodes correspondant aux différents Web services disponibles sur le Swagger YellowBox.