getGlobalContext.userSettings (Referencia de API de cliente)

Devuelve la información sobre la configuración del usuario actual.

var userSettings = Xrm.Utility.getGlobalContext().userSettings

El objeto userSettings proporciona las siguientes propiedades y un método.

dateFormattingInfo

Devuelve la información del formato de fecha para el usuario actual.

Sintaxis

userSettings.dateFormattingInfo

Valor de retorno

Tipo: Objeto

Descripción: un objeto con información sobre el formato de fecha como FirstDayOfWeek, LongDatePattern, MonthDayPattern, TimeSeparator, etc.

defaultDashboardId

Devuelve el Id. del panel predeterminado para el usuario actual.

Sintaxis

userSettings.defaultDashboardId

Valor devuelto

Tipo: Cadena

Descripción: Id. del panel predeterminado.

isGuidedHelpEnabled

Indica si la ayuda guiada está habilitada para el usuario actual.

Sintaxis

userSettings.isGuidedHelpEnabled

Valor devuelto

Tipo: Booleano

Descripción: verdadero si se habilita; falso en caso contrario.

isHighContrastEnabled

Indica si el contraste alto está habilitado para el usuario actual.

Sintaxis

userSettings.isHighContrastEnabled

Valor devuelto

Tipo: Booleano

Descripción: verdadero si se habilita; falso en caso contrario.

isRTL

Indica si el idioma para el usuario actual es un idioma que se escribe de derecha a izquierda (RTL).

Sintaxis

userSettings.isRTL

Valor devuelto

Tipo: Booleano

Descripción: verdadero si es RTL; falso en caso contrario.

languageId

Devuelve el Id. de idioma para el usuario actual.

Sintaxis

userSettings.languageId

Valor devuelto

Tipo: Número

Descripción: Id. de idioma.

roles

Devuelve una colección de objetos de búsqueda que contienen el GUID y nombre de cada uno de los rol de seguridad asignados al usuario y los roles de seguridad asignados al equipo al que está asociado el usuario. Este método sólo se admite en la Interfaz unificada.

Sintaxis

userSettings.roles

Valor devuelto

Tipo: colección

Descripción: objeto que contiene id y name de cada uno de los roles de seguridad o equipos con los que está asociado el usuario.

securityRolePrivileges

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

Nota

Esta API no está disponible para implementaciones locales de Dynamics 365 Customer Engagement. Más información: API de cliente no admitidas en Customer Engagement (on-premises)

Sintaxis

userSettings.securityRolePrivileges

Valor devuelto

Tipo: Matriz

Descripción: valores GUID de cada uno de los privilegios de rol de seguridad.

getSecurityRolePrivilegesInfo()

Devuelve una promesa que se resuelve con un objeto cuyas claves son los GUID de privilegio rol de seguridad y los valores son objetos que contienen el businessUnitId, depth, y privilegeName del privilegio rol de seguridad.

Sintaxis

userSettings.getSecurityRolePrivilegesInfo().then(successCallback, errorCallback);

Parámetros

Name	Type	Obligatorio	Description
successCallback	Function	No	Una función para llamar cuando se recupera la información de privilegios rol de seguridad. Se pasará un diccionario a la devolución de llamada exitosa donde los GUID de privilegio rol de seguridad serán las claves y los valores serán objetos que contienen las siguientes propiedades: id: Cadena. El privilegio del rol de seguridad GUID. businessUnitId: Cadena. El GUID de la unidad de negocio del privilegio rol de seguridad. privilegeName: Cadena. El privilegio del rol de seguridad nombre. depth: Cadena. Profundidad del privilegio del rol de seguridad.
errorCallback	Function	No	Una función a la que se llama cuando la operación tiene error. Se pasará un objeto con las siguientes propiedades: errorCode: Número. Código de error. message: Cadena. Un mensaje de error que describe el problema.

Valor devuelto

Tipo: Promise<{[key: string]: {id: string, businessUnitId: string, privilegeName: string, depth: number}}>

En caso de éxito, devuelve un objeto promesa que contiene los valores especificados en la descripción del parámetro successCallback anterior.

Descripción: GUID y detalles adicionales como la unidad de negocio y el nombre de privilegio de cada uno de los privilegios rol de seguridad.

Ejemplo

userSettings
  .getSecurityRolePrivilegesInfo()
  .then(function success(rolePrivileges) {
    var privilegeGuids = Object.keys(rolePrivileges);
    console.log("Privileges Count: " + privilegeGuids.length);

    // Print information about the first role privilege in the dictionary
    var guid = privilegeGuids[0];
    console.log("Privilege Id: " + rolePrivileges[guid].id);
    console.log("Privilege Name: " + rolePrivileges[guid].privilegeName);
    console.log("Privilege Business Unit Id: " + rolePrivileges[guid].businessUnitId);
    console.log("Privilege depth: " + rolePrivileges[guid].depth);
  });

securityRoles

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

Obsoleto; utilizar userSettings.roles en su lugar para ver los nombres para mostrar de los roles de seguridad o equipos junto con el identificador.

Sintaxis

userSettings.securityRoles

Valor devuelto

Tipo: Matriz

Descripción: valores GUID de cada rol de seguridad. Por ejemplo:

["0d3dd20a-17a6-e711-a94e-000d3a1a7a9b", "ff42d20a-17a6-e711-a94e-000d3a1a7a9b"]

transactionCurrency

Devuelve un objeto de búsqueda que contiene el identificador, el nombre para mostrar y el tipo de tabla de la divisa de la transacción para el usuario actual. Este método sólo se admite en la Interfaz unificada.

Sintaxis

userSettings.transactionCurrency

Valor devuelto

Tipo: objeto de búsqueda

Descripción: objeto que contiene el id, name y entityType de la moneda de la transacción. Por ejemplo:

{id: "e7dd9bc6-d239-ea11-a813-000d3a35b14a", entityType: "transactioncurrency", name: "US Dollar"}

transactionCurrencyId

Devuelve el Id. de la divisa de la transacción para el usuario actual.

Obsoleto; utilizar userSettings.transactionCurrency en su lugar para acceder al nombre junto con el identificador.

Sintaxis

userSettings.transactionCurrencyId

Valor devuelto

Tipo: Cadena

Descripción: Id. de la divisa de la transacción.

userId

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

Sintaxis

userSettings.userId

Valor devuelto

Tipo: Cadena

Descripción: el Id. del usuario. Por ejemplo:

"{75B5BA27-FD41-4D45-8E3A-C8446C95F0CC}"

userName

Devuelve el nombre del usuario actual.

Sintaxis

userSettings.userName

Valor devuelto

Tipo: Cadena

Descripción: nombre del usuario actual.

Método getTimeZoneOffsetMinutes

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

Sintaxis

userSettings.getTimeZoneOffsetMinutes()

Valor devuelto

Tipo: número

Descripción: desplazamiento de huso horario en minutos.

Artículos relacionados

Contexto de cliente
Configuración de organización
Xrm.Utility.getGlobalContext

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).