Objetos de Macro API

Puede crear macros utilizando la Macro API. De forma predeterminada para el uso en macros, se dispone de cuatro objetos primarios:

Session - el punto de entrada principal para acceder al host. El objeto Session se utiliza para conectar, desconectar y proveer acceso al objeto PresentationSpace.
PresentationSpace - representa la pantalla y proporciona muchas funciones comunes, como obtener y ajustar la ubicación del cursor, enviar datos al host y leer de la pantalla. Se obtiene llamando session.getPresentationSpace().
Wait - facilita una forma sencilla de esperar a que se produzcan varios estados del host antes de seguir enviando más datos o leer de la pantalla. Por ejemplo, puede esperar a que el cursor esté situado en una posición determinada, a que haya texto presente en una posición de la pantalla o simplemente esperar una cantidad de tiempo fija. Todas las llamadas de la función ‘Wait' requieren la palabra clave yield, que se explica más adelante.
Interfaz de usuario: - disponible automáticamente en la macro como la variable "ui". Provee capacidades básicas de interfaz de usuario. Puede utilizar este objeto para mostrar datos al usuario o para indicarlos a modo de información. Todas las llamadas de la función "UI" requieren la palabra clave "yield".

Todos los objetos disponibles

Consulte la lista de objetos disponibles en el panel de navegación derecho, "En esta página". (Es posible que deba expandir el navegador).

Attribute

Utilice el objeto Attribute, junto con el objeto AttributeSet, para descifrar la información de formato presente en la celda de datos.

Attribute	Indica...
PROTECTED	Una celda de datos protegida.
MODIFIED	Una celda de datos modificada.
NUMERIC_ONLY	El inicio de una celda de datos solo de caracteres numéricos.
ALPHA_NUMERIC	Una celda de datos alfanuméricos.
HIGH_INTENSITY	Si la celda de datos contiene texto de alta intensidad.
HIDDEN	Si la celda de datos contiene texto oculto.
PEN_DETECTABLE	Si la celda de datos es detectable por lápiz.
ALPHA_ONLY	Una celda solo de datos alfabéticos.
NUMERIC_SHIFT	El inicio de un campo numérico mayúscula.
NUMERIC_SPECIAL	Que la celda de datos marca el inicio de un campo numérico especial.
KATAKANA_SHIFT	Una sección de texto Katakana.
MAGNETIC_STRIPE	Que la celda de datos marca el inicio de un campo de banda magnética.
SIGNED_NUMERIC_ONLY	Que la celda de datos es un campo numérico firmado.
TRANSMIT_ONLY	Que la celda de datos es un campo solo de transmisión.
FIELD_END_MARKER	Que la celda de datos marca el final de un campo modificado.
FIELD_START_MARKER	Que la celda de datos marca el inicio de un campo modificado.
SPECIAL_EMPHASIS_PROTECTED	Un campo protegido de énfasis especial.
TAB_STOP	Que la celda de datos contiene una posición de tabulación.
REVERSE	Que la celda de datos se visualiza en modo de vídeo inverso.
BLINKING	Que la celda de datos contiene texto intermitente.
RIGHT_JUSTIFIED	Que la celda de datos marca el inicio de un campo justificado a la derecha.
LEFT_JUSTIFIED	Que la celda de datos marca el inicio de un campo justificado a la izquierda.
LOW_INTENSITY	Que la celda de datos contiene texto de baja intensidad.
UNDERLINE	Que la celda de datos contiene texto subrayado.
DOUBLE_BYTE	Que la celda de datos contiene texto de doble byte.
COLUMN_SEPARATOR	Que la celda de datos contiene un separador de columnas.
BOLD	Que la celda de datos contiene texto en negrita.
DOUBLE_WIDTH	Que la celda de datos marca un campo de anchura doble.
DOUBLE_HEIGHT_TOP	Una celda de datos superior de altura doble.
DOUBLE_HEIGHT_BOTTOM	Una celda de datos inferior de altura doble.
CONTROL_PAGE_DATA	Que la celda de datos contiene datos de página de control.
RIGHT_COLUMN_SEPARATOR	Que la celda de datos contiene un separador de columnas derecho.
LEFT_COLUMN_SEPARATOR	Que la celda de datos contiene un separador de columnas izquierdo.
UPPERSCORE	Que la celda de datos contiene sobrerrayado.
STRIKE_THROUGH	Que la celda de datos contiene texto tachado.

AttributeSet

El objeto AttributeSet permite al usuario descifrar los atributos presentes en la celda de datos. El objeto AttributeSet devuelve valores definidos en el objeto Attribute y cuando se utilizan juntos se puede obtener información de formato de la celda de datos.

Método	Descripción
`contains(attribute)`	Determina si el conjunto contiene el atributo especificado. Parámetros `{Number}` Atributo que se comprobará. Devuelve `{Boolean}` "True" (verdadero) si el atributo se encuentra en el conjunto.
`isEmpty()`	Determina si el conjunto de atributos está vacío. Devuelve `{Boolean}` "True" si el conjunto está vacío.
`size()`	Indica el número de atributos en un conjunto. Devuelve `{Number}` El número de atributos.
`toArray()`	Convierte el conjunto de atributos interno en una matriz. Devuelve `{Number[]}` Matriz de valores de atributos en el conjunto.
`toString()`	Convierte el conjunto de atributos interno en una cadena. Devuelve `{String} Nombres de atributos con espacio delimitado en el conjunto.`
`forEach(callback, thisArg)`	Función para iterar sobre cada elemento en el conjunto de atributos. Parámetros `{forEachCallback}` Devolución de llamada para realizar la operación específica. Se llama con el nombre de cada atributo en el conjunto. `{Object} thisArg` Puntero opcional a un objeto de contexto.
`forEachCallback(string, object)`	Un usuario ha provisto la función callback donde usted provee el comportamiento de ser utilizado como el parámetro callback para forEach. Parámetros `{String} Nombre de cadena de un atributo en el conjunto de atributos. {Object} thisArg Puntero opcional a un objeto de contexto.`

AutoSignOn

Método	Descripción
`getPassTicket()`	Obtiene un ticket de paso que se utiliza para iniciar sesión en una aplicación de mainframe. Se pueden solicitar múltiples tickets de paso utilizando distintos IDs de aplicación. Parámetros {String} El ID de aplicación indica al host la aplicación para la que es la entrada. Devuelve {Promise} Se cumple con la clave de ticket de paso o se rechaza si la operación falla. El ticket de paso obtenido del DCAS funciona sólo con la sesión de host actual y es válido durante diez minutos.
`sendUserName()`	Aplica el nombre de usuario incluido en el ticket de paso al campo en la posición actual del cursor en la pantalla de host actual. El nombre de usuario se debe enviar antes que la contraseña. Si se envía la contraseña primero, el ticket de paso quedará invalidado y usted tendrá que obtener otro. Parámetros {String} passTicketKey obtenida del getPassTicket. Devuelve {Promise} Se cumple si se envía correctamente el nombre de usuario. Rechazado si la operación falla.
`sendPassword()`	Aplica la contraseña incluida en el ticket de paso al campo en la posición actual del cursor en la pantalla de host actual. El nombre de usuario se debe enviar antes que la contraseña. Si se envía la contraseña primero, el ticket de paso quedará invalidado y usted tendrá que obtener otro. Parámetros {String} passTicketKey obtenida de getPassTicket. Devuelve {Promise} Se cumple si se envía correctamente la contraseña. Rechazado si la operación falla.

Color

Constantes de color a utilizar para los colores de primer plano y de fondo del objeto DataCell.

Color	Descripción	Valor Numérico
BLANK_UNSPECIFIED	Ningún color especificado	0
BLUE	Azul	1
GREEN	Verde	2
CYAN	Cian	3
RED	Rojo	4
MAGENTA	Magenta	5
YELLOW	Amarillo	6
WHITE_NORMAL_INTENSITY	Blanco de intensidad normal	7
GRAY	Gris	8
LIGHT_BLUE	Azul claro	9
LIGHT_GREEN	Verde claro	10
LIGHT_CYAN	Cian claro	11
LIGHT_RED	Rojo claro	12
LIGHT_MAGENTA	Magenta claro	13
BLACK	Negro	14
WHITE_HIGH_INTENSITY	Blanco de alta intensidad	15
BROWN	Marrón	16
PINK	Rosa	17
TURQUOISE	Turquesa	18

ControlKey

El objeto ControlKey define constantes para enviar teclas de control de cursor y comandos de host utilizando el método sendKeys. Las constantes están disponibles para estos tipos de host:

IBM 3270
IBM 5250
VT
UTS

IBM 3270

Palabra clave	Descripción
ALTVIEW	Alternar vista
ATTN	Atención
BACKSPACE	Retroceso
BACKTAB	TabAtrás
CLEAR	Borrar o Borrar pantalla
CURSOR_SELECT	Selección de cursor
DELETE_CHAR	Eliminar o Eliminar carácter
DELETE_WORD	Eliminar palabra
DEST_BACK	Borrar al utilizar Retroceso
DEV_CANCEL	Cancelar dispositivo
DOWN	Cursor abajo
DSPSOSI	Mostrar SO/SI
DUP	Campo duplicado
END_FILE	Final de campo
INTRO	Introduzca
ERASE_EOF	Eliminar final de campo
ERASE_FIELD	Eliminar campo
ERASE_INPUT	Eliminar entrada
FIELD_MARK	Marca de campo
HOME	Inicio de cursor
IDENT	Ident
INSERT	Insertar
LEFT_ARROW	Cursor izquierda
LEFT2	Dos posiciones a la izquierda
NEW_LINE	Nueva línea
PA1 - PA3	PA1 - PA3
PF1 - PF24	PF1 - PF24
PAGE_DOWN	Avance página
PAGE_UP	Retroceso página
RESET	Reset, reset terminal
RIGHT2	2 posiciones a la derecha
RIGHT_ARROW	Cursor derecha, derecha
SYSTEM_REQUEST	Solicitud de sistema
TAB	Tecla tabulación
UP	Cursor arriba

IBM 5250

Palabra clave	Descripción
ALTVIEW	Alternar vista
ATTN	Atención
AU1 - AU16	AU1 - AU16
BACKSPACE	Retroceso
BACKTAB	TabAtrás
BEGIN_FIELD	Principio de campo
CLEAR	Borrar o Borrar pantalla
DELETE_CHAR	Eliminar o Eliminar carácter
DEST_BACK	Borrar al utilizar Retroceso
DOWN	Cursor abajo
DSPSOSI	Mostrar SO/SI
DUP	Campo duplicado
END_FILE	Final de campo
INTRO	Introduzca
ERASE_EOF	Eliminar final de campo
ERASE_FIELD	Eliminar campo
ERASE_INPUT	Eliminar entrada
FIELD_EXT	Salir del campo
FIELD_MINUS	Campo resta
FIELD_PLUS	Campo suma
FIELD_MARK	Marca de campo
HELP	Solicitud de ayuda
HEXMODE	Modo Hex
HOME	Inicio de cursor
INSERT	Insertar
LEFT_ARROW	Cursor izquierda
NEW_LINE	Nueva línea
PA1 - PA3	PA1 - PA3
PF1 - PF24	PF1 - PF24
PAGE_DOWN	Avance página
PAGE_UP	Retroceso página
[imprimir]	Imprimir
RESET	Reset, reset terminal
RIGHT_ARROW	Cursor derecha, derecha
SYSTEM_REQUEST	Solicitud de sistema
TAB	Tecla tabulación
UP	Cursor arriba

VT

Palabra clave	Descripción
BACKSPACE	Retroceso
BREAK	Interrumpir
CLEAR	Borrar o Borrar pantalla
CURSOR_SELECT	Selección de cursor
DELETE_CHAR	Eliminar o Eliminar carácter
DOWN	Cursor abajo
EK_FIND	Editar buscar de teclado numérico
EK_INSERT	Editar insertar de teclado numérico
EK_NEXT	Editar siguiente de teclado numérico
EK_PREV	Editar anterior de teclado numérico
EK_REMOVE	Editar quitar de teclado numérico
EK_SELECT	Editar seleccionar de teclado numérico
END_FILE	Final de campo
INTRO	Introduzca
F1 - F24	F1 - F24
HOLD	Retención
HOME	Inicio
INSERT	Insertar
KEYPAD_COMMA	Teclado numérico Coma
KEYPAD_DOT	Teclado numérico decimal
KEYPAD_ENTER	Teclado numérico Intro
KEYPAD_MINUS	Teclado numérico -
KEYPAD0 - KEYPAD9	Teclado numérico 0 - Teclado numérico 9
LEFT_ARROW	Cursor izquierda
PF1 - PF20	PF1 - PF20
PAGE_DOWN	Avance página
PAGE_UP	Retroceso página
RESET	Reset, reset terminal
RETURN	Retorno, retorno de carro
RIGHT_ARROW	Cursor derecha, derecha
TAB	Tecla tabulación
UDK16 - UDK20	Tecla definida por el usuario 6 - Tecla definida por el usuario 20
UP	Cursor arriba

UTS

Palabra clave	Descripción
BACKSPACE	Retroceso
BACKTAB	TabAtrás
CHAR_ERASE	Borra el carácter en la posición del cursor y avanza el cursor.
CLEAR_DISPLAY	Borrar pantalla
CLEAR_EOD	Eliminar hasta final de pantalla
CLEAR_EOF	Eliminar hasta final de campo
CLEAR_EOL	Eliminar hasta final de línea
CLEAR_FCC	Borrar carácter de control de campo
CLEAR_HOME	Borrar pantalla y mover el cursor a la posición inicial
CONTROL_PAGE	Alternar la página de control
DELETE_LINE	Elimina la línea en la que se encuentra el cursor y sube las líneas restantes una fila arriba
DELIN_LINE	Borra el carácter que se encuentra debajo del cursor y mueve los caracteres restantes una línea hacia la izquierda.
DELIN_PAGE	Borra el carácter que se encuentra debajo del cursor y mueve los caracteres restantes una página hacia la izquierda.
DOWN	Mueve el cursor una línea hacia abajo. Se ajusta en la parte inferior.
DUP_LINE	Crea una copia de la línea actual y sobrescribe la línea siguiente con la duplicada.
END_FIELD	Mueve el cursor al final del campo actual.
END_PAGE	Mueve el cursor al final de la página actual.
EURO	Inserta el carácter del Euro
F1 - F22	Teclas de función F1-F22
HOME	Mueve el cursor al principio de la página actual (fila 1, col 1)
INSERT	Alterna el modo insertar/sobrescribir.
INSERT_IN_LINE	Inserta un espacio en la posición del cursor y mueve los caracteres restantes de la línea a la derecha. El carácter en la columna más a la derecha de la línea se descarta.
INSERT_IN_PAGE	Inserta un espacio en la posición del cursor y mueve los caracteres restantes de la página a la derecha. El carácter en la columna más a la derecha de cada línea se descarta.
INSERT_LINE	Inserta una nueva línea en la flecha del cursor y mueve las líneas restantes hacia abajo. La última fila de la página se descarta.
LEFT_ARROW	Mueve el cursor una posición hacia la izquierda ajustándolo de ser necesario.
LOCATE_FCC	Encuentra el carácter de control de campo siguiente en la pantalla.
MSG_WAIT	Recupera la cola de mensajes al terminal.
RETURN	Retorno de carro
RIGHT_ARROW	Mueve el cursor una posición hacia la derecha ajustándolo de ser necesario.
SOE	Inserta el carácter de Inicio de Entrada
START_OF_FIELD	Mueve el cursor al principio del campo.
START_OF_LINE	Mueve el cursor a la columna 1 de la línea actual.
TAB	Mueve el cursor a la posición de tabulación siguiente de la pantalla.
TOGGLE_COL_SEP	Alterna el atributo de separador de columna.
TOGGLE_STRIKE_THRU	Alterna el atributo de tachado en la celda de datos actual.
TOGGLE_UNDERLINE	Alterna el atributo de subrayado en la celda de datos actual.
TRANSMIT	Transmite datos de campo modificados al host.
UNLOCK	Envía la tecla UNLOCK al host.
UP	Mueve el cursor una fila hacia arriba, ajustándolo si es necesario.

DataCell

El objeto DataCell ofrece información sobre una posición particular en una pantalla del terminal.

Método	Descripción
`getPosition()`	Devuelve la posición de esta celda de datos en la pantalla. Devuelve `{Position}` La posición de la celda de datos en la pantalla.
`getChar()`	Obtiene el carácter asociado a la celda. Devuelve `{String}` El carácter asociado a la celda.
`getAttributes()`	Devuelve el conjunto de atributos especificado para esta instancia de celda de datos. Consulte AttributeSet. Devuelve `{AttributeSet}` El conjunto de atributos de esta instancia de celda de datos.
`getForegroundColor()`	Devuelve el color de primer plano, como está definido en el objeto Color, para esta celda de datos. Devuelve `{Number}` Color en primer plano de esta celda de datos. El color se define en el objeto Color.
`getBackgroundColor()`	Devuelve el color de fondo, como está definido en el objeto Color, para esta celda de datos. Devuelve `{Number}` Color de fondo de esta celda de datos. El color se define en el objeto Color.
`toString`	Convierte la celda de datos interna en una cadena. Devuelve `{String}` La representación en forma de cadena de una celda de datos.
`isFieldDelimiter()`	Comprueba si esta celda representa un delimitador de campo. Devuelve `{Boolean}` "True" (verdadero) si esta celda es un delimitador de campo; de lo contrario, "False" (falso).

Dimensión

Representa el tamaño de la pantalla o de la región de la pantalla.

Método	Descripción
`Dimension(rows,cols)`	Crea una nueva instancia Dimension Parámetros `{Number} filas` Dimensión de las filas de la pantalla. `{Number} columnas` Dimensión de las columnas de la pantalla.

Field

Utilice el objeto Field con FieldList para obtener la información presente en un campo de la pantalla.

Método	Descripción
`getAttributes()`	Devuelve el conjunto de atributos especificado para esta instancia de campo. Consulte AttributeSet. Devuelve `{AttributeSet}` El conjunto de atributos de este campo.
`getForegroundColor()`	Devuelve el color en primer plano para el campo. Devuelve `{Number}` Color en primer plano de este campo. Estos valores se definen en el objeto Color.
`getBackgroundColor()`	Devuelve el color de fondo para el campo. Devuelve `{Number}` Color de fondo de este campo. Estos valores se definen en el objeto Color.
`getStart()`	Devuelve la posición inicial del campo. La posición inicial es la posición del primer carácter del campo. Algunos tipos de host utilizan una posición de carácter para guardar los atributos de nivel de campo. En este caso, la posición del atributo no está considerada la posición inicial. Devuelve `{Position}` Posición inicial del campo. Genera `{RangeError}` Para campos de longitud cero.
`getEnd()`	Devuelve la posición final del campo. La posición final es la posición en el espacio de representación que contiene el último carácter del campo. Devuelve `{Position}` Posición final del campo. Genera `{RangeError}` Para campos de longitud cero.
`getLength()`	Devuelve la longitud del campo. Para los tipos de host que utilizan una posición de carácter para guardar los atributos de campo, la longitud del campo no incluye la posición del atributo de campo. Devuelve `{Number}` Longitud del campo.
`getDataCells()`	Obtiene las celdas de datos que comprende este campo. Consulte DataCell. Devuelve `{DataCell[]}` Las celdas de datos que comprenden este campo.
`getText()`	Obtiene el texto del campo. Devuelve `{String}` Campo de texto.
`setText()`	Establece el texto del campo. Para algunos tipos de host, como los VT, el texto se transmite al host de inmediato, pero en otros tipos de host el texto no se transmite al host hasta que se invoca una tecla de ayuda. Si el texto es más corto que el campo, el texto se coloca en el campo del host y el resto del campo se borra. Si el texto es más largo que el campo del host, se coloca tanto texto como quepa en el campo. Parámetro `{String}` Texto que se colocará en el campo. Genera `{Error}` Si el campo está protegido.
`clearField()`	Borra el campo actual de forma específica de la emulación. Genera `{Error}` Si el campo está protegido o no se admite el borrado.
`getPresentationSpace()`	Obtiene el objeto PresentationSpace que ha creado este campo. Devuelve `{PresentationSpace}` Elemento principal de esta instancia de campo.
`toString()`	Crea una descripción sencilla del campo. Devuelve `{String}` Una interpretación del campo legible por el usuario.

FieldList

Utilice el objeto FieldList junto con el objeto Field para obtener información de la lista de campos.

Método	Descripción
`getPresentationSpace()`	Obtiene el objeto PresentationSpace que ha creado este campo. Devuelve `{PresentationSpace}` Elemento principal de esta instancia de campo.
`findField(position, text, direction)`	Devuelve el campo que contiene el texto especificado. La búsqueda empieza desde la posición especificada y se realiza hacia delante o hacia detrás. Si la cadena contiene múltiples campos, se devuelve el campo que contiene la posición inicial. Cuando se busca hacia delante, la búsqueda no se ajusta a la parte superior de la pantalla. Cuando se busca hacia atrás, la búsqueda no se ajusta a la parte inferior de la pantalla. Parámetros `{Position}` Posición desde la que se debe iniciar la búsqueda. Consulte el objeto Position. `{String}` El texto a buscar (opcional). Si no se indica, devuelve el campo siguiente a la derecha o debajo de la posición especificada. `{Number}` Dirección de la búsqueda (opcional). Utilice PresentationSpace. Constantes SearchDirection para estos parámetros. Por ejemplo, PresentationSpace.SearchDirection.FORWARD o PresentationSpace.SearchDirection.BACKWARD. Si no se indica, se busca hacia delante. Devuelve `{Field}` Contiene la cadena o cero si no se encuentra un campo que cumpla los criterios especificados. Genera `{RangeError}` Si la posición está fuera del rango.
`get(index)`	Obtiene el campo en el índice dado. Parámetros `{Number}` Índice en la lista de campos. Devuelve `{Field}` Ubicado en el índice especificado. Genera `{RangeError}` Si el índice está fuera del rango.
`isEmpty()`	Determina si la lista de campos está vacía. Devuelve `{Boolean}` "True" (verdadero) si la lista está vacía.
`size()`	Indica el número de campos en la lista. Devuelve `{Number}` El número de campos.
`toString()`	Crea una descripción sencilla la lista de campos. Devuelve `{String}` Una interpretación de la lista de campos legible por el usuario.

FileTransfer

Utilice el objeto FileTransfer para listar y transferir archivos entre el sistema del host y el cliente.

La API de transferencia de archivos de Host Access for the Cloud abstrae las convenciones de ruta de archivos utilizadas por diferentes implementaciones de archivos del host. Siga los formatos de ruta de sistema de archivos URL o Linux a la hora de formatear las rutas de archivo utilizadas por la API. Por ejemplo, /root/directory/file.

Es importante observar todas las reglas específicas de los sistemas de host, como los caracteres permitidos o las longitudes de los nombres.

Nota

Los navegadores imponen importantes restricciones de seguridad sobre la capacidad de Javascript para interactuar con los sistemas de archivos de los clientes.

Método	Descripción
`getHostFileListing(remotePath)()`	Solicitar un listado de archivos de host. Si se omite `RemotePath`, se muestra un listado de archivos para el directorio de trabajo remoto actual. Parámetros `{String}` (opcional) Si se especifica, se obtiene un listado de archivos para la ruta remota especificada. Si no se especifica, se obtiene un listado de archivos para el directorio de trabajo remoto actual. Devuelve `{Promise}` Se resuelve en una matriz de objetos HostFile incluidos en remoteName. Se rechaza si la ruta remota no se puede leer.
`sendFile(localFile, remoteName)`	Envía el archivo especificado al host. Parámetros `{File}` Objeto de archivo de Javascript que señala al archivo local que se va a enviar. `{String}` (opcional) Nombre completo de archivo remoto tal y como lo permite el sistema remoto (Unix, Windows, MVS o VAX). Devuelve `{Promise}` Se cumple con un objeto `HostFile` que indica que el archivo se ha enviado correctamente. Se rechaza si se ha producido un error al enviar el archivo.
`getDownloadURL(remoteName)`	Construye un vínculo para descargar un archivo desde un sistema de host. Parámetros `{String}` Nombre completo de archivo remoto, tal y como lo permite el sistema remoto (Unix, Windows, MVS o VAX). Devuelve `{URL}` URL que se puede utilizar para recuperar el archivo desde el servidor de sesión de Host Access for the Cloud.
`setTransferOptions(options)`	Establece las opciones de transferencia para la sesión FileTransfer actual. Las opciones de transferencia se aplican a todas las transferencias futuras cuando o bien se cierra la sesión, o bien ésta se sobrescribe con otra llamada a `setTransferOptions`. Parámetros `{JSON}` Consulte FileTransferOptions para conocer los nombres y valores permitidos. Devuelve `{Promise}` Se cumple cuando finaliza la llamada. Se rechaza si se ha producido un error al configurar las opciones.
`cancelar()`	Cancela la transferencia actual en curso. Parámetros `{String}` Nombre completo de archivo remoto, tal y como lo permite el sistema remoto (Unix, Windows, MVS o VAX). Devuelve `{Promise}` Se cumple cuando finaliza la llamada. Se rechaza si se ha producido un error al cancelar la transferencia.

FileTransferFactory

Un objeto fileTransferFactory está disponible para todas las macros. Si se han configurado transferencias de archivos para la sesión, puede utilizarlas para obtener una referencia a un objeto FileTransfer.

Método	Descripción
`getIND$File()`	Devuelve un objeto FileTransfer para interactuar con el tipo Ind$File configurado para la sesión. Devuelve `{FileTransfer}` Genera `{Error}` Si la sesión no se ha configurado para permitir transferencias IND$File.

FileTransferOptions

Especificación del objeto de opción de transferencia de archivos. Ejemplo:
`fileTransfer.setTransferOptions({ transferMethod : 'ascii' });```

Método	Descripción
`transferMethod`	`{String}`Valores permitidos: ‘ascii’ ‘binario’

HostFile

Un objeto HostFile representa un archivo en el sistema de archivos del host.

Método	Descripción
`getName()`	Obtiene el nombre de archivo. Devuelve `{String}` El nombre de archivo.
`getParent()`	Obtiene el creador de este archivo del host. Devuelve `{String}` El elemento principal de este archivo del host. Esto significa cosas diferentes en tipos de host diferentes. Por ejemplo, en TSO éste es el nombre del catálogo en el que reside el archivo.
`getSize()`	El tamaño en bytes del archivo. Devuelve `{Number}` El tamaño del archivo en bytes.
`getType()`	El tipo de archivo representado. Devuelve

HostFileType

El objeto HostFileType define constantes para determinar el tipo de un objeto HostFile.

Valor	Descripción
FILE	Representa un archivo en el sistema de host.
DIR	Representa un directorio en el sistema de host.
DESCONOCIDO	Representa un archivo del host de origen desconocido.

OIA

Interfaz Operator Information Area (OIA). El objeto OIA devuelve valores que se han definido en el objeto OIAStatus.

Método	Descripción
`getStatus ()`	Devuelve el conjunto de indicadores de estado habilitado. Consulte StatusSet. Devuelve `{StatusSet}` Contiene la información de estado.
`getCommErrorCode()`	Devuelve el código de error de comunicación actual. Devuelve `{Number}` El código de error de comunicación actual. Si no existe, será 0.
`getProgErrorCode()`	Devuelve el código de error del programa actual.. Devuelve `{Number}` El código de error de programa actual. Si no existe, será 0.

OIAStatus

OIAStatus	Descripción
CONTROLLER_READY	Controlador listo
A_ONLINE	Online con una conexión no-SNA
MY_JOB	Conectada a una aplicación de host
OP_SYS	Conectada a SSCP (SNA)
UNOWNED	No conectada
TIME	Teclado inhibido
SYS_LOCK	Bloqueo del sistema tras tecla AID
COMM_CHECK	Prueba de comunicación
PROG_CHECK	Prueba de programa
ELSEWHERE	Pulsación de tecla no válido en la posición del cursor
FN_MINUS	Función no disponible
WHAT_KEY	Pulsación de tecla no válido
MORE_THAN	Demasiados caracteres ingresados en el campo
SYM_MINUS	Símbolo introducido no disponible
INPUT_ERROR	Error de entrada de operador (5250 sólo)
DO_NOT_ENTER	No introducir
INSERT	Cursor en modo insertar
GR_CURSOR	Cursor en modo gráfico
COMM_ERR_REM	Recordatorio de error de comunicación
MSG_WAITING	Indicador de mensaje en espera
ENCRYPT	La sesión está cifrada
NUM_FIELD	Carácter no válido en campo sólo numérico

Posición

Método	Descripción
`Position(row,col)`	Crea una nueva instancia Position Parámetros `{Number}` Coordenada de fila de la pantalla de filas. `{Number}` Coordenada de columna de la pantalla de columnas.

PresentationSpace

Utilice el objeto PresentationSpace para interactuar con la pantalla del terminal. Entre las interacciones disponibles están ajustar y obtener la posición del cursor y la lectura de texto.

Método	Descripción
`getCursorPosition()`	Devuelve una instancia de Position que representa la posición actual del cursor. Una sesión no conectada tiene una posición de cursor de 0,0. Devuelve `{Position}` Ubicación actual del cursor.
`setCursorPosition(position)`	Mueve el cursor del host a la posición de fila y columna especificado. En algunos hosts, como los VT, el host puede restringir los movimientos del cursor. Parámetros `{Position}` Position Nueva posición del cursor. Devuelve None Genera `{RangeError}` Si la posición no es válida en la pantalla actual.
`isCursorVisible()`	Comprueba que el cursor está actualmente visible en el espacio de presentación. El cursor se considera no visible si la sesión no está conectada. Devuelve `{Boolean}` "True" (verdadero) si el cursor está visible. False si el cursor no está visible.
`sendKeys(keys)`	Transmite una cadena de texto o ControlKey al host en la posición actual del cursor en el espacio de presentación. Si el cursor no se encuentra en la posición deseada, utilice primero la función `setCursorPosition`. La cadena de texto puede contener cualquier número de caracteres y objetos ControlKey. Por ejemplo: "myname" + `ControlKey.TAB` + "mypass" + `ControlKey.ENTER` transmitirá un ID de usuario, tabulará al campo siguiente, transmitirá una contraseña y, a continuación, transmitirá la tecla Intro. Si necesita transmitir un corchete, duplique los corchetes ([[ o ]]). Parámetros `{String}` Texto de teclas o teclas de control que se transmitirán.
`getText(start,length)`	Devuelve una cadena que representa un área lineal del espacio de presentación. Cuando se encuentran los límites de la fila, no se insertan caracteres de nueva línea. Parámetros `{Position}` Posición inicial desde la que se debe recuperar el texto. `{Number}` Longitud del número máximo de caracteres que se devolverán. Si el parámetro de longitud provoca que se supere la última posición del espacio de presentación, solo se devuelven los caracteres hasta la última posición. Devuelve `{String)` Representa un área lineal del espacio de presentación que puede estar vacía si la sesión no está conectada. Genera `{RangeError}` Si la posición o la longitud no son válidas en la pantalla actual.
`getSize()`	Obtiene las dimensiones de la pantalla como objeto Dimension. Devuelve `{Dimension}` Contiene el número de filas y columnas. El tamaño de la pantalla es [row:0, col:0] si la sesión no está conectada.
`getDataCells(start, length)`	Devuelve instancias de DataCell en las que el primer miembro será para la posición especificada por el parámetro de inicio. El número máximo de instancias DataCell en la lista viene especificado por el parámetro de longitud. Parámetros `{Position}` Inicio de la primera posición en la pantalla del host en la que se recuperan instancias de DataCell. Consulte Position. `{Number}` Longitud del número máximo de instancias de DataCell que se van a recuperar. Si no se especifica, devuelve DataCells de la posición inicial a la posición final de la pantalla. Devuelve `{DataCell[]}` Instancias que pueden estar vacías si no se ha conectado la sesión. Si la posición no está especificada, devuelve todas las DataCells. Si la longitud no se especifica, devuelve DataCells de la posición inicial a la posición final de la pantalla. Genera `{RangeError}` Si el inicio o la longitud están fuera del rango.
`getFields()`	Devuelve una lista de los campos en el espacio de presentación. Si el tipo de host no soporta campos o si la pantalla actual no está formateada el valor de retorno será siempre una lista vacía. Consulte FieldList. Devuelve `{FieldList}` Para los campos definidos del host en el espacio de presentación.

Session

El objeto Session es el punto de entrada principal para acceder al host. Contiene las funciones para conectar, desconectar y obtener el objeto PresentationSpace.

Método	Descripción
`connect()`	Conecta con el host configurado. Si es necesario, utilice `wait.forConnect()` para bloquear la ejecución de la macro hasta que la sesión esté conectada. Devuelve `None`.
`disconnect()`	Se desconecta del host configurado. Si es necesario, utilice `wait.forDisconnect()` para bloquear la ejecución de la macro hasta que la sesión esté conectada. Devuelve `None`.
`isConnected()`	Determina si la conexión con el host está establecida o no. Devuelve `{Boolean}` "True" (verdadero) si se ha establecido la conexión con el host; de lo contrario, "False" (falso).
`getPresentationSpace()`	Proporciona acceso a la instancia de PresentationSpace para esta sesión. Devuelve `{PresentationSpace}` Instancia asociada a esta sesión.
`getDeviceName()`	Devuelve el nombre del dispositivo para una sesión conectada o una cadena vacía si la sesión está desconectada o no tiene un nombre de dispositivo. Devuelve `{String}` El nombre del dispositivo conectado.
`getType()`	Devuelve el tipo de sesión de host. Véase SessionType. Devuelve `{String}` El tipo de sesión del host.
`setDeviceName()`	Aporta un medio para modificar el nombre de dispositivo en una instancia de sesión. Parámetros `{String}` name Nombre del dispositivo que se utilizará al conectarse a un host. Genera `{Error}` Si se intenta configurar el nombre de dispositivo mientras la sesión está conectada.
`getOIA()`	Proporciona acceso a la instancia de OIA para esta sesión. Devuelve `{OIA}` OIA asociada a este sesión.

SessionType

Constantes utilizadas para identificar el tipo de host al que se está realizando la conexión. Consulte el objeto Session.

Tipo de host	Descripción
IBM_3270	Indica una sesión de terminal IBM 3270
IBM_5250	Indica una sesión de terminal IBM 5250
VT	Indica una sesión VT

StatusSet

Puede utilizar el objeto StatusSet para descifrar el estado de OIA. El objeto StatusSet devuelve valores definidos en el objeto OIAStatus y, cuando se utilizan juntos, se puede obtener información de estado del OIA.

Método	Descripción
`contains(statusFlag)`	Determina si el conjunto contiene el indicador de estado especificado de constantes de OIAStatus. Parámetros `{Number}` Estado de statusFlag que se comprobará. Devuelve `{Boolean}`"True" (verdadero) si el indicador de estado está presente en el conjunto.
`isEmpty()`	Determina si el conjunto de estados está vacío. Devuelve `{Boolean}` "True" (verdadero) si el conjunto está vacío.
`size()`	Indica el número de indicadores de estado en el conjunto. Devuelve `{Number}` El número de estados.
`toArray()`	Convierte el conjunto de estados interno en una matriz. Devuelve `{Object []}` Matriz de indicadores de estado del conjunto.
`toString()`	Convierte el conjunto de estados interno en una cadena. Devuelve `{String}` Nombres delimitados por espacios de indicadores de estado en el conjunto.
`forEach(callback, thisArg)`	Función para iterar sobre cada elemento en el conjunto de estados. Parámetros `{forEachCallback}` Devolución de llamada para realizar la operación específica. Se llama con el nombre de cada estado en el conjunto.
`forEachCallback(string, thisArg)`	Una función de devolución de llamada suministrada por el usuario en la que se proporciona el comportamiento que se utilizará como parámetro de devolución de llamada a forEach. Parámetros `{String} String` El nombre de un estado en el conjunto de estado. `{Object}thisArg` Puntero opcional a un objeto de contexto.

Interfaz de usuario

El objeto de interfaz de usuario provee funciones para interactuar con el usuario, para preguntar por información básica y visualizarla. El objeto UI está disponible automáticamente en su macro como la variable “ui”.

Nota

Importante: Todas las funciones de UI requieren la palabra clave «yield» delante de ellas. Esto permite bloquear la ejecución de la macro hasta que se cumplan las condiciones para la función UI.
[parameter] denota un parámetro opcional.

Método Descripción

prompt(message,[defaultAnswer], [mask]) Se pregunta al usuario por información en la interfaz de usuario.
Parámetros
{String} Título del mensaje que se mostrará al usuario. Por defecto: cadena vacía.
{String} Respuesta por defecto que se utilizará si el usuario la deja en blanco. Valor por defecto: cadena en blanco
{Boolean} La máscara indica si se debe ocultar la solicitud (como con una contraseña).
Devuelve
{Promise} Se cumple si el usuario cierra la ventana del diálogo. Devuelve la entrada del usuario con “OK” o cero con “Cancel”.

message([message]) Muestra un mensaje en la interfaz de usuario.
Parámetros
{String} Mensaje que se mostrará al usuario. Por defecto: cadena vacía. Devuelve {Promise} Se cumple cuando el usuario cierra la ventana del mensaje.

Wait

Utilice el objeto wait para esperar una sesión particular o un estado de pantalla. Por ejemplo, puede esperar hasta que el cursor se encuentre en una posición particular o hasta que haya texto presente en una posición determinada antes de continuar con la ejecución de la macro.

Las funciones de espera se utilizan frecuentemente en combinación con funciones asíncronas como connect() y sendKeys().

Nota

Todas las funciones tienen tiempo límite como parámetro opcional y tienen un valor de tiempo límite por defecto de 10 segundos (10 000 ms).
Importante: Todas las funciones de espera requieren la clave ‘yield’ enfrente de ellas. Esto permite bloquear la ejecución de la macro hasta que se cumplan las condiciones para la función de espera.
[parameter] denota un parámetro opcional.

Método	Descripción
`setDefaultTimeout(timeout)`	Establece el valor de tiempo límite por defecto para todas las funciones. Parámetros `{Number}` Tiempo límite por defecto que se utilizará para todas las funciones de espera en milisegundos. Devuelve `{None}` Genera `{RangeError}` Si el tiempo límite especificado es inferior a cero.
`forConnect([timeout])`	Espera una solicitud de conexión para completar. Parámetros `{Number}` Tiempo en milisegundos. Devuelve `{Promise}` Se cumple si la sesión ya está conectada o cuando se realiza la conexión. Rechazada si expira el tiempo de espera.
`forDisconnect([timeout])`	Espera una solicitud de desconexión para completar. Parámetros `{Number}` Tiempo límite en milisegundos. Devuelve `{Promise}` Se cumple si la sesión ya está desconectada o cuando al fin se desconecta. Rechazada si expira el tiempo de espera.
`forFixedTime([timeout])`	Espera de forma incondicional un tiempo fijo. Tiempo en milisegundos (ms). Parámetros `{Number}` Tiempo límite en milisegundos. Devuelve `{Promise}` Se cumple una vez transcurrido el tiempo.
`forScreenChange([timeout])`	Espera a que cambie la pantalla de host. Esta función se devuelve cuando se detecta una actualización de pantalla. No ofrece garantías sobre el número de actualizaciones posteriores que pueden recibirse antes de que se complete la pantalla. Es aconsejable esperar repetidamente hasta que el contenido de la pantalla coincida con algunos criterios de detención conocidos.) Parámetros `{Number}` Tiempo límite en milisegundos. Devuelve `{Promise}` Se resuelve si la pantalla cambia. Rechazada si expira el tiempo de espera.
`forCursor(position, [timeout])`	Espera a que el cursor llegue a la posición especificada. Parámetros `{Position}` La posición que especifica la fila y la columna. Devuelve `{Promise}` Se cumple si el cursor ya se ha ubicado o si se ubica finalmente. Rechazada si expira el tiempo de espera.
`forText(text, position, [timeout])`	Espera a que el texto se encuentre en una posición específica de la pantalla. Parámetros `{String}` El texto previsto. `{Position}` La posición que especifica la fila y la columna. `{Number}` Tiempo límite en milisegundos. Devuelve `{Promise}` Se cumple si el texto ya se encuentra en la posición especificada o en cualquier otra ubicación. Rechazada si expira el tiempo de espera. Genera `{RangeError}` Si la posición no es válida.
`forHostPrompt(text, column,[timeout])`	Espera a que un símbolo de sistema esté colocado en una columna específica de la pantalla. Parámetros `{String}` Solicitud de texto prevista. `{Number}` Columna en la que se espera que se encuentre el cursor. `{Number}` Tiempo límite en milisegundos. Devuelve `{Promise}` Se cumple si ya se dan las condiciones o cuando al fin se dan. Rechazada si expira el tiempo de espera. Genera `{RangeError}` Si la columna está fuera del rango.
`forHostSettle([settleTime],[timeout])`	NOTA: `wait.forHostSettle` solo debe utilizarse cuando otras funciones de espera adicionales específicas son insuficientes. Supervisa los datos entrantes de la pantalla; resuelve settleTime ms tras la última actualización y cuando el teclado está desbloqueado. Esta función es útil cuando los datos llegan en varios paquetes y desea asegurarse de que se ha recibido toda la pantalla antes de continuar. Parámetros `{Number}` Tiempo que se esperará después de la última actualización para asegurarse de que no se reciban datos de forma inesperada. El valor por defecto es 200 milisegundos. `{Number}` tiempo de espera en milisegundos. Devuelve `{Promise}` Se cumple cuando ha transcurrido el tiempo de establecimiento tras la recepción de la última actualización de la pantalla y el teclado está desbloqueado.