INSTANTMESSAGING
Voir égalementGère la Messagerie Instantanée, y compris les conversations, les messages et les utilisateurs au sein des conversations.
Les appels à l'instruction INSTANTMESSAGING sont exécutés dans le contexte de l'utilisateur appelant. En conséquence de quoi, leurs effets dépendent du contexte utilisateur courant, et en particulier de son niveau d'autorisation tel qu'appliqué aux conversations.
| Mode | Mnémonique | Syntaxe |
| 1 | GETCURRENTCHATNAME | 1 |
| 2 | ENTERCHAT | 2 |
| 3 | ISLOADING | 3 |
| 4 | ADDCHAT | 4 |
| 5 | QUITCHAT | 5 |
| 6 | SENDTEXT | 6 |
| 7 | SENDFILE | 7 |
| 8 | ADDCHATUSER | 8 |
| 9 | REMOVECHATUSER | 9 |
| 10 | LOADCHATS | 10 |
| 11 | GETCHATSCOUNT | 11 |
| 12 | GETCHATNAME | 12 |
| 13 | GETCHATTITLE | 13 |
| 14 | SETCHATTITLE | 14 |
| 15 | GETCHATCOLOR | 13 |
| 16 | SETCHATCOLOR | 15 |
| 17 | GETCHATUSERSCOUNT | 16 |
| 18 | GETCHATUSER | 17 |
| 19 | CANCEL | 18 |
| 20 | GETUSERACCESS | 19 |
| 21 | GETMESSAGESCOUNT | 16 |
| 22 | SETUSERACCESS | 8 |
| 23 | GETMESSAGESENDER | 20 |
| 24 | GETMESSAGEDATE | 20 |
| 25 | GETMESSAGEEXTENSION | 20 |
| 26 | GETMESSAGEZONE | 20 |
| 27 | GETMESSAGETEXT | 20 |
| 28 | LOADMESSAGES | 21 |
| 29 | GETMESSAGEID | 22 |
| 30 | CLEARMESSAGESCACHE | 25 |
| 31 | CLEARCHATSCACHE | 23 |
| 32 | LOADALLMESSAGES | 5 |
| 33 | LOADMESSAGEDATA | 24 |
Les modes de l'instruction INSTANTMESSAGING peuvent être catégorisées ainsi:
- Modes conçus pour scripter le Contrôle messagerie que vous pouvez insérer dans des synoptiques: ENTERCHAT, ISLOADING et GETCURRENTCHATNAME.
Ils sont reconnaissables aisément car ils ont les arguments typiques pour scripter une contrôle graphique dans un synoptique (Window, Branch et Identity). - Modes conçus pour gérer le cache de stockage local des conversations et des messages: LOADCHATS, LOADMESSAGES, LOADALLMESSAGES, CLEARCHATSCACHE et CLEARMESSAGESCACHE.
L'utilisation de ces modes est nécessaire lorsque vous avez besoin de scripter les conversations en arrière-plan, typiquement sur événement, sans interaction utilisateur. - La plupart des autres modes sont conçus pour scripter les conversations en arrière-plan. Ils ne fonctionnent que si le cache local a été créé en utilisant les modes LOAD correspondant.
Il n'est pas nécessaire d'utiliser les modes LOAD et CLEAR pour scripter le Contrôle messagerie ou pour que les utilisateurs de SnapVue puisse utiliser la messagerie instantanée.
Lorsque le besoin est de scripter les conversations en arrière-plan, les modes LOAD doivent être appelés avec le script s'exécutant sur login utilisateur, et les modes CLEAR correspondant doivent être appelés avec le script s'exécutant sur logout utilisateur.
En fonction de ce que vous souhaitez scripter exactement vous pouvez avoir besoin d'appeler :
-
LOADCHATS et CLEARCHATSCACHE: Nécessaire pour utiliser les modes possédant l'argument ChatName (ou index de conversation).
-
LOADCHATS, LOADMESSAGES (ou LOADALLMESSAGES), CLEARMESSAGESCACHE et CLEARCHATSCACHE: Nécessaire pour utiliser les modes possédant les arguments ChatName (ou index de conversation) et MessageId (ou index de message).
Si vous n'initialisez pas correctement le cache local, les appels suivants échoueront ou ne fonctionneront pas.
Une fois initialisé, l'activité ultérieure des conversations sera automatiquement mise à jour, à la fois pour les conversations existantes et pour les nouvelles.
Exemple 1 :
Appeler QUITCHAT ou SETCHATTITLE échouera si le nom de conversation que vous passez en argument n'a pas été chargé par un appel à LOADCHATS, qui aura préalablement mis en cache la liste des conversations. La cause est liée au fait que le nom de la conversation que vous avez passé en argument est inconnu du moteur de script.
Exemple 2 :
Appeler GETMESSAGESENDER ou GETMESSAGETEXT échouera si l'Id du message que vous passez en argument n'a pas été chargé par un appel à LOADMESSAGES (ou LOADALLMESSAGES), qui aura préalablement mis en cache la liste des messages des conversations. La cause est liée au fait que l'Id du message que vous avez passé en argument est inconnu du moteur de script.
Propriété communes à plus d'un mode
|
Argument |
Définition |
| StatusVariable | Nom d'une variable mesure qui contiendra le statut de la demande. Type STR. StatusVariable peut prendre les valeurs suivantes : 0 : Succès 1 : En cours 3 : Annulé 10 : Echec |
| ChatName | Nom d'une conversation. Type STR. |
| ChatTitle | Titre d'une conversation. Type STR |
| UserName | Nom d'un utilisateur. Type STR. |
| MessageId | Identifiant unique d'un message. Type STR. |
| Window | Nom du synoptique contenant un objet graphique Contrôle messagerie. Type STR. |
| Branch | Identifiant de l'animation Contrôle messagerie. Type STR. |
| Identity | Chaîne de caractères. Type STR. |
| ViewIndex | L'index de la vue dans le cas où plusieurs vues du même synoptique sont ouvertes. Tout type numérique. |
Syntaxe 1
StrVal = INSTANTMESSAGING(Mode, Window, Branch, Identity[, ViewIndex]);
Type de retour : STR.
Exécution
|
Mode |
Mnémonique |
Action |
| 1 | GETCURRENTCHATNAME |
Récupère le nom de la conversation dans laquelle l'utilisateur est actuellement au sein de la fenêtre spécifiée. |
Syntaxe 2
INSTANTMESSAGING (Mode, Window, Branch, Identity, ChatName[, ViewIndex]);
Type de retour : Aucun.
Exécution
|
Mode |
Mnémonique |
Action |
| 2 | ENTERCHAT |
Récupère le nombre d'utilisateurs actuellement dans la conversation ChatName. Type de retour : Aucun. |
Syntaxe 3
IntVal = INSTANTMESSAGING (Mode, Window, Branch, Identity[, ViewIndex]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 3 | ISLOADING |
Récupère l'état du Contrôle messagerie dans un synoptique donné. Retour : 1 si le contrôle est le chargement des messages |
Syntaxe 4
IntVal = INSTANTMESSAGING (Mode, ChatName, ChatTitle[, StatusVariable]);
Type de retour : Aucun.
Exécution
|
Mode |
Mnémonique |
Action |
| 4 | ADDCHAT |
Crée une nouvelle conversation, l'utilisateur courant reçoit automatiquement le niveau d'autorisation Propriétaire. Retour : Le numéro de requête si OK, 0 sinon. |
Syntaxe 5
IntVal = INSTANTMESSAGING (Mode, ChatName[, StatusVariable]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 5 | QUITCHAT |
Ouvre la conversation nommée ChatName et y ajoute l'utilisateur courant. Retour : Aucun. |
| 32 | LOADALLMESSAGES |
Charge tous les messages de la conversation ChatName et les stocke localement. Retour : Le numéro de requête si OK, 0 sinon. |
La fonction LOADALLMESSAGES ou LOADMESSAGES doit être appelée sur login, avant d'utiliser les fonctions qui interagissent avec les messages des conversations. L'activité des conversations suivantes sera alors automatiquement mise à jour, à la fois pour les conversations existantes, et les nouvelles. Veuillez vous référer à l'explication en haut de cette rubrique pour plus d'informations.
Syntaxe 6
IntVal = INSTANTMESSAGING (Mode, ChatName, Text[, StatusVariable]);
Type de retour : DOUBLE
|
Argument |
Définition |
| Text | Le champ Texte du nouveau nœud. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 6 | SENDTEXT |
Envoie un message texte dans la conversation ChatName. L'utilisateur exécutant la fonction doit avoir au moins l'autorisation Invité. Retour : Le numéro de requête si OK, 0 sinon. |
Syntaxe 7
IntVal = INSTANTMESSAGING (Mode, ChatName, FileName[, StatusVariable]);
Type de retour : INTEGER.
|
Argument |
Définition |
| FileName | Nom complet d'un fichier, y compris le chemin. Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 7 | SENDFILE |
Envoie le fichier FileName dans la conversation ChatName. L'utilisateur exécutant la fonction doit avoir au moins l'autorisation Invité. Retour : Le numéro de requête si OK, 0 sinon. |
Syntaxe 8
IntVal = INSTANTMESSAGING (Mode, ChatName, UserName, AccessLevel[, StatusVariable]);
Type de retour : INTEGER.
|
Argument |
Définition |
| AccessLevel | Niveau d'autorisation à accorder à l'utilisateur. Type INTEGER. 0 = Le niveau d'autorisation de l'utilisateur est Propriétaire. 1 = Le niveau d'autorisation de l'utilisateur est Admin. 2 = Le niveau d'autorisation de l'utilisateur est Invité. 3 = Le niveau d'autorisation de l'utilisateur est Lecture. |
Exécution
|
Mode |
Mnémonique |
Action |
| 8 | ADDCHATUSER |
Ajoute l'utilisateur UserName à la conversation existante ChatName avec le niveau d'autorisation AccessLevel. Retour : Le numéro de requête si OK, 0 sinon. |
| 22 | SETUSERACCESS | Modifie le niveau d'autorisation de l'utilisateur UserName sur la conversation ChatName. Retour : Le numéro de requête si OK, 0 sinon. |
Syntaxe 9
IntVal = INSTANTMESSAGING (Mode, ChatName, UserName[, StatusVariable]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 9 | REMOVECHATUSER |
Supprime l'utilisateur UserName de la conversation ChatName. L'utilisateur exécutant la fonction doit avoir au moins l'autorisation Admin. Retour : Le numéro de requête si OK, 0 sinon. |
Syntaxe 10
IntVal = INSTANTMESSAGING (Mode[, StatusVariable]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 10 | LOADCHATS |
Efface toutes les conversations stockées localement. Retour : Le numéro de requête si OK, 0 sinon. |
Cette fonction doit être appelée sur login, avant d'utiliser les fonctions qui interagissent avec les conversations. L'activité des conversations suivantes sera alors automatiquement mise à jour, à la fois pour les conversations existantes, et les nouvelles. Veuillez vous référer à l'explication en haut de cette rubrique pour plus d'informations.
Syntaxe 11
IntVal = INSTANTMESSAGING (Mode);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 11 | GETCHATSCOUNT |
Retourne le nombre total de conversations auxquelles l'utilisateur a accès. Retour : Nombre de messages dans le chat, ou -1 en cas d'erreur. |
Syntaxe 12
StrVal = INSTANTMESSAGING (Mode, ChatIndex);
Type de retour : STR.
|
Argument |
Définition |
| ChatIndex | Index de la conversation triée par date de création. Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
| 12 | GETCHATNAME |
Récupère le titre de la conversation nommée ChatName. Retour : Nom de la conversation, ou une chaîne vide en cas d'erreur. |
Syntaxe 13
StrVal = INSTANTMESSAGING (Mode, ChatName);
Type de retour : STR.
Exécution
|
Mode |
Mnémonique |
Action |
| 13 | GETCHATTITLE |
Récupère le titre de la conversation nommé ChatName. Retour : Nom de la conversation, ou une chaîne vide en cas d'erreur. |
| 15 | GETCHATCOLOR |
Récupère la couleur de la conversation. Retour : Couleur de la conversation, ou une chaîne vide en cas d'erreur. |
Syntaxe 14
IntVal = INSTANTMESSAGING (Mode, ChatName, ChatTitle[, StatusVariable]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 14 | SETCHATTITLE |
Modifie le titre de la conversation ChatName à la valeur ChatTitle. L'utilisateur exécutant la fonction doit avoir au moins le niveau d'autorisation Admin. Retour : Le numéro de requête si OK, 0 sinon. |
Syntaxe 15
IntVal = INSTANTMESSAGING (Mode, ChatName, ChatColor[, StatusVariable]);
Type de retour : INTEGER.
|
Argument |
Définition |
| ChatColor | Nouvelle couleur de la conversation. Soit une couleur standard (rouge, bleu, etc.), soit une valeur hexadécimale (dc0000, 1400ab, etc.). Type STR. |
Exécution
|
Mode |
Mnémonique |
Action |
| 16 | SETCHATCOLOR |
Modifie la couleur de la conversation ChatName. L'utilisateur exécutant la fonction doit avoir au moins le niveau d'autorisation Admin. Retour : Le numéro de requête si OK, 0 sinon. |
Syntaxe 16
IntVal = INSTANTMESSAGING (Mode, ChatName);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 17 | GETCHATUSERSCOUNT |
Récupère le nom de la conversation à l'index ChatIndex. Retour : Nom de la conversation, ou une chaîne vide en cas d'erreur. |
| 21 | GETMESSAGESCOUNT |
Récupère le nombre de messages dans la conversation ChatName. Retour : Nombre de messages dans la conversation ou -1 en cas d'erreur. |
Syntaxe 17
StrVal = INSTANTMESSAGING (Mode, ChatName, UserIndex);
Type de retour : STR.
|
Argument |
Définition |
| UserIndex | Index de l'utilisateur trié par heure d'arrivée. Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
| 18 | GETCHATSUSER |
Récupère le nom de l'utilisateur à l'index UserIndex. Retour : Nom de l'utilisateur, ou une chaîne vide en cas d'erreur. |
Syntaxe 18
INSTANTMESSAGING (Mode, QueryId);
Type de retour : Aucun.
Exécution
|
Mode |
Mnémonique |
Action |
| 19 | CANCEL |
Annule la requête QueryId. |
Syntaxe 19
IntVal = INSTANTMESSAGING (Mode, ChatName, UserName);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 20 | GETUSERACCESS |
Récupère le niveau d'autorisation de l'utilisateur UserName pour la conversation ChatName. Retour : 0 = Owner |
Syntaxe 20
StrVal = INSTANTMESSAGING (Mode, MessageId);
Type de retour : STR.
Exécution
|
Mode |
Mnémonique |
Action |
| 23 | GETMESSAGESENDER |
Retourne le nom de l'utilisateur qui a envoyé le message MessageId. |
| 24 | GETMESSAGEDATE | Retourne la date de diffusion du message MessageId. |
| 25 | GETMESSAGEEXTENSION | Retourne l'extension de message MessageId. |
| 26 | GETMESSAGEZONE | Retourne le contenu texte du message MessageId s'il existe. |
| 27 | GETMESSAGETEXT | Renvoie le contenu texte du message MessageId s'il y en a. |
| Pour tous ces modes, une chaîne vide est renvoyée en cas d'erreur. |
Syntaxe 21
IntVal= INSTANTMESSAGING (Mode, ChatName, DateFrom, DateTo, Count[, StatusVariable]);
Type de retour : INTEGER.
|
Argument |
Définition |
| DateFrom | Date à partir de laquelle les messages doivent être chargés. Une chaîne vide peut être utilisée pour indiquer de charger à partir du message le plus ancien. Type STR. |
| DateTo | Date jusqu'à laquelle les messages doivent être chargés. Une chaîne vide peut être utilisée pour indiquer de charger tous les messages jusqu'au plus récent. Type STR. |
| Count | Nombre maximum de messages à charger. -1 peut être utilisé pour indiquer aucune limite. Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
| 28 | LOADMESSAGES |
Charge et stocke les messages de la conversation ChatName en utilisant les critères fournis. Retour : Le numéro de requête si OK, 0 sinon. |
Cette fonction ou LOADALLMESSAGES doit être appelée sur login, avant d'utiliser les fonctions qui interagissent avec les messages des conversations. L'activité des conversations suivantes sera alors automatiquement mise à jour, à la fois pour les conversations existantes, et les nouvelles. Veuillez vous référer à l'explication en haut de cette rubrique pour plus d'informations.
Syntaxe 22
StrVal = INSTANTMESSAGING (Mode, ChatName, Index);
Type de retour : STR
|
Argument |
Définition |
| Index | Index du message trié par date de distribution. Type INTEGER |
Exécution
|
Mode |
Mnémonique |
Action |
| 29 | GETMESSAGEID |
Récupère l'identifiant unique du message à la position Index dans la conversation nommée ChatName. Retour : L'Id unique du message, ou une chaîne vide en cas d'erreur. |
Syntaxe 23
INSTANTMESSAGING (Mode);
Type de retour : Aucun.
Exécution
|
Mode |
Mnémonique |
Action |
| 31 | CLEARCHATSCACHE | Efface tous les messages stockés localement. |
Syntaxe 24
IntVal = INSTANTMESSAGING (Mode, MessageId, FolderName[, StatusVar]);
Type de retour : INTEGER.
Exécution
|
Mode |
Mnémonique |
Action |
| 33 | LOADMESSAGEDATA |
Sauvegarde les fichiers attachés au message MessageId dans le dossier FolderName. Retour : Le numéro de requête si OK, 0 sinon. |
Syntaxe 25
INSTANTMESSAGING (Mode[, ChatName]);
Type de retour : Aucun.
Exécution
|
Mode |
Mnémonique |
Action |
| 30 | CLEARMESSAGESCACHE |
Efface tous les messages stockés localement. Si l'argument ChatName est passé, seuls les messages de la conversation ChatName sont effacés. |