$app.sendNotification

Description

Déclenche une notification.

La méthode $app.sendNotification est avant tout destinée à envoyer des notifications personnalisées. Par exemple, en déclarant une notification de ce genre dans le config.xml:

<notification name="my-custom-notification">someScript.ewts</notification>

on pourra alors forcer le déclenchement de la notification en invoquant la méthode

$app.sendNotification("my-custom-notification");

L'invocation de notifications standard (p.ex. doc-change) reste toutefois possible.

Envoi de notification automatique

Certaines méthodes de gestion de dossier ($doc.create, $doc.open, etc.) ont une option notify qui permet d'activer l'envoi des notifications.

Syntaxe

$app.sendNotification( name [ , options ] )

Paramètres

name string

Nom de la notification

options map

Map d'options. Les options reconnues sont:

context string / map

Objet décrivant le contexte de la notification.

Le paramètre peut désigner soit un contexte (exprimé en tant que string en clair ou sous forme de hash) ou une map décrivant le contexte.

⚠️ Attention, le contexte est renseigné automatiquement et reprend le contexte courant. Pour indiquer que l'on ne souhaite pas de contexte particulier, il est nécessaire de forcer l'option avec une valeur null.

suffix string

Suffixe de notification (p.ex. before, after, etc.)

parameters map

Ensemble de paramètres à passer à la notification. Attention, dans le cas de notifications standards (c.-à-d. des notifications reconnues par le moteur), l'application est responsable de reprendre les bonnes valeurs de paramètres, c'est-à-dire des valeurs qui correspondent à ce que le moteur utilise lorsqu'il envoie lui-même les notifications.

Retour

Map contenant toutes les variables du scope racine du dernier script évalué. Ce map contient toutes les variables exportées par le script. La méthode retourne null si aucun événement correspondant n'est défini dans le fichier de config.

Exemple

Non disponible