Cet article présente toutes les différentes méthodes que vous pouvez utiliser lorsque vous codez des messages sur DIalog Insight avec le langage DI#.

**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.

isShowMessage Propriété

Retourne vrai dans la version web du courriel, sinon faux

[[if (Config.isShowMessage) {]]
Vous êtes dans la version web. 
// Ce texte sera affiché à l'écran dans la version web du courriel 
[[}]]

isWebArchive Propriété

Retourne vrai dans la version web du courriel, sinon faux

[[if (Config.isWebArchive) {]] 
Vous êtes dans l‘archive web. 
// Ce texte sera affiché à l‘écran dans l'archive web du courriel
[[}]]

Converter Classe

Convertit une valeur dans un autre format.

Converter.isInt() Méthode

Valide que la valeur est numérique.

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

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

Converter.isDecimal() Méthode

Valide que la valeur est décimale.

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

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

Converter.isDateTime() Méthode

Valide que la valeur est une date et heure.

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

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

Converter.isDate() Méthode

Valide que la valeur est une date.

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

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

Converter.isBool() Méthode

Valide que la valeur est un booléen.

Converter.isBool(1); // Retourne true

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

Converter.isDatasource() Méthode

Valide que la valeur est une source de données.

Converter.isDatasource(1); // Retourne true

Converter.ToInt() Méthode

Convertit la valeur en un nombre entier de 32 bits.

Notes

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

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

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

Converter.ToDecimal() Méthode

Convertit la valeur en un nombre décimal.

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

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

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

Converter.ToDateTime() Méthode

Convertit un objet en un format date et heure.

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

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

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

Converter.ToDate() Méthode

Convertit la valeur en un format date.

Notes

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

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

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

Converter.ToBool() Méthode

Convertit la valeur en un booléen.

Notes

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

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

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

 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 seulement dans les courriels.  

isTest Propriété

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

[[if (Mailing.isTest) {]]
Ceci est un envoi test.
[[}]] 
// Le contenu ci-haut sera seulement affiché lors d'un envoi test

dtMailing Propriété

Retourne la date de l'envoi.

[[=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.

idCategory Propriété

Retourne le nom du courriel.

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

idMessage Propriété

Retourne l'identifiant unique du courriel.

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

Message.TellAFriend() Méthode

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

<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é.

<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.

[[=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.

 <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.

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

Category Espace de nom

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

idImplicitRightFlags Propriété

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

// Si on assume que le type de communication a deux implicites associés 
Message.Category.idImplicitRightFlags // Retourne la collection [1,5]
Message.Category.idImplicitRightFlags[0] // Retourne 1 
Message.Category.idImplicitRightFlags[1] // Retourne 5

idOptinFlags Propriété

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

// Si on assume que le type de communication a deux explicites associés
Message.Category.idOptinFlags// Retourne la collection [2,3]
Message.Category.idOptinFlags[0] // Retourne 2
Message.Category.idOptinFlags[1] // Retourne 3

idCategory Propriété

Retourne l'identifiant unique du type de communication.

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

Name Propriété

Retourne le nom du type de communication.

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.

Message.Category.IsAdministrative 
// Retourne true ou false

Output Classe

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

Output.Write() Méthode

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

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

System Espace de nom

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

Now Propriété

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

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

Culture Propriété

Retourne la culture courrante de l'application.

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

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.

System.Encoding.HTMLEntities() Méthode

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

[[=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.

[[=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.

[[=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.

[[=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

 Cette 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).

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).

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

Region Propriété

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

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

Geoloc Espace de nom

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

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.

JSON.Serialize() Méthode

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

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.

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

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.

Math.Floor() Méthode

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

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

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

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é.

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

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

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

Math.Round() Méthode

System.Tools.Math.Round(1.68); // Retourne 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.

Validators.isValidCode() Méthode

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

Note : 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.

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

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

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

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

EMail Classe

Fournit des outils afin de manipuler une adresse courriel.

EMail.isValid() Méthode

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

System.Tools.Validators.EMail.isValid("usager@domaine.com"); 
// Retourne True

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

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

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

EMail.GetDomain() Méthode

Retourne le domaine du courriel.

System.Tools.Validators.EMail.GetDomain("usager@domaine.com"); 
// Retourne : "domaine.com"

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

Hash Espace de nom

Fournit des méthodes de hashage.

SHA1Classe

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

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

Hash.SHA1.String() Méthode

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

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

SHA256 Classe

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

Hash.SHA256.GetBytes() Méthode

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

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

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

MD5 Classe

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

MD5.GetBytes() Méthode

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

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

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.

Sender_FirstName Propriété

Prénom du contact ayant remplis le formulaire TellAFriend.

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

Sender_LastName Propriété

Nom de famille du contact ayant remplis le formulaire TellAFriend.

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

Friend_FirstName Propriété

Prénom de l'ami.

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

Friend_LastName Propriété

Nom de famille de l'ami.

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

Comments Propriété

Commentaires laissés à l'ami.

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

Version Espace de nom

Propriétés de version de message.

Culture Propriété

Retourne la culture en cours du message.

// Dans un message utilisant la culture « en-CA »
[[=Version.Culture;]] // Affiche « en-CA » à l'écran 
// La condition suivante fera afficher « English » à l'écran
[[if (Version.Culture == "fr-CA") {]]
Français 
[[}else{]] 
English 
[[}]]

idMessageVersion Propriété

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

// Dans un message ayant une seule version
[[=Version.idMessageVersion;]] // Affiche 1 à l'écran

VisualEditor Espace de nom

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

VisualEditor.isDesignMode Méthode

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

[[if (VisualEditor.IsDesignMode()) {]] 
<div>Ce div est seulement visible en mode édition.</div> 
[[}]]

[[if (VisualEditor.IsDesignMode() == false) {]] 
<div>Ce div n'est pas visible en mode édition.</div>
[[}]]

VisualEditor.EditZone Méthode

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

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

]] 
<div class="MainContent" [[ VisualEditor.EditZone(block_Layout, dsCustomDesignConfig);]]>
Mon contenu
</div> 
/* L'édition visuel du bloc "block_Layout" sera disponible sur le div précédent, 
selon la configuration définie plus haut*/
[[

VisualEditor.UICultureTranslate Méthode

Traduction automatique selon le contexte.

[[=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