Voilà un articles de documentation qui présente toutes les différentes méthodes que vous pouvez utilisez lorsque vous codez des messages sur DIalog Insight

**Notez que cette documentation s'adresse aux partenaires**

Config Espace de nom

Offre des propriétés de la configuration de message

Note : Disponible seulement dans les courriels.

Propriétés

isShowMessage Propriété

Retourne vrai dans la version web du courriel, sinon faux

Exemples

 1 [[if (Config.isShowMessage) {]]

 2     Vous êtes dans la version web. // Ce texte sera affiché à l'écran dans la version web du courriel

 3 [[}]]

isWebArchive Propriété

Retourne vrai dans la version web du courriel, sinon faux

Exemples

 1 [[if (Config.isWebArchive) {]]

 2     Vous êtes dans l‘archive web. // Ce texte sera affiché à l‘écran dans l'archive web du courriel

 3 [[}]]

Converter Classe

Convertit une valeur dans un autre format.

Méthodes

Converter.isInt() Méthode

Valide que la valeur est numérique

Paramètres

Exemples

 1 Converter.isInt("123"); // Retourne true

 2 Converter.isInt("abc"); // Retourne false

Converter.isDecimal() Méthode

Valide que la valeur est décimale

Paramètres

Exemples

 1 Converter.isDecimal("1.23"); // Retourne true

 2 Converter.isDecimal("abc"); // Retourne false

Converter.isDateTime() Méthode

Valide que la valeur est une date et heure

Paramètres

Exemples

 1 Converter.isDateTime("2018.05.02 09:00:00"); // Retourne true

 2 Converter.isDateTime("abc"); // Retourne false

Converter.isDate() Méthode

Valide que la valeur est une date

Paramètres

Exemples

 1 Converter.isDate("2018.05.02"); // Retourne true

 2 Converter.isDate("abc"); // Retourne false

Converter.isBool() Méthode

Valide que la valeur est un booléen

Paramètres

Exemples

 1 Converter.isBool(1); // Retourne true

 2 Converter.isBool("1"); // Retourne false

Converter.isDatasource() Méthode

Valide que la valeur est une source de données

Paramètres

Exemples

 1 Converter.isDatasource(1); // Retourne true

Converter.ToInt() Méthode

Convertit la valeur en un nombre entier de 32 bits.

Paramètres

Notes

Une exception sera levée si l'objet passé en paramètre n'est pas convertible en un entier.

Exemples

 1 Converter.ToInt("123"); // Retourne : 123

 2 Converter.ToInt("J'ai 10 pommes"); // Lèvera une exception

Converter.ToDecimal() Méthode

Convertit la valeur en un nombre décimal.

Paramètres

Notes

Une exception sera levée si l'objet passé en paramètre n'est pas convertible en un nombre décimal.

Exemples

 1 Converter.ToDecimal("1.2"); // Retourne : 1.2

 2 Converter.ToDecimal("pi = 3.1415"); // Lèvera une exception

Converter.ToDateTime() Méthode

Convertit un objet en un format date et heure.

Paramètres

Notes

Une exception sera levée si l'objet passé en paramètre n'est pas convertible en un format date/heure.

Exemples

 1 Converter.ToDateTime("2016.01.01 12:30:45"); // Retourne un objet DateTime contenant 2016.01.01 12:30:45

 2 Converter.ToDateTime("Bonjour"); // Lèvera une exception

Converter.ToDate() Méthode

Convertit la valeur en un format date.

Paramètres

Notes

Une exception sera levée si l'objet passé en paramètre n'est pas convertible en un format date.

Exemples

 1 Converter.ToDate("2016.01.01"); // Retourne une date contenant 2016.01.01 00:00:00

 2 Converter.ToDate("Bonjour"); // Lèvera une exception

Converter.ToBool() Méthode

Convertit la valeur en un booléen.

Paramètres

Notes

Une exception sera levée si l'objet passé en paramètre n'est pas convertible en un booléen.

Exemples

 1 Converter.ToBool(1); // Retourne : True

 2 Converter.ToBool(0); // Retourne : False

 3 Converter.ToBool("Bonjour"); // Lèvera une exception

Mailing Espace de nom

Espace de nom contenant les propriétés sur l'envoi du message.

Note : Disponible seuleument dans les courriels.  

Propriétés

isTest Propriété

Retourne true si il s'agit d'un envoi test, sinon retourne false

Exemples

 1 [[if (Mailing.isTest) {]]

 2     Ceci est un envoi test.

 3 [[}]]

 4 // Le contenu ci-haut sera seulement affiché lors d'un envoi test

dtMailing Propriété

Retourne la date de l'envoi

Exemples

 1 [[=Mailing.dtMailing;]] // Retourne un datetime complet du moment de l'envoi

Message Espace de nom

Espace de nom contenant les propriétés, méthodes et classes utilisables dans les courriels.

Propriétés

idCategory Propriété

Retourne le nom du courriel

Exemples

 1 [[=Message.MessageName;]] // Affiche le nom du courriel à l'écran

idMessage Propriété

Retourne l'identifiant unique du courriel.

Exemples

 1 [[=Message.idMessage;]] // Affiche l'identifiant unique du courriel à l'écran

Category Espace de nom

Cet espace de nom contient les propriétés du type de communication associé au courriel

Propriétés

idImplicitRightFlags Propriété

Retourne une collection des identifiants des consentements implicites associés au type de communication

Exemples

 1 // Si on assume que le type de communication a deux implicites associés

 2 Message.Category.idImplicitRightFlags // Retourne la collection [1,5]

 3 Message.Category.idImplicitRightFlags[0] // Retourne 1

 4 Message.Category.idImplicitRightFlags[1] // Retourne 5

idOptinFlags Propriété

Retourne une collection des identifiants des consentements explicites associés au type de communication

Exemples

 1 // Si on assume que le type de communication a deux explicites associés

 2 Message.Category.idOptinFlags// Retourne la collection [2,3]

 3 Message.Category.idOptinFlags[0] // Retourne 2

 4 Message.Category.idOptinFlags[1] // Retourne 3

idCategory Propriété

Retourne l'identifiant unique du type de communication

Exemples

 1 Message.Category.idCategory // Affiche l'identifiant unique du type de communication à l'écran

Name Propriété

Retourne le nom du type de communication

Exemples

 1 Message.Category.Name // Affiche le nom du type de communication à l'écran

isAdministrative Propriété

Indique si le type de communication est du type administratif par un true ou false

Exemples

 1 Message.Category.IsAdministrative // Retourne true ou false

Méthodes

Message.TellAFriend() Méthode

Génère l'URL du lien vers le formulaire « Tell a friend »

Paramètres

Exemples

 1 <a href="[[=Message.TellAFriend("OriginalSender","fr-CA");]]" target="_blank">Envoyer à un ami</a> // Génère le lien vers le formulaire en français

Message.OpLink() Méthode

Génère l'URL du lien opérationnel spécifié

Paramètres

Exemples

 1 <a href="[[=Message.OpLink(1);]]">Lien opérationel</a> // Génère l'URL du lien opérationnel ayant l'identifiant unique « 1 »

Message.ReadTag() Méthode

Génère le témoin d'ouverture du courriel

Exemples

 1 [[=Message.ReadTag();]] // Génère le témoin d'ouverture du courriel

Message.Optout() Méthode

Génère l'URL du lien de désabonnement

Paramètres

Exemples

 1 <a href="[[=Message.Optout("fr-CA");]]">Désabonnement</a> // Génère le l'URL du lien de désabonnement en français

Message.WebVersion() Méthode

Génère le lien de version web du courriel

Paramètres

Exemples

 1 <a href="[[=Message.WebVersion(1,true);]]">Version web</a> // Génère l'URL vers la version web plein écran

Output Classe

Permet d'écrire du contenu à l'écran.

Méthodes

Output.Write() Méthode

Affiche à l'écran le contenu spécifié.

Paramètres

Exemples

 1 [[Output.Write("MyValue");]]  // Affiche MyValue à l'écran

System Espace de nom

Espace de nom principal contenant la majorité des classes utilisées couramment.

Propriétés

Now Propriété

Retourne un objet de type DateTime possédant la date et l'heure courante.

Exemple

 1 [[=System.Now;]] // retourne par exemple : 2018-04-09 14:40:25

Culture Propriété

Retourne la culture courrante de l'application.

Exemple

 1 [[=System.Culture;]] // retourne par exemple : "fr-CA"

Random Méthode

Retourne un nombre aléatoire entre les valeurs fournies en paramètre.

Paramètres

Exemple

 1 System.Random(2468, 9876); // Retourne 3419

Encoding Espace de nom

Cet espace de nom contient des méthodes permettant d'encoder une chaîne de caractère.

Méthodes

System.Encoding.HTMLEntities() Méthode

Retourne la chaîne de caractères encodée en HTMLEntities

Paramètres

Exemple

 1 [[=System.Encoding.HTMLEntities("Ma chaîne");]] // Retourne le résultat de l'encodage

System.Encoding.Java1() Méthode

Retourne la chaîne de caractères encodée en Java1

Paramètres

Exemple

 1 [[=System.Encoding.Java1("Ma chaîne");]] // Retourne le résultat de l'encodage

System.Encoding.Java2() Méthode

Retourne la chaîne de caractères encodée en Java2

Paramètres

Exemple

 1 [[=System.Encoding.Java2("Ma chaîne");]] // Retourne le résultat de l'encodage

System.Encoding.URL() Méthode

Retourne la chaîne de caractères encodée en URL

Paramètres

Exemple

 1 [[=System.Encoding.URL("Ma chaîne","utf-8");]] // Retourne le résultat de l'encodage

Exemple de formats d’encodage acceptés : UTF-8, ASCII, ISO-8859-1, Windows-1252

Environment Espace de nom

Cet espace de nom contient des classes utilitaires utilisable globalement dans différents projets.

Culture Classe

Retourne la culture de l'environnement

Propriétés

Name Propriété

Retourne le nom de la culture qui comprend la langue (2 caractères en minuscule), un trait d'union et la région (2 caractères en majuscule)

Exemple

 1 System.Environment.Culture.Name; // Retourne "fr-CA"

Language Propriété

Retourne le nom de la culture qui comprend la langue (2 caractères en minuscule), un trait d'union et la région (2 caractères en majuscule)

Exemple

 1 System.Environment.Culture.Language; // Retourne "fr"

Region Propriété

Retourne la région (2 caractères en majuscule)

Exemple

 1 System.Environment.Culture.Region; // Retourne "CA"

Geoloc Espace de nom

Cet espace de nom contient des méthodes de géolocalisation.

Méthodes

System.Geoloc.Distance() Méthode

Retourne la distance entre deux points cartographiques en décimal.

Paramètres

Exemple

 1 System.Geoloc.Distance(46.805719, -71.323384, 45.502065, -73.557709); // Retourne 225,195974299394

System.Geoloc.GetPointFromCode() Méthode

Convertit un code postal en point cartographique

Paramètres

Exemple

 1 System.Geoloc.GetPointFromCode("CA", "G1P 2J7").Latitude; // Retourne le décimal 46.805719

 2 System.Geoloc.GetPointFromCode("CA", "G1P 2J7").Longitude; // Retourne le décimal -71.323384

Tools Espace de nom

Cet espace de nom contient des classes utilitaires utilisables globalement dans différents projets.

JSON Classe

Fournit des outils afin de faire des conversions entre un objet et une chaîne de caractères au format JSON.

Méthodes

JSON.Serialize() Méthode

Convertit un objet en une chaîne de caractères au format JSON.

Paramètres

Exemple

 1 System.Tools.JSON.Serialize(new[] {"Pomme", "Orange", "Banane"}); // Retourne : ["Pomme","Orange","Banane"]

JSON.Deserialize() Méthode

Convertit une chaîne de caractères au format JSON en un objet.

Paramètres

Exemple

 1 System.Tools.JSON.Deserialize("MyValue"); // Retourne MyValue

 2 System.Tools.JSON.Deserialize("['Pomme','Orange','Banane']"); // Retourne une liste contenant trois éléments

Math Classe

Fournit des méthodes pour des fonctions mathématiques courantes.

Méthodes

Math.Floor() Méthode

Retourne le plus grand entier inférieur ou égal au nombre spécifié.

Paramètres

Exemples

 1 System.Tools.Math.Floor(1.5); // Retourne 1

 2 System.Tools.Math.Floor(1); // Retourne 1

 3 System.Tools.Math.Floor(1.99); // Retourne 1

Math.Ceiling() Méthode

Retourne le plus petit entier supérieur ou égal au nombre spécifié.

Paramètres

Exemples

 1 System.Tools.Math.Ceiling(1.5); // Retourne 2

 2 System.Tools.Math.Ceiling(2); // Retourne 2

 3 System.Tools.Math.Ceiling(1.01); // Retourne 2

Math.Round() Méthode

Liste des surcharges

Exemples

 1 System.Tools.Math.Round(1.68); // Retourne 2

 2 System.Tools.Math.Round(1.68, 1); // Retourne 1,7

Validators Espace de nom

Fournit des méthodes pour la validation de données.

Méthodes

Validators.isValidCode() Méthode

Retourne une indication "Vrai" ou "Faux" pour la validation du code.

Notes

Un code peut seulement contenir des caractères alphanumériques et des barres de soulignement.

Le premier caractère doit être une lettre et ne peut pas se terminer par une barre de soulignement.

Exemples

 1 System.Tools.Validators.EMail.isValidCode("monChampValide"); // Retourne True

 2 System.Tools.Validators.EMail.isValidCode("champInvalide_"); // Retourne False

 1 System.Tools.Validators.EMail.isValidCode("champValide2"); // Retourne True

 2 System.Tools.Validators.EMail.isValidCode("1champInvalide"); // Retourne False

EMail Classe

Fournit des outils afin de manipuler une adresse courriel.

Méthodes

EMail.isValid() Méthode

Retourne une indication "Vrai" ou "Faux" pour la validation du courriel.

Paramètres

Exemples

 1 System.Tools.Validators.EMail.isValid("[email protected]"); // Retourne True

 2 System.Tools.Validators.EMail.isValid("NomAccentué@domaine.com"); // Retourne False

 3 System.Tools.Validators.EMail.isValid("domaine.com"); // Retourne False

 4 System.Tools.Validators.EMail.isValid("usager@domaine"); // Retourne False

EMail.GetDomain() Méthode

Retourne le domaine du courriel.

Paramètres

Exemples

 1 System.Tools.Validators.EMail.GetDomain("[email protected]"); // Retourne : "domaine.com"

 2 System.Tools.Validators.EMail.GetDomain("domaine.com"); // Retourne une chaîne vide

Hash Espace de nom

Fournit des méthodes de hashage.

SHA1 Classe

Fournit des méthodes de hashage en utilisant la fonction cryptographique SHA1.

Méthodes

SHA1.GetBytes() Méthode

Utilise la fonction de cryptographie SHA1 afin de convertir une chaîne de caractères en un tableau d'octets.

Exemple

 1 System.Tools.Hash.SHA1.GetBytes("Ma chaine"); // Retourne un tableau d'octets

SHA1.String() Méthode

Retourne une chaîne de caractères résultante d'un hash de type SHA1

Exemple

 1 System.Tools.Hash.SHA1.GetString("MyValue"); // Retourne "DFFFEA589FCEA0A45711699422C7A20435B8B9A5"

SHA256 Classe

Fournit des méthodes de hashage en utilisant la fonction cryptographique SHA256.

Méthodes

SHA256.GetBytes() Méthode

Utilise la fonction de cryptographie SHA256 afin de convertir une chaîne de caractères en un tableau d'octets.

Exemple

 1 System.Tools.Hash.SHA256.GetBytes("ma chaine"); // Retourne un tableau d'octets

SHA256.String() Méthode

Retourne une chaîne de caractères résultante d'un hash de type SHA256

Exemple

 1 System.Tools.Hash.SHA256.GetString("MyValue"); // Retourne "83527DED182C33A2ADFF553655A7D15492EA070F89566D3ED9A8AFD7519D0C1F"

MD5 Classe

Fournit des méthodes de hashage en utilisant la fonction cryptographique MD5.

Méthodes

MD5.GetBytes() Méthode

Utilise la fonction de cryptographie MD5 afin de convertir une chaîne de caractères en un tableau d'octets.

Exemple

 1 System.Tools.Hash.MD5.GetBytes("ma chaine"); // Retourne un tableau d'octets

MD5.String() Méthode

Retourne une chaîne de caractères résultante d'un hash de type MD5

Exemple

 1 System.Tools.Hash.MD5.GetString("MyValue"); // Retourne "72F5D0C22D11F32C518782894629FB5A"

TellAFriend Espace de nom

Espace de nom contenant les informations du contact ayant envoyé un message à un ami

Propriétés

Sender_FirstName Propriété

Prénom du contact ayant remplis le formulaire TellAFriend

Exemple

 1 [[=TellAFriend.Sender_FirstName;]] // Affiche le nom du contact à l'écran

Sender_LastName Propriété

Nom de famille du contact ayant remplis le formulaire TellAFriend

Exemple

 1 [[=TellAFriend.Sender_LastName;]] // Affiche le nom de famille du contact à l'écran

Friend_FirstName Propriété

Prénom de l'ami

Exemple

 1 [[=TellAFriend.Friend_FirstName;]] // Affiche le prénom de l'ami à l'écran

Friend_LastName Propriété

Nom de famille de l'ami

Exemple

 1 [[=TellAFriend.Friend_LastName;]] // Affiche le nom de famille de l'ami à l'écran

Comments Propriété

Commentaires laissés à l'ami

Exemple

 1 [[=TellAFriend.Comments;]] // Affiche les commentaires laissés à l'ami

Version Espace de nom

Propriétés de version de message.

Propriétés

Culture Propriété

Retourne la culture en cours du message

Exemples

 1 // Dans un message utilisant la culture « en-CA »

 2 [[=Version.Culture;]] // Affiche « en-CA » à l'écran

 3 // La condition suivante fera afficher « English » à l'écran

 4 [[if (Version.Culture == "fr-CA") {]]

 5     Français

 6 [[}else{]]

 7     English

 8     [[}]]

idMessageVersion Propriété

Retourne l'identifiant unique de la version en cours du message

Exemple

 1 // Dans un message ayant une seule version

 2 [[=Version.idMessageVersion;]] // Affiche 1 à l'écran

VisualEditor Espace de nom

Espace de nom contenant les méthodes de configuration de l'éditeur visuel.

Méthodes

VisuelEditor.isDesignMode Méthode

Méthode qui permet d'identifier si nous sommes en mode édition.

Exemples

 1 [[if (VisualEditor.IsDesignMode()) {]]

 2 <div>

 3      Ce div est seulement visible en mode édition.

 4 </div>

 5 [[}]]

 6 

 7 [[if (VisualEditor.IsDesignMode() == false) {]]

 8 <div>

 9     Ce div n'est pas visible en mode édition.

10 </div>

11 [[}]]

VisuelEditor.EditZone Méthode

Méthode qui permet d'indiquer visuellement la zone d'édition dans l'éditeur visuel

Paramètres

Exemples

 1 datasource dsCustomDesignConfig = { EditedProviders:{block_Layout.Styles}, ToolPosition:"Inside", ToolSide:"Top", ToolAlign:"Right", SmallDragHelper:true, EditedProvidersShouldOverride: true }; // Configuration d'édition

 2 

 3 ]]

 4 <div class="MainContent" [[ VisualEditor.EditZone(block_Layout, dsCustomDesignConfig);]]>

 5      Mon contenu

 6 </div>

 7 // L'édition visuel du bloc "block_Layout" sera disponible sur le div précédent, selon la configuration définie plus haut

 8 [[

VisuelEditor.UICultureTranslate Méthode

Traduction automatique selon le contexte

Exemple

 1 [[=VisualEditor.UICultureTranslate("Je suis", "I am");]] // Si le contexte de l'application est en français. « Je suis » sera affiché à l'écran. Si le contexte est en anglais, « I am » sera affiché plutôt