Introducción a la realización de operaciones globales con el objeto Xrm de API de cliente

8 minutos

La API de cliente proporciona el objeto Xrm, que está disponible globalmente en su código para realizar diversas actividades, sin tener que usar el contexto de ejecución. Desde un punto de vista de alto nivel, el siguiente diagrama ilustra todos los métodos y propiedades disponibles. Para obtener una descripción general detallada de este objeto, consulte Objeto Xrm de API de cliente.

Objeto App

Con addGlobalNotification desde el objeto Aplicación, puede mostrar errores, información, advertencias o notificaciones de éxito para una aplicación, así como especificar acciones a ejecutar en función de la notificación. Esta notificación es similar a las notificaciones de formulario, pero se puede utilizar fuera del contexto de un formulario. Por ejemplo, una secuencia de comandos de la barra de comandos podría notificar a un usuario que se ha completado una acción. Utilice el método clearGlobalNotification para borrar una notificación en la aplicación.

Objeto Device

El objeto Xrm.Device ofrece capacidades nativas de dispositivos relacionadas con las interacciones de dispositivos móviles, con la excepción del método pickFile, que también es accesible a través de clientes web. Las aplicaciones de lienzo también proporcionan un marco extensible para el desarrollo móvil y deben tenerse en cuenta en estos escenarios. En la siguiente tabla se incluye un resumen de los métodos disponibles en el objeto Xrm.Device.

Método	Descripción
captureAudio	Llama al micrófono del dispositivo para grabar audio.
captureImage	Llama a la cámara del dispositivo para capturar una imagen.
captureVideo	Llama a la cámara del dispositivo para grabar un vídeo.
getBarcodeValue	Llama a la cámara del dispositivo para escanear la información del código de barras, como un número de producto.
getCurrentPosition	Devuelve la ubicación actual mediante la capacidad de geolocalización de dispositivos.
pickFile	Abre un cuadro de diálogo para seleccionar archivos del equipo (cliente web) o dispositivo móvil (clientes móviles).

Según la configuración del dispositivo, algunas funciones no están disponibles. También es posible que se requiera el consentimiento del usuario para que la aplicación pueda acceder a capacidades específicas del dispositivo. Por ejemplo, el usuario puede haber deshabilitado globalmente las capacidades de ubicación del dispositivo o haber rechazado el acceso a la cámara de la aplicación. Al desarrollar una aplicación, tenga en cuenta que cualquiera de estos métodos puede fallar debido a las capacidades del dispositivo, la configuración, la falta de permisos o el consentimiento.

Objeto Encoding

Puede utilizar el objeto Xrm.Encoding se usa para codificar y descodificar cadenas XML y HTML. Esta codificación y descodificación puede resultar valiosa en las siguientes situaciones:

Interacción con recursos web HTML.
Codificación y descodificación de parámetros de cadenas de consulta.
Interacción con un FetchXML que contiene caracteres especiales, como '&' o '<', en una cadena de búsqueda.

El objeto Navigation proporciona métodos relacionados con la navegación que puede usar en las aplicaciones basadas en modelos. Debido a su naturaleza de bloqueos, las actividades como mostrar cuadros de diálogo de alerta, confirmación y error no se consideran una experiencia de usuario óptima, pero siguen estando disponibles para su uso. En estos escenarios, le recomendamos plantearse el uso de notificaciones de formulario u otros mecanismos que no bloqueen para advertir a los usuarios de un problema. A continuación aparece un resumen de los métodos disponibles en el objeto Xrm.Navigation.

Método	Descripción
openAlertDialog	Muestra un cuadro de diálogo de alerta que contiene un mensaje y un botón.
openConfirmDialog	Muestra un cuadro de diálogo de confirmación que contiene un mensaje y dos botones.
openErrorDialog	Muestra un cuadro de diálogo de error.
openFile	Abre un archivo.
openForm	Abre un formulario de tabla o un formulario de creación rápida.
openUrl	Abre una dirección URL, incluidas las direcciones URL de los archivos.
openWebResource	Abre un recurso web HTML.

Objeto Panel

El objeto Xrm.Panel proporciona un método para mostrar una página web en el panel lateral del formulario de aplicación basada en modelo. Esta característica actualmente se encuentra en versión preliminar y no se trata en detalle aquí. Para obtener más información, consulte Xrm.Panel.

Objeto Utility

El objeto Xrm.Utility es un contenedor para diversos métodos útiles. La siguiente tabla es un resumen de los métodos disponibles en el objeto Xrm.Utility. Para obtener más información, consulte Xrm.Utility (referencia de la API de cliente)

Método	Descripción
closeProgressIndicator	El indicator cierra un cuadro de diálogo de progreso que se abrió con showProgressIndicator.
getAllowedStatusTransitions	Devuelve las transiciones de estado válidas para la tabla y el código de estado especificados.
getEntityMetadata	Devuelve los metadatos de entidad de la entidad especificada.
getGlobalContext	Obtiene el contexto global que puede proporcionarle información de runtime, incluida la configuración de la organización, la configuración del usuario, la aplicación y la información del cliente.
getLearningPathAttributeName	Devuelve el nombre del atributo DOM que espera el diseñador de contenido de la ruta de aprendizaje (ayuda guiada) para identificar los controles de la UI en los formularios de las aplicaciones basadas en modelos.
getResourceString	Devuelve la cadena localizada para una clave determinada asociada al recurso web especificado.
invokeProcessAction	Llama a una acción según los parámetros especificados. Este método también podría usarse para llamar a API personalizadas creadas por sus desarrolladores.
lookupObjects	Abre un control de búsqueda para seleccionar uno o más elementos.
refreshParentGrid	Actualiza la cuadrícula primaria que contiene el registro especificado.
showProgressIndicator	Muestra un cuadro de diálogo de progreso con el mensaje especificado.

También hay muchos métodos que no figuran aquí que podrían aparecer en algún código anterior, actualmente en desuso, porque se han movido al espacio de nombres Xrm.Navigation. Si se encuentra con estos métodos, debe actualizar el código para usar los nuevos métodos Xrm.Navigation.

Objeto Xrm.WebApi

El objeto Xrm.WebApi proporciona propiedades y métodos para usar la API web para operaciones CRUD tradicionales en un script de cliente. Cuando utilice la Xrm.WebAPI, en su lógica de script, las operaciones que realice se llevarán a cabo automáticamente en el contexto del usuario actual de la aplicación. Puede utilizar la API web cuando la aplicación está en línea y fuera de línea (si configura el entorno para fuera de línea). El espacio de nombres incluye un conjunto específico de métodos en línea y desconectados; sin embargo, el uso de estos métodos requiere realizar un seguimiento del estado del cliente. Si usa Xrm.WebAPI o Xrm.WebAPI.createRecord, la API determina si debe usar por usted los métodos de espacio de nombres en línea o desconectados.

La siguiente tabla es un resumen de los métodos disponibles en el objeto Xrm.WebApi. Para obtener más información, consulte Xrm.WebApi (referencia de la API de cliente).

Método	Descripción
createRecord	Crea una fila de tabla.
deleteRecord	Elimina una fila de tabla utilizando el id. de la fila.
retrieveRecord	Recupera una fila utilizando el id. de la fila.
retrieveMultipleRecords	Recupera una colección de filas de tabla que coinciden con las opciones de consulta o FetchXML proporcionado.
updateRecord	Actualiza una fila de tabla.
isAvailableOffline	Devuelve un valor booleano que indica si una tabla está presente en un perfil del usuario y está disponible en modo desconectado.
ejecutar	Ejecuta una única acción, función u operación CRUD.
executeMultiple	Ejecuta una colección de acciones, funciones u operaciones CRUD.

Con las propiedades y métodos del objeto Xrm puede automatizar los procesos comerciales y mejorar la experiencia general del usuario.