Contexto del lado del cliente (referencia del lado del cliente)

  • Artículo

 

Publicado: noviembre de 2016

Se aplica a: Dynamics CRM 2015

El código necesitará operar en un contexto donde varias variables no son conocidas en tiempo de diseño. El objeto de contexto proporciona métodos para recuperar información específica de una organización, un usuario o parámetros que se pasan a una página.

El objeto de contexto está disponible en formularios haciendo referencia a Xrm.Page.context.

Para los recursos web ejecutados fuera de un formulario, use Función GetGlobalContext para recuperar un objeto de contexto.

Propiedades y métodos de contexto

  • client
    Proporciona acceso a los métodos getClient, getClientState y getFormFactor que puede usar para determinar qué cliente se usa, si el cliente está conectado al servidor y qué tipo de dispositivo se está utilizando.

  • getClientUrl
    Devuelve la URL base que se usó para acceder a la aplicación.

  • getCurrentTheme
    Devuelve una cadena que representa el tema actual de Microsoft Office Outlook elegido por el usuario.

  • getIsAutoSaveEnabled
    Devuelve si el autoguardado está habilitada para la organización.

  • getOrgLcid
    Devuelve el valor del identificador del código de idioma (LCID) que representa el idioma base de la organización.

  • getOrgUniqueName
    Devuelve el valor de texto único del nombre de la organización.

  • getQueryStringParameters
    Devuelve un objeto de diccionario de pares de valores clave que representa los argumentos de cadena de consulta que se pasaron a la página.

  • getTimeZoneOffsetMinutes
    Devuelve la diferencia entre la hora local y el Horario universal coordinado (UTC).

    Este método se introdujo con Actualización 1 de Microsoft Dynamics CRM Online 2015.

  • getUserId
    Devuelve el GUID del valor de SystemUser.Id para el usuario actual.

  • getUserLcid
    Devuelve el valor de LCID que representa el idioma provisionado que el usuario seleccionó como su idioma preferido.

  • getUserName
    Devuelve el nombre del usuario actual.

  • getUserRoles
    Devuelve una matriz de cadenas que represente los valores de GUID de cada rol de seguridad con el que está asociado el usuario o cualquier equipo al que está asociado el usuario.

  • prependOrgName
    Antepone el nombre de la organización a la ruta especificada.

  • Métodos quitados
    Los métodos quitados están obsoletos o sustituidos con otros métodos. Debe asegurarse de que estos métodos no se usan en sus scripts.

    Los métodos getAuthenticationHeader y getServerUrl quedaron obsoletos con Microsoft Dynamics CRM 2011 y ya no se muestran en Microsoft Dynamics CRM 2015 y actualización de Microsoft Dynamics CRM Online 2015.

    Los métodos isOutlookClient y isOutlookOnline quedaron obsoletos con Microsoft Dynamics CRM 2013 y ya no se muestran en Microsoft Dynamics CRM 2015 y actualización de Microsoft Dynamics CRM Online 2015.

client

Microsoft Dynamics CRM 2013 y Microsoft Dynamics CRM Online agregó el objeto de cliente que contiene los métodos getClient y getClientState para obtener información sobre el cliente.

Actualización 1 de Microsoft Dynamics CRM Online 2015 agregó el método getFormFactor.

getClient

Devuelve un valor que indica el cliente en que se ejecuta el script.

context.client.getClient()

Use esto en lugar del método eliminado isOutlookClient.

  • Valor de retorno
    Tipo: Cadena

    Los valores devueltos son:

    Cliente

    Valor

    Explorador

    Web

    Outlook

    Outlook

    Móvil

    Móvil

getClientState

Use esto en lugar del método eliminado isOutlookClient.

Devuelve un valor para indicar el estado del cliente.

context.client.getClientState()

  • Valor de retorno
    Tipo: Cadena

    Los posibles valores devueltos son:

    Cliente

    Valores devueltos

    Web, Outlook, Mobile

    OnLine

    Outlook, Mobile

    Desconectado

getFormFactor

Use este método para obtener la información acerca del tipo de dispositivo que el usuario está usando.

context.client.getFormFactor()

  • Valor de retorno
    Tipo: Número

    Los posibles valores devueltos son:

    Valor

    Factor de formulario

    0

    Desconocido

    1

    Escritorio

    2

    Tableta

    3

    Teléfono

  • Comentarios
    Este método se introdujo con Actualización 1 de Microsoft Dynamics CRM Online 2015

getClientUrl

Devuelve la dirección URL base que se usó para acceder a la aplicación.

context.getClientUrl()

Use esto en lugar del método eliminado getServerUrl.

Los valores devueltos se asemejarán a los que se muestran en la tabla siguiente.

Cliente

Valor

Microsoft Dynamics CRM (local)

http(s)://server/org

Microsoft Dynamics CRM Online

https://org.crm.dynamics.com

Microsoft Dynamics CRM para Outlook con acceso sin conexión sin conexión

https://localhost:2525
  • Valor de retorno
    Tipo: Cadena

getCurrentTheme

Devuelve una cadena que representa el tema actual de Microsoft Office Outlook elegido por el usuario.

Nota

Esta función no funciona con Microsoft Dynamics CRM para tabletas.

context.getCurrentTheme()
  • Valor de retorno
    Tipo: Cadena

Use esta información para seleccionar un tema adecuado para los recursos web HTML y Silverlight cuando se ven en Microsoft Dynamics CRM para Outlook. La siguiente tabla muestra los valores que se pueden devolver desde este método.

Nota

Los formularios no se adaptan a los cambios en el tema de Microsoft Office, por lo que el único caso donde puede que desee adaptar a los temas de Microsoft Office es cuando se muestra una página en la navegación mediante un recurso web HTML. Incluso en este escenario, las diferencias visuales pueden ser difíciles de detectar.

Valor

Tema

default

Aplicación web de Microsoft Dynamics 365

Office12Blue

Tema Microsoft Dynamics CRM para Outlook 2007 o 2010 Blue

Office14Silver

Tema Microsoft Dynamics CRM para Outlook 2007 o 2010 Silver o Black

getIsAutoSaveEnabled

Este método es nuevo para Microsoft Dynamics CRM 2015 y actualización de Microsoft Dynamics CRM Online 2015

Devuelve si el autoguardado está habilitada para la organización.

context.getIsAutoSaveEnabled()

  • Valor de retorno
    Tipo: Booleano

    Nota

    Esta característica devuelve el valor establecido cuando se abre la página. Cuando pruebe código utilizando este valor, debe actualizar la página tras modificar el valor para obtener el nuevo valor.

    Más información:TechNet: Administrar el autoguardado.

getOrgLcid

Devuelve el valor del LCID que representa el idioma base de la organización.

context.getOrgLcid()

getOrgUniqueName

Devuelve el valor de texto único del nombre de la organización.

context.getOrgUniqueName()

  • Valor de retorno
    Tipo: Cadena

    Ejemplo: Corresponde al valor del nombre de la organización

    "adventureworkscycle"

getQueryStringParameters

Devuelve un objeto de diccionario de pares de valores clave que representa los argumentos de cadena de consulta que se pasaron a la página.

context.getQueryStringParameters()
  • Valor de retorno
    Tipo: Objeto

getTimeZoneOffsetMinutes

Devuelve la diferencia entre la hora local y el Horario universal coordinado (UTC).

Nota

Este método se introdujo con Actualización 1 de Microsoft Dynamics CRM Online 2015.

context.getTimeZoneOffsetMinutes()
  • Valor de retorno
    Tipo: Número

getUserId

Devuelve el GUID del valor de SystemUser.Id para el usuario actual.

context.getUserId()

  • Valor de retorno
    Tipo: Cadena

    Ejemplo:

    "{B05EC7CE-5D51-DF11-97E0-00155DB232D0}"

getUserLcid

Devuelve el valor de LCID que representa el Paquete de idioma de Microsoft Dynamics CRM que el usuario seleccionó como su idioma preferido.

context.getUserLcid()

getUserName

Devuelve el nombre del usuario actual.

context.getUserName()
  • Valor de retorno
    Tipo: Cadena

getUserRoles

Devuelve una matriz de cadenas que represente los valores de GUID de cada rol de seguridad con el que está asociado el usuario o cualquier equipo al que está asociado el usuario.

Para obtener más información acerca de los roles de seguridad, consulte Cómo se puede usar la seguridad basada en roles para controlar el acceso a las entidades de Microsoft Dynamics CRM 2015.

context.getUserRoles()

  • Valor de retorno
    Tipo: Matriz

    Ejemplo: Este usuario solo tiene un rol de seguridad asociado a su cuenta de usuario. La representación JSON de esta matriz con un solo valor es:

    ["cf4cc7ce-5d51-df11-97e0-00155db232d0"]

prependOrgName

Antepone el nombre de la organización a la ruta especificada.

context.prependOrgName(sPath)

  • Argumentos
    Tipo: Cadena

    Una ruta local a un recurso.

  • Valor de retorno
    Tipo: Cadena

    El valor devuelto sigue a este modelo:

    "/"+ OrgName + sPath

Métodos quitados

Los métodos quitados están obsoletos o sustituidos con otros métodos. Debe asegurarse de que estos métodos no se usan en sus scripts.

Los siguientes métodos quedaron obsoletos con versiones anteriores de Microsoft Dynamics 365 y ya no están presentes en la versión actual:

  • getAuthenticationHeader
    Este método permitía el uso de los servicios web de Microsoft Dynamics CRM 4.0, que ya no existen.

  • getServerUrl
    Este método fue reemplazado por getClientUrl.

  • isOutlookClient
    Este método fue reemplazado por client.getClient.

  • isOutlookOnline
    Este método fue reemplazado por client.getClientState.

Ver también

Función GetGlobalContext y ClientGlobalContext.js.aspx (referencia del lado del cliente)
Referencia de scripting de formularios
Escriba código para formularios de Microsoft Dynamics CRM 2015
Use el modelo de objeto Xrm.Page
Referencia de programación del lado del cliente

© 2017 Microsoft. Todos los derechos reservados. Copyright