Objets de l'API Macro

Vous pouvez créer des macros à l'aide de l'API Macro. Par défaut, quatre objets principaux sont disponibles pour les macros :

Session : point d'entrée principal pour accéder à l'hôte. Vous utilisez l'objet Session pour vous connecter, pour vous déconnecter et pour donner accès à l'objet PresentationSpace.
PresentationSpace : représente l'écran et offre de nombreuses fonctionnalités courantes telles que l'obtention et la définition de l'emplacement du curseur, l'envoi de données à l'hôte et la lecture à partir de l'écran. Vous pouvez l'obtenir en appelant session.getPresentationSpace().
Wait : permet simplement d'attendre que plusieurs états d'hôte se produisent avant de continuer à envoyer davantage de données ou à lire à partir de l'écran. Par exemple, vous pouvez attendre que le curseur se trouve à une certaine position ou que du texte soit présent à une position à l'écran, ou simplement attendre un certain temps. Tous les appels de la fonction « Wait » nécessitent le mot-clé « yield », qui est expliqué ci-dessous.
User Interface : disponible automatiquement dans votre macro en tant que variable « ui ». Cet objet offre des fonctionnalités d'interface utilisateur de base. Vous pouvez l'utiliser pour afficher des données à l'utilisateur ou lui demander de fournir des informations. Tous les appels de la fonction « UI » nécessitent le mot-clé « yield ».

Ensemble des objets disponibles

Consultez la liste des objets disponibles dans le volet de navigation de droite, « Sur cette page ». (Vous devrez peut-être développer votre navigateur.)

Attribute

Utilisez l'objet Attribute, ainsi que l'objet AttributeSet, pour décoder les informations de mise en forme présentes sur la cellule de données.

Attribut	Description
PROTECTED	Cellule de données protégée
MODIFIED	Cellule de données modifiée
NUMERIC_ONLY	Début d'une cellule de données numérique uniquement
ALPHA_NUMERIC	Cellule de données alphanumérique
HIGH_INTENSITY	La cellule de données contient du texte à haute intensité
HIDDEN	La cellule de données contient du texte masqué
PEN_DETECTABLE	La cellule de données peut être détectée par le stylet
ALPHA_ONLY	Cellule de données alphabétique uniquement
NUMERIC_SHIFT	Début d'un champ de décalage numérique
NUMERIC_SPECIAL	La cellule de données marque le début d'un champ numérique spécial
KATAKANA_SHIFT	Section de texte Katakana
MAGNETIC_STRIPE	La cellule de données marque le début d'un champ de bande magnétique
SIGNED_NUMERIC_ONLY	La cellule de données est un champ numérique signé
TRANSMIT_ONLY	La cellule de données est un champ de transmission uniquement
FIELD_END_MARKER	La cellule de données marque la fin d'un champ modifié
FIELD_START_MARKER	La cellule de données marque le début d'un champ modifié
SPECIAL_EMPHASIS_PROTECTED	Champ protégé à mise en valeur spéciale
TAB_STOP	La cellule de données contient un taquet de tabulation
REVERSE	La cellule de données s'affiche en mode vidéo inversée
BLINKING	La cellule de données contient du texte clignotant
RIGHT_JUSTIFIED	La cellule de données marque le début d'un champ justifié à droite
LEFT_JUSTIFIED	La cellule de données marque le début d'un champ justifié à gauche
LOW_INTENSITY	La cellule de données contient du texte de faible intensité
UNDERLINE	La cellule de données contient du texte souligné
DOUBLE_BYTE	La cellule de données contient du texte à double octet
COLUMN_SEPARATOR	La cellule de données contient un séparateur de colonnes
BOLD	La cellule de données contient du texte en gras
DOUBLE_WIDTH	La cellule de données marque un champ à double largeur
DOUBLE_HEIGHT_TOP	Cellule de données de niveau supérieur à double hauteur
DOUBLE_HEIGHT_BOTTOM	Cellule de données de niveau inférieur à double hauteur
CONTROL_PAGE_DATA	La cellule de données contient des données de page de contrôle
RIGHT_COLUMN_SEPARATOR	La cellule de données contient un séparateur de colonnes à droite
LEFT_COLUMN_SEPARATOR	La cellule de données contient un séparateur de colonnes à gauche
UPPERSCORE	La cellule de données contient un tiret haut
STRIKE_THROUGH	La cellule de données contient du texte barré

AttributeSet

L'objet AttributSet permet à l'utilisateur de décoder les attributs présents dans la cellule de données. Il renvoie les valeurs définies dans l'objet Attribute et, lorsque ces objets sont utilisés ensemble, vous pouvez obtenir des informations de mise en forme à partir de la cellule de données.

Méthode	Description
`contains(attribute)`	Détermine si le jeu contient l'objet Attribute spécifié. Paramètres `{Number}` Attribut à vérifier. Valeur renvoyée `{Boolean}` True si l'attribut est dans le jeu.
`isEmpty()`	Détermine si le jeu d'attributs est vide. Valeur renvoyée `{Boolean}` True si le jeu est vide.
`size()`	Indique le nombre d'attributs d'un jeu. Valeur renvoyée `{Number}` Nombre d'attributs.
`toArray()`	Convertit le jeu d'attributs interne en tableau. Valeur renvoyée `{Number[]}` Tableau de valeurs des attributs dans le jeu.
`toString()`	Convertit le jeu d'attributs interne en chaîne. Valeur renvoyée `{String} Noms délimités par un espace des attributs dans le jeu.`
`forEach(callback, thisArg)`	Fonction d'itération de chaque élément du jeu d'attributs. Paramètres `{forEachCallback}` Rappel pour effectuer l'opération spécifique. Appelé avec le nom de chaque attribut du jeu. `{Object} thisArg` Pointeur facultatif vers un objet de contexte.
`forEachCallback(string, object)`	Fonction de rappel fournie par l'utilisateur dans laquelle vous fournissez le comportement à utiliser comme paramètre de rappel pour la méthode forEach. Paramètres `{String} Nom de chaîne d'un attribut du jeu d'attributs. {Object} thisArg Pointeur facultatif vers un objet de contexte.`

AutoSignOn

Méthode	Description
`getPassTicket()`	Obtient un ticket d'accès à utiliser pour l'ouverture d'une session sur une application de mainframe. Plusieurs tickets d'accès peuvent être demandés à l'aide d'identifiants d'application différents. Paramètres {String} L'identifiant d'application indique à l'hôte l'application concernée par l'ouverture de session. Valeur renvoyée {Promise} Méthode exécutée avec la clé de ticket d'accès ou rejetée en cas d'échec de l'opération. Le ticket d'accès obtenu auprès de DCAS ne fonctionne qu'avec la session d'hôte en cours et est valable pendant dix minutes.
`sendUserName()`	Applique le nom d'utilisateur contenu dans le ticket d'accès au champ situé à l'emplacement actuel du curseur sur l'écran d'hôte actuel. Le nom d'utilisateur doit être envoyé avant le mot de passe. Si le mot de passe est envoyé en premier lieu, le ticket d'accès est invalidé et vous devez en obtenir un autre. Paramètres {String} passTicketKey obtenu auprès de getPassTickey Valeur renvoyée {Promise} Méthode exécutée si le nom d'utilisateur a bien été envoyé. Rejetée en cas d'échec de l'opération.
`sendPassword()`	Applique le mot de passe contenu dans le ticket d'accès au champ situé à l'emplacement actuel du curseur sur l'écran d'hôte actuel. Le nom d'utilisateur doit être envoyé avant le mot de passe. Si le mot de passe est envoyé en premier lieu, le ticket d'accès est invalidé et vous devez en obtenir un autre. Paramètres {String} passTicketKey obtenu auprès de getPassTickey Valeur renvoyée {Promise} Méthode exécutée si le mot de passe a bien été envoyé. Rejetée en cas d'échec de l'opération.

Color

Constantes de couleurs à utiliser pour les couleurs de premier plan et d'arrière-plan de l'objet DataCell.

Couleur	Description	Valeur numérique
BLANK_UNSPECIFIED	Aucune couleur spécifiée	0
BLUE	Bleu	1
GREEN	Vert	2
CYAN	Cyan	3
RED	Rouge	4
MAGENTA	Magenta	5
YELLOW	Jaune	6
WHITE_NORMAL_INTENSITY	Blanc d'intensité normale	7
GRAY	Gris	8
LIGHT_BLUE	Bleu clair	9
LIGHT_GREEN	Vert clair	10
LIGHT_CYAN	Cyan clair	11
LIGHT_RED	Rouge clair	12
LIGHT_MAGENTA	Magenta clair	13
BLACK	Noir	14
WHITE_HIGH_INTENSITY	Blanc de haute intensité	15
BROWN	Brun	16
PINK	Rose	17
TURQUOISE	Turquoise	18

ControlKey

L'objet ControlKey définit des constantes pour l'envoi de touches de contrôle du curseur et de commandes d'hôte à l'aide de la méthode sendKeys. Les constantes sont disponibles pour les types d'hôtes suivants :

IBM 3270
IBM 5250
VT
UTS

IBM 3270

Mot-clé	Description
ALTVIEW	Autre vue
ATTN	Attention
BACKSPACE	Retour arrière
BACKTAB	Tabulation arrière
CLEAR	Effacer ou effacer l'affichage
CURSOR_SELECT	Curseur de sélection
DELETE_CHAR	Supprimer, supprimer le caractère
DELETE_WORD	Supprimer le mot
DEST_BACK	Retour arrière destructif
DEV_CANCEL	Annulation du périphérique
DOWN	Curseur vers le bas
DSPSOSI	Affichage SO/SI
DUP	Dupliquer le champ
END_FILE	Fin de champ
ENTER	Entrée
ERASE_EOF	Effacer la fin de champ
ERASE_FIELD	Effacer le champ
ERASE_INPUT	Effacer la saisie
FIELD_MARK	Marque de champ
HOME	Origine du curseur
IDENT	Retrait
INSERT	Insertion
LEFT_ARROW	Curseur vers la gauche
LEFT2	Deux positions vers la gauche
NEW_LINE	Nouvelle ligne
PA1 - PA3	PA1 - PA3
PF1 - PF24	PF1 - PF24
PAGE_DOWN	Page suivante
PAGE_UP	Page précédente
RESET	Réinitialiser, réinitialiser le terminal
RIGHT2	Deux positions vers la droite
RIGHT_ARROW	Curseur vers la droite, droite
SYSTEM_REQUEST	Requête système
TAB	Touche de tabulation
UP	Curseur vers le haut

IBM 5250

Mot-clé	Description
ALTVIEW	Autre vue
ATTN	Attention
AU1 - AU16	AU1 - AU16
BACKSPACE	Retour arrière
BACKTAB	Tabulation arrière
BEGIN_FIELD	Début de champ
CLEAR	Effacer ou effacer l'affichage
DELETE_CHAR	Supprimer, supprimer le caractère
DEST_BACK	Retour arrière destructif
DOWN	Curseur vers le bas
DSPSOSI	Affichage SO/SI
DUP	Dupliquer le champ
END_FILE	Fin de champ
ENTER	Entrée
ERASE_EOF	Effacer la fin de champ
ERASE_FIELD	Effacer le champ
ERASE_INPUT	Effacer la saisie
FIELD_EXT	Sortie de champ
FIELD_MINUS	Champ moins
FIELD_PLUS	Champ plus
FIELD_MARK	Marque de champ
HELP	Demande d'aide
HEXMODE	Mode hexadécimal
HOME	Origine du curseur
INSERT	Insertion
LEFT_ARROW	Curseur vers la gauche
NEW_LINE	Nouvelle ligne
PA1 - PA3	PA1 - PA3
PF1 - PF24	PF1 - PF24
PAGE_DOWN	Page suivante
PAGE_UP	Page précédente
[print]	Imprimer
RESET	Réinitialiser, réinitialiser le terminal
RIGHT_ARROW	Curseur vers la droite, droite
SYSTEM_REQUEST	Requête système
TAB	Touche de tabulation
UP	Curseur vers le haut

VT

Mot-clé	Description
BACKSPACE	Retour arrière
BREAK	Attn
CLEAR	Effacer ou effacer l'affichage
CURSOR_SELECT	Curseur de sélection
DELETE_CHAR	Supprimer, supprimer le caractère
DOWN	Curseur vers le bas
EK_FIND	Pavé numérique d'édition, rechercher
EK_INSERT	Pavé numérique d'édition, insérer
EK_NEXT	Pavé numérique d'édition, suivant
EK_PREV	Pavé numérique d'édition, précédent
EK_REMOVE	Pavé numérique d'édition, supprimer
EK_SELECT	Pavé numérique d'édition, sélectionner
END_FILE	Fin de champ
ENTER	Entrée
F1 - F24	F1 - F24
HOLD	Mettre en attente
HOME	Origine
INSERT	Insertion
KEYPAD_COMMA	Virgule sur pavé numérique
KEYPAD_DOT	Décimale sur pavé numérique
KEYPAD_ENTER	Entrée sur pavé numérique
KEYPAD_MINUS	Moins sur pavé numérique
KEYPAD0 - KEYPAD9	Pavé numérique 0 - Pavé numérique 9
LEFT_ARROW	Curseur vers la gauche
PF1 - PF20	PF1 - PF20
PAGE_DOWN	Page suivante
PAGE_UP	Page précédente
RESET	Réinitialiser, réinitialiser le terminal
RETURN	Retour, retour chariot
RIGHT_ARROW	Curseur vers la droite, droite
TAB	Touche de tabulation
UDK16 - UDK20	Touche définie par l'utilisateur 6 - Touche définie par l'utilisateur 20
UP	Curseur vers le haut

UTS

Mot-clé	Description
BACKSPACE	Retour arrière
BACKTAB	Tabulation arrière
CHAR_ERASE	Efface le caractère au niveau du curseur et fait avancer le curseur
CLEAR_DISPLAY	Effacer l'affichage
CLEAR_EOD	Effacer jusqu'à la fin de l'affichage
CLEAR_EOF	Effacer jusqu'à la fin du champ
CLEAR_EOL	Effacer jusqu'à la fin de la ligne
CLEAR_FCC	Effacer le caractère de contrôle de champ
CLEAR_HOME	Effacer l'affichage et placer le curseur à l'origine
CONTROL_PAGE	Active/désactive la page de contrôle
DELETE_LINE	Supprime la ligne contenant le curseur et décale les lignes restantes d'une ligne vers le haut
DELIN_LINE	Supprime le caractère placé sous le curseur et décale les caractères restants d'une ligne vers la gauche
DELIN_PAGE	Supprime le caractère placé sous le curseur et décale les caractères restants d'une page vers la gauche
DOWN	Déplace le curseur d'une ligne vers le bas et continue automatiquement dans le bas
DUP_LINE	Crée une copie de la ligne actuelle et remplace la ligne suivante sur la ligne par le doublon
END_FIELD	Déplace le curseur à la fin du champ actuel
END_PAGE	Déplace le curseur à la fin de la page actuelle
EURO	Insère le caractère Euro
F1 - F22	Touches de fonction F1 à F22
HOME	Déplace le curseur au début de la page actuelle (ligne 1, colonne 1)
INSERT	Active/désactive le mode d'insertion/de remplacement.
INSERT_IN_LINE	Insère un espace à la position du curseur et décale les caractères restants d'une ligne vers la droite. Le caractère situé dans la colonne à l'extrême droite de la ligne est rejeté
INSERT_IN_PAGE	Insère un espace à la position du curseur et décale les caractères restants d'une page vers la droite. Le caractère situé dans la colonne à l'extrême droite de chaque ligne est rejeté
INSERT_LINE	Insère une nouvelle ligne au niveau de la ligne du curseur et décale les lignes restantes vers le bas. La dernière ligne de la page est rejetée
LEFT_ARROW	Déplace le curseur d'une position vers la gauche et continue automatiquement si nécessaire
LOCATE_FCC	Recherche le caractère de contrôle de champ suivant à l'écran
MSG_WAIT	Récupère les messages en file d'attente sur le terminal
RETURN	Retour chariot
RIGHT_ARROW	Déplace le curseur d'une position vers la droite et continue automatiquement si nécessaire
SOE	Insère le caractère de début de saisie
START_OF_FIELD	Déplace le curseur au début du champ
START_OF_LINE	Déplace le curseur vers la colonne 1 de la ligne actuelle
TAB	Déplace le curseur vers la position de tabulation suivante de l'écran
TOGGLE_COL_SEP	Active/désactive l'attribut de séparateur de colonnes
TOGGLE_STRIKE_THRU	Active/désactive l'attribut barré sur la cellule de données actuelle
TOGGLE_UNDERLINE	Active/désactive l'attribut souligné sur la cellule de données actuelle
TRANSMIT	Transmet les données de champ modifiées à l'hôte
UNLOCK	Envoie la touche UNLOCK à l'hôte
UP	Déplace le curseur d'une ligne vers le haut et continue automatiquement si nécessaire

DataCell

L'objet DataCell fournit des informations sur une position particulière sur un écran de terminal.

Méthode	Description
`getPosition()`	Renvoie la position de cette cellule de données à l'écran. Valeur renvoyée `{Position}` Position de la cellule de données à l'écran.
`getChar()`	Obtient le caractère associé à la cellule. Valeur renvoyée `{String}` Caractère associé à la cellule.
`getAttributes()`	Renvoie le jeu d'attributs spécifié pour cette instance de cellule de données. Voir AttributeSet. Valeur renvoyée `{AttributeSet}` Jeu d'attributs pour cette instance de cellule de données.
`getForegroundColor()`	Renvoie la couleur de premier plan, telle qu'elle est définie dans l'objet Color, pour cette cellule de données. Valeur renvoyée `{Number}` Couleur de premier plan pour cette cellule de données. La couleur est définie dans l'objet Color.
`getBackgroundColor()`	Renvoie la couleur d'arrière-plan, telle qu'elle est définie dans l'objet Color, pour cette cellule de données. Valeur renvoyée `{Number}` Couleur d'arrière-plan pour cette cellule de données. La couleur est définie dans l'objet Color.
`toString`	Convertit la cellule de données interne en chaîne. Valeur renvoyée `{String}` Représentation sous forme de chaîne d'une cellule de données.
`isFieldDelimiter()`	Teste si cette cellule représente un séparateur de champs. Valeur renvoyée `{Boolean}` True si cette cellule est un séparateur de champs, False dans le cas contraire.

Dimension

Représente la taille de l'écran ou de la zone d'écran.

Méthode	Description
`Dimension(rows,cols)`	Crée une instance Dimension. Paramètres `{Number} rows` Dimension de l'écran en lignes. `{Number} cols` Dimension de l'écran en colonnes.

Field

Utilisez l'objet Field, avec l'objet FieldList, pour obtenir les informations présentes dans un champ à l'écran.

Méthode	Description
`getAttributes()`	Renvoie le jeu d'attributs spécifié pour cette instance de champ. Voir AttributeSet. Valeur renvoyée `{AttributeSet}` Jeu d'attributs pour ce champ.
`getForegroundColor()`	Renvoie la couleur de premier plan du champ. Valeur renvoyée `{Number}` Couleur de premier plan pour ce champ. Cette valeur est définie dans l'objet Color.
`getBackgroundColor()`	Renvoie la couleur d'arrière-plan du champ. Valeur renvoyée `{Number}` Couleur d'arrière-plan pour ce champ. Cette valeur est définie dans l'objet Color.
`getStart()`	Renvoie la position de début du champ. La position de début est la position du premier caractère du champ. Certains types d'hôtes utilisent une position de caractère pour stocker les attributs de niveau champ. Dans ce cas, la position de l'attribut n'est pas considérée comme position de début. Valeur renvoyée `{Position}` Position de début du champ. Erreur générée `{RangeError}` Pour les champs de longueur zéro.
`getEnd()`	Renvoie la position de fin du champ. La position de fin est la position dans l'espace de présentation qui contient le dernier caractère du champ. Valeur renvoyée `{Position}` Position de fin du champ. Erreur générée `{RangeError}` Pour les champs de longueur zéro.
`getLength()`	Renvoie la longueur du champ. Pour les types d'hôtes qui utilisent une position de caractère pour stocker les attributs de champ, la longueur du champ n'inclut pas la position de l'attribut de champ. Valeur renvoyée `{Number}` Longueur du champ.
`getDataCells()`	Obtient les cellules de données qui composent ce champ. Voir DataCell. Valeur renvoyée `{DataCell[]}` Cellules de données qui composent ce champ.
`getText()`	Obtient le texte dans le champ. Valeur renvoyée `{String}` Texte du champ.
`setText()`	Définit le texte du champ. Pour certains types d'hôtes, comme VT, le texte est transmis immédiatement à l'hôte. Toutefois, pour d'autres types d'hôtes, le texte n'est transmis à l'hôte que si une touche Aid est appelée. Si le texte est plus court que le champ, il est placé dans le champ d'hôte, et le reste du champ est effacé. Si le texte est plus long que le champ d'hôte, le plus de texte possible est placé dans le champ. Paramètre `{String}` Texte à définir dans le champ. Erreur générée `{Error}` Si le champ est protégé.
`clearField()`	Efface le champ actuel d'une manière spécifique à l'émulation. Erreur générée `{Error}` Si le champ est protégé, ou effacer dans le cas contraire.
`getPresentationSpace()`	Obtient l'objet PresentationSpace qui a créé ce champ. Valeur renvoyée `{PresentationSpace}` Parent de cette instance de champ.
`toString()`	Crée une description conviviale du champ. Valeur renvoyée `{String}` Version du champ lisible par l'utilisateur.

FieldList

Utilisez l'objet FieldList, ainsi que l'objet Field, pour obtenir des informations sur la liste de champs.

Méthode	Description
`getPresentationSpace()`	Obtient l'objet PresentationSpace qui a créé ce champ. Valeur renvoyée `{PresentationSpace}` Parent de cette instance de champ.
`findField(position, text, direction)`	Renvoie le champ contenant le texte spécifié. La recherche commence à partir de la position spécifiée et se poursuit vers l'avant ou vers l'arrière. Si la chaîne s'étend sur plusieurs champs, le champ contenant la position de début est renvoyé. Lors d'une recherche vers l'avant, la recherche ne se poursuit pas automatiquement en haut de l'écran. Lors d'une recherche vers l'arrière, la recherche ne se poursuit pas en bas de l'écran. Paramètres `{Position}` Position de début de la recherche. Voir l'objet Position. `{String}` Texte à rechercher (facultatif). S'il n'est pas fourni, renvoie le champ suivant à droite ou en dessous de la position spécifiée. `{Number}` Direction de la recherche (facultatif). Utilisez des constantes PresentationSpace. SearchDirection pour ce paramètre. Par exemple, PresentationSpace.SearchDirection.FORWARD ou PresentationSpace.SearchDirection.BACKWARD. Si elle n'est pas fournie, la recherche est effectuée vers l'avant. Valeur renvoyée `{Field}` Contient la chaîne ou la valeur null si aucun champ répondant aux critères donnés n'est trouvé. Erreur générée `{RangeError}` Si la position est hors plage.
`get(index)`	Obtient le champ à l'index donné. Paramètres `{Number}` Index dans la liste de champs. Valeur renvoyée `{Field}` Située dans l'index spécifié. Erreur générée `{RangeError}` Si l'index est hors plage.
`isEmpty()`	Détermine si la liste de champs est vide. Valeur renvoyée `{Boolean}` True si la liste est vide.
`size()`	Indique le nombre de champs de la liste. Valeur renvoyée `{Number}` Nombre de champs.
`toString()`	Crée une description conviviale de la liste de champs. Valeur renvoyée `{String}` Version de la liste de champs lisible par l'utilisateur.

FileTransfer

Utilisez l'objet FileTransfer pour répertorier et transférer des fichiers entre le système hôte et le client.

L'API de transfert de fichiers Host Access for the Cloud exploite les conventions de chemin d'accès aux fichiers utilisées par différentes implémentations de fichiers d'hôte. Suivez les formats d'URL ou de chemin d'accès au système de fichiers Linux pour mettre en forme les chemins d'accès aux fichiers utilisés par l'API. Par exemple, /racine/répertoire/fichier.

Il est important de respecter toutes les règles spécifiques des systèmes hôtes, telles que les caractères autorisés ou les longueurs de noms.

remarque

Les navigateurs imposent des restrictions de sécurité importantes en ce qui concerne la capacité de JavaScript à interagir avec les systèmes de fichiers client.

Méthode	Description
`getHostFileListing(remotePath)()`	Demande une liste des fichiers d'hôte. Si `RemotePath` est omis, la liste de fichiers du répertoire de travail distant actuel s'affiche. Paramètres `{String}` (Facultatif) Si ce paramètre est spécifié, il permet d'obtenir la liste de fichiers pour le chemin d'accès distant spécifié. Dans le cas contraire, vous obtenez la liste de fichiers du répertoire de travail distant actuel. Valeur renvoyée `{Promise}` Correspond à un tableau d'objets HostFile contenus dans remoteName. Méthode rejetée si le chemin d'accès distant ne peut pas être lu.
`sendFile(localFile, remoteName)`	Envoie le fichier spécifié à l'hôte. Paramètres `{File}` Objet Fichier JavaScript pointant vers le fichier local à envoyer. `{String}` (Facultatif) Nom complet du fichier distant tel qu'il est autorisé par le système distant (Unix, Windows, MVS, VAX). Valeur renvoyée `{Promise}` Méthode exécutée avec un objet `HostFile` représentant le fichier envoyé en cas de réussite. Méthode rejetée si une erreur se produit lors de l'envoi du fichier.
`getDownloadURL(remoteName)`	Construit un lien pour télécharger un fichier à partir d'un système hôte. Paramètres `{String}` Nom complet du fichier distant tel qu'il est autorisé par le système distant (Unix, Windows, MVS, VAX). Valeur renvoyée `{URL}` URL qui peut être utilisée pour récupérer le fichier à partir du serveur de session Host Access for the Cloud.
`setTransferOptions(options)`	Définit les options de transfert pour la session FileTransfer actuelle. Les options de transfert sont appliquées à tous les transferts ultérieurs jusqu'à ce que la session soit fermée ou remplacée par un autre appel de `setTransferOptions`. Paramètres `{JSON}` Voir FileTransferOptions pour les noms et valeurs autorisés. Valeur renvoyée `{Promise}` Méthode exécutée à la fin de l'appel. Rejetée en cas d'erreur lors de la définition des options.
`cancel()`	Annule le transfert en cours. Paramètres `{String}` Nom complet du fichier distant tel qu'il est autorisé par le système distant (Unix, Windows, MVS, VAX). Valeur renvoyée `{Promise}` Méthode exécutée à la fin de l'appel. Rejetée si une erreur se produit lors de l'annulation du transfert.

FileTransferFactory

Un objet FileTransfer Factory est disponible pour toutes les macros. Si des transferts de fichiers sont configurés pour la session, vous pouvez l'utiliser pour obtenir une référence à un objet FileTransfer.

Méthode	Description
`getIND$File()`	Renvoie un objet FileTransfer pour interagir avec le type Ind$File configuré pour la session. Valeur renvoyée `{FileTransfer}` Erreur générée `{Error}` Si la session n'a pas été configurée pour autoriser les transferts IND$File.

FileTransferOptions

Spécification de l'objet des options de transfert de fichiers. Exemple :
`fileTransfer.setTransferOptions({ transferMethod : 'ascii' });```

Méthode	Description
`transferMethod`	`{String}` Valeurs autorisées : 'ascii' 'binary'

HostFile

Un objet HostFile représente un fichier sur le système de fichiers hôte.

Méthode	Description
`getName()`	Obtient le nom du fichier. Valeur renvoyée `{String}` Nom du fichier.
`getParent()`	Obtient le parent de ce fichier d'hôte. Valeur renvoyée `{String}` Parent de ce fichier d'hôte. La signification varie selon le type d'hôte. Par exemple, sur TSO, il s'agit du nom du catalogue dans lequel réside le fichier.
`getSize()`	Taille du fichier, en octets. Valeur renvoyée `{Number}` Taille du fichier en octets.
`getType()`	Type de fichier représenté. Valeur renvoyée

HostFileType

L'objet HostFileType définit des constantes pour déterminer le type d'un objet HostFile.

Valeur	Description
FILE	Représente un fichier sur le système hôte.
DIR	Représente un répertoire sur le système hôte.
UNKNOWN	Représente un fichier d'hôte d'origine inconnue.

OIA

Interface OIA (Operator Information Area). L'objet OIA renvoie les valeurs définies dans l'objet OIAStatus.

Méthode	Description
`getStatus ()`	Renvoie le jeu de drapeaux d'état activés. Voir StatusSet. Valeur renvoyée `{StatusSet}` Contient les informations d'état.
`getCommErrorCode()`	Renvoie le code d'erreur de communication actuel. Valeur renvoyée `{Number}` Code d'erreur de communication actuel. S'il n'en existe pas, la valeur est 0.
`getProgErrorCode()`	Renvoie le code d'erreur de programme actuel. Valeur renvoyée `{Number}` Code d'erreur de programme actuel. S'il n'en existe pas, la valeur est 0.

OIAStatus

OIAStatus	Description
CONTROLLER_READY	Contrôleur prêt
A_ONLINE	En ligne avec une connexion non-SNA
MY_JOB	Connecté à une application hôte
OP_SYS	Connecté à un SSCP (SNA)
UNOWNED	Non connecté
TIME	Clavier inhibé
SYS_LOCK	Verrouillage système après la touche AID
COMM_CHECK	Vérification de la communication
PROG_CHECK	Vérification du programme
ELSEWHERE	Touche non valide à l'emplacement du curseur
FN_MINUS	Fonction non disponible
WHAT_KEY	Touche non valide
MORE_THAN	Trop de caractères entrés dans le champ
SYM_MINUS	Le symbole entré n'est pas disponible
INPUT_ERROR	Erreur de saisie de l'opérateur (5250 uniquement)
DO_NOT_ENTER	Ne pas entrer
INSERT	Curseur en mode d'insertion
GR_CURSOR	Curseur en mode graphique
COMM_ERR_REM	Rappel d'erreur de communication
MSG_WAITING	Indicateur de message en attente
ENCRYPT	La session est codée
NUM_FIELD	Caractère non valide dans le champ numérique uniquement

Position

Méthode	Description
`Position(row,col)`	Crée une instance Position. Paramètres `{Number}` Coordonnées de la ligne à l'écran. `{Number}` Coordonnées de la colonne à l'écran.

PresentationSpace

Utilisez l'objet PresentationSpace pour interagir avec l'écran du terminal. La définition et l'obtention de la position du curseur, l'envoi de touches et la lecture de texte sont quelques-unes des interactions disponibles.

Méthode	Description
`getCursorPosition()`	Renvoie une instance Position représentant la position actuelle du curseur. Pour une session non connectée, la position du curseur est 0,0. Valeur renvoyée `{Position}` Emplacement actuel du curseur.
`setCursorPosition(position)`	Déplace le curseur d'hôte vers la ligne et la colonne spécifiées. Pour certains hôtes, tels que VT, l'hôte peut limiter les mouvements du curseur. Paramètres `{Position}` Position Nouvelle position du curseur. Valeur renvoyée Aucune. Erreur générée `{RangeError}` Si la position n'est pas valide sur l'écran actuel.
`isCursorVisible()`	Teste que le curseur est actuellement visible dans l'espace de présentation. Le curseur est considéré comme n'étant pas visible si la session n'est pas connectée. Valeur renvoyée `{Boolean}` True si le curseur est visible. False si le curseur n'est pas visible.
`sendKeys(keys)`	Transmet une chaîne de texte ou un objet ControlKey à l'hôte à la position actuelle du curseur dans l'espace de présentation. Si le curseur ne se trouve pas à la position souhaitée, utilisez d'abord la fonction `setCursorPosition`. La chaîne de texte peut contenir un nombre indéfini de caractères et d'objets ControlKey. Par exemple : "nom" + `ControlKey.TAB` + "mot_passe" + `ControlKey.ENTER` transmet un identifiant d'utilisateur, passe au champ suivant, transmet un mot de passe, puis transmet la touche Entrée. Si vous devez transmettre un crochet, doublez-le ([[ ou ]]). Paramètres `{String}` Texte et/ou touches de contrôle à transmettre.
`getText(start,length)`	Renvoie une chaîne représentant une zone linéaire de l'espace de présentation. Aucun caractère de nouvelle ligne n'est inséré si des limites de ligne sont rencontrées. Paramètres `{Position}` Position de début de la récupération de texte. `{Number}` Nombre maximal de caractères à renvoyer. Si le paramètre de longueur dépasse la dernière position de l'espace de présentation, seuls les caractères jusqu'à cette dernière position sont renvoyés. Valeur renvoyée `{String)` Représente une zone linéaire de l'espace de présentation qui peut être vide si la session n'est pas connectée. Erreur générée `{RangeError}` Si la position ou la longueur n'est pas valide sur l'écran actuel.
`getSize()`	Obtient les dimensions de l'écran en tant qu'objet Dimension. Valeur renvoyée `{Dimension}` Contient le nombre de lignes et de colonnes. La taille de l'écran est [row:0, col:0] si la session n'est pas connectée.
`getDataCells(start, length)`	Renvoie les instances DataCell dans lesquelles le premier membre correspond à la position spécifiée par le paramètre de début. Le nombre maximal d'instances DataCell dans la liste est spécifié par le paramètre de longueur. Paramètres `{Position}` Début de la première position de l'écran d'hôte dans laquelle récupérer les instances DataCell. Voir Position. `{Number}` Nombre maximal d'instances DataCell à récupérer. Si cette valeur n'est pas spécifiée, renvoie les instances DataCell de la position de début jusqu'à la fin de l'écran. Valeur renvoyée `{DataCell[]}` Instances qui peuvent être vides si la session n'est pas connectée. Si la position n'est pas spécifiée, renvoie toutes les instances DataCell. Si la longueur n'est pas spécifiée, renvoie les instances DataCell de la position de début jusqu'à la fin de l'écran. Erreur générée `{RangeError}` Si le début ou la longueur est hors plage.
`getFields()`	Renvoie la liste des champs de l'espace de présentation. Si le type d'hôte ne prend pas en charge les champs ou si l'écran actuel n'est pas mis en forme, la valeur renvoyée est toujours une liste vide. Voir FieldList. Valeur renvoyée `{FieldList}` Liste des champs définis par l'hôte dans l'espace de présentation.

Session

L'objet Session est le point d'entrée principal pour interagir avec l'hôte. Il contient des fonctions de connexion, de déconnexion et d'obtention de l'objet PresentationSpace.

Méthode	Description
`connect()`	Se connecte à l'hôte configuré. Si nécessaire, utilisez `wait.forConnect()` pour bloquer l'exécution des macros jusqu'à ce que la session soit connectée. Valeur renvoyée `Aucune`
`disconnect()`	Se déconnecte de l'hôte configuré. Si nécessaire, utilisez `wait.forDisconnect()` pour bloquer l'exécution des macros jusqu'à ce que la session soit connectée. Valeur renvoyée `Aucune`
`isConnected()`	Détermine si la connexion à l'hôte est connectée. Valeur renvoyée `{Boolean}` True si la connexion à l'hôte est établie ; False si ce n'est pas le cas.
`getPresentationSpace()`	Permet d'accéder à l'instance PresentationSpace pour cette session. Valeur renvoyée `{PresentationSpace}` Instance associée à cette session.
`getDeviceName()`	Renvoie le nom du périphérique pour une session connectée ou une chaîne vide si la session est déconnectée ou si elle n'a pas de nom de périphérique. Valeur renvoyée `{String}` Nom du périphérique connecté.
`getType()`	Renvoie le type de session d'hôte. Voir SessionType. Valeur renvoyée `{String}` Type de session d'hôte.
`setDeviceName()`	Permet de modifier le nom du périphérique sur une instance de session. Paramètres `{String}` Nom du périphérique à utiliser lors de la connexion à un hôte. Erreur générée `{Error}` En cas de tentative de définition du nom du périphérique alors que la session est connectée.
`getOIA()`	Permet d'accéder à l'instance OIA pour cette session. Valeur renvoyée `{OIA}` Valeur associée à cette session.

SessionType

Constantes utilisées pour identifier le type d'hôte auquel la connexion est établie. Voir l'objet Session.

Types d'hôtes disponibles :

IBM_3270
IBM_5250
VT
ALC
UTS
T27

StatusSet

Vous pouvez utiliser l'objet StatusSet pour décoder l'état OIA. L'objet StatusSet renvoie les valeurs définies dans l'objet OIAStatus et, lorsqu'ils sont utilisés ensemble, vous pouvez obtenir les informations d'état de l'OIA.

Méthode	Description
`contains(statusFlag)`	Détermine si le jeu contient le drapeau d'état spécifié dans les constantes OIAStatus. Paramètres `{Number}` État statusFlag à vérifier. Valeur renvoyée `{Boolean}` True si le drapeau d'état est présent dans le jeu.
`isEmpty()`	Détermine si le jeu d'états est vide. Valeur renvoyée `{Boolean}` True si le jeu est vide.
`size()`	Indique le nombre de drapeaux d'état dans le jeu. Valeur renvoyée `{Number}` Nombre d'états.
`toArray()`	Convertit le jeu d'états interne en tableau. Valeur renvoyée `{Object []}` Tableau de drapeaux d'état dans le jeu.
`toString()`	Convertit le jeu d'états interne en chaîne. Valeur renvoyée `{String}` Noms délimités par un espace des drapeaux d'état du jeu.
`forEach(callback, thisArg)`	Fonction à itérer sur chaque élément du jeu d'états. Paramètres `{forEachCallback}` Rappel pour effectuer l'opération spécifique. Méthode appelée avec le nom de chaque état du jeu.
`forEachCallback(string, thisArg)`	Fonction de rappel fournie par l'utilisateur dans laquelle vous fournissez le comportement à utiliser comme paramètre de rappel pour la méthode forEach. Paramètres `{String} String` Nom d'un état dans le jeu d'états. `{Object} thisArg` Pointeur facultatif vers un objet de contexte.

User Interface

L'objet User Interface offre des fonctions pour interagir avec l'utilisateur, ainsi que pour demander et afficher des informations de base. L'objet UI est automatiquement disponible dans votre macro en tant que variable « ui ».

remarque

Important : toutes les fonctions UI doivent être précédées du mot-clé « yield ». Cela permet à la macro de bloquer l'exécution jusqu'à ce que les conditions de la fonction UI soient respectées.
[parameter] indique un paramètre facultatif.

Méthode Description

prompt(message,[defaultAnswer], [mask]) Invite l'utilisateur à fournir des informations dans l'interface utilisateur.
Paramètres
{String} message : titre à afficher à l'utilisateur. Valeur par défaut : chaîne vide.
{String} defaultAnswer : réponse à utiliser si l'utilisateur la laisse vide. Valeur par défaut : chaîne vide.
{Boolean} mask : indique s'il faut masquer l'invite (comme avec un mot de passe).
Valeur renvoyée
{Promise} Méthode exécutée lorsque l'utilisateur ferme la boîte de dialogue. Renvoie l'entrée de l'utilisateur sur « OK » ou null sur « Annuler ».

message([message]) Affiche un message dans l'interface utilisateur.
Paramètres
{String} Message à afficher à l'utilisateur. Valeur par défaut : chaîne vide. Valeur renvoyée {Promise} Méthode exécutée lorsque l'utilisateur ferme la fenêtre du message.

Wait

Utilisez l'objet Wait pour attendre un état de session ou d'écran particulier. Par exemple, vous pouvez attendre que le curseur se trouve à un emplacement particulier ou que du texte soit présent à un emplacement donné avant de poursuivre l'exécution d'une macro.

Les fonctions Wait sont souvent utilisées avec des fonctions asynchrones telles que connect() et sendKeys().

remarque

Toutes les fonctions utilisent le timeout en tant que paramètre facultatif et ont une valeur de timeout par défaut de 10 secondes (10 000 ms).
Important : toutes les fonctions Wait doivent être précédées du mot-clé « yield ». Cela permet à la macro de bloquer l'exécution jusqu'à ce que les conditions de la fonction Wait soient respectées.
[parameter] indique un paramètre facultatif.

Méthode	Description
`setDefaultTimeout(timeout)`	Définit la valeur de timeout par défaut pour toutes les fonctions. Paramètres `{Number}` Timeout par défaut à utiliser pour toutes les fonctions Wait en millisecondes. Valeur renvoyée `{None}` Erreur générée `{RangeError}` Si le timeout spécifié est inférieur à zéro.
`forConnect([timeout])`	Attend la fin d'une requête de connexion. Paramètres `{Number}` Timeout en millisecondes. Valeur renvoyée `{Promise}` Méthode exécutée si la session est déjà connectée ou lors de la connexion. Rejetée en cas de timeout de la période d'attente.
`forDisconnect([timeout])`	Attend la fin d'une requête de déconnexion. Paramètres `{Number}` Timeout en millisecondes. Valeur renvoyée `{Promise}` Méthode exécutée si la session est déjà déconnectée ou lors de la déconnexion. Rejetée en cas de timeout de la période d'attente.
`forFixedTime([timeout])`	Attend sans condition pendant une période fixe, en millisecondes (ms). Paramètres `{Number}` Timeout en millisecondes. Valeur renvoyée `{Promise}` Méthode exécutée à l'issue du délai.
`forScreenChange([timeout])`	Attend que l'écran d'hôte change. Cette fonction indique quand une mise à jour de l'écran est détectée. Elle ne garantit pas le nombre de mises à jour ultérieures qui peuvent se produire avant la fin de l'écran. Il est conseillé d'attendre que le contenu de l'écran corresponde à certains critères d'arrêt connus. Paramètres `{Number}` Timeout en millisecondes. Valeur renvoyée `{Promise}` Méthode résolue si l'écran change. Rejetée en cas de timeout de la période d'attente.
`forCursor(position, [timeout])`	Attend que le curseur arrive à la position spécifiée. Paramètres `{Position}` Position indiquant la ligne et la colonne. Valeur renvoyée `{Promise}` Méthode exécutée si le curseur est déjà localisé ou lorsqu'il est enfin localisé. Rejetée en cas de timeout de la période d'attente.
`forText(text, position, [timeout])`	Attend du texte situé à une position spécifique de l'écran Paramètres `{String}` Text à attendre. `{Position}` Position indiquant la ligne et la colonne. `{Number}` Timeout en millisecondes. Valeur renvoyée `{Promise}` Méthode exécutée si le texte se trouve déjà à la position spécifiée ou lorsqu'il est localisé. Rejetée en cas de timeout de la période d'attente. Erreur générée `{RangeError}` Si la position n'est pas valide.
`forHostPrompt(text, column,[timeout])`	Attend une invite de commande située dans une colonne spécifique de l'écran. Paramètres `{String}` Invite à attendre. `{Number}` Colonne dans laquelle le curseur est attendu. `{Number}` Timeout en millisecondes. Valeur renvoyée `{Promise}` Méthode exécutée si les conditions sont déjà respectées ou lorsqu'elles sont enfin respectées. Rejetée en cas de timeout de la période d'attente. Erreur générée `{RangeError}` Si la colonne est hors plage.
`forHostSettle([settleTime],[timeout])`	REMARQUE : `wait.forHostSettle` ne doit être utilisé que lorsque d'autres fonctions Wait plus ciblées sont insuffisantes. Surveille les données entrantes de l'écran et résout settleTime après la dernière mise à jour et le déverrouillage du clavier. Cette fonction est utile lorsque des données arrivent dans plusieurs paquets et que vous souhaitez vous assurer que tout l'écran a été reçu avant de continuer. Paramètres `{Number}` Durée d'attente après la dernière mise à jour pour s'assurer que d'autres données n'arrivent pas de manière inattendue. La valeur par défaut est de 200 millisecondes. `{Number}` Timeout en millisecondes. Valeur renvoyée `{Promise}` Méthode exécutée lorsque la durée de stabilisation est écoulée après la réception de la dernière mise à jour de l'écran et que le clavier est déverrouillé.