Compartilhar via


getGlobalContext.userSettings (referência da API do cliente)

Retorna informações sobre as configurações atuais do usuário.

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

Propriedades

O objeto userSettings tem as seguintes propriedades:

Nome Tipo Description
dateFormattingInfo objeto Retorna as informações de formatação de data para o usuário atual. Consulte dateFormattingInfo
defaultDashboardId cadeia Retorna a ID do painel padrão para o usuário atual.
isGuidedHelpEnabled bool Se a ajuda guiada está habilitada para o usuário atual.
isHighContrastEnabled bool Se o alto contraste está habilitado para o usuário atual.
isRTL bool Se o idioma do usuário atual é um idioma da direita para a esquerda (RTL).
languageId número O código de linguagem LCID para o usuário atual.
roles coleção Uma coleção de objetos de pesquisa que contém o GUID e o nome de exibição de cada uma das funções de segurança atribuídas ao usuário e quaisquer funções de segurança atribuídas à equipe à qual o usuário está associado. Ver funções
securityRolePrivileges cadeia de caracteres[] uma matriz de cadeias de caracteres que representam os valores GUID de cada um dos privilégios de função de segurança ao qual o usuário está associado ou quaisquer equipes às quais o usuário esteja associado.
securityRoles cadeia de caracteres[] Preterido. Use a roles propriedade.
transactionCurrency objeto Objeto que contém o id, namee entityType da moeda de transação para o usuário atual. Consulte transactionCurrency
transactionCurrencyId cadeia Preterido. Usar a transactionCurrency propriedade
userId cadeia O valor systemuser.systemuserid do usuário atual.
userName cadeia O nome do usuário atual.

dateFormattingInfo

Um objeto com propriedades de cadeia de caracteres sobre a formatação de data, como FirstDayOfWeek, LongDatePattern, MonthDayPatterne TimeSeparatorassim por diante.

funções

A coleção contém objetos e idname propriedades para cada uma das funções de segurança ou equipes às quais o usuário está associado.

Essa propriedade tem suporte apenas na Interface Unificada.

transactionCurrency

Esse método só tem suporte na Interface Unificada.

Os dados podem ser semelhantes a este:

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

Methods

O userSettings objeto tem os seguintes métodos:

Método getSecurityRolePrivilegesInfo

Retorna uma promessa que é resolvida com um objeto cujas chaves são os GUIDs de privilégio de função de segurança e os valores são objetos que contêm o businessUnitIddepthprivilégio de função de segurança.privilegeName

Sintaxe

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

Parâmetros

Nome Tipo Obrigatório Description
successCallback Função Não Uma função a ser chamada quando as informações de privilégios da função de segurança são recuperadas. Um dicionário será passado para o retorno de chamada de êxito em que os GUIDs de privilégio de função de segurança serão as chaves e os valores serão objetos que contêm as seguintes propriedades:
id:Corda. O GUID de privilégio de função de segurança.
businessUnitId:Corda. O GUID da unidade de negócios do privilégio de função de segurança.
privilegeName:Corda. O nome do privilégio da função de segurança.
depth:Corda. A profundidade do privilégio da função de segurança.
errorCallback Função Não Uma função a ser chamada quando a operação falhar. Um objeto com as seguintes propriedades será passado:
errorCode:Número. O código de erro.
message:Corda. Uma mensagem de erro descrevendo o problema.

Valor de retorno

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

Com êxito, retorna um objeto promise contendo os valores especificados na descrição do parâmetro successCallback acima.

Descrição: GUID e detalhes adicionais, como Unidade de Negócios e Nome do Privilégio de cada um dos privilégios de função de segurança.

Exemplo getSecurityRolePrivilegesInfo

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);
  });

Método getTimeZoneOffsetMinutes

Retorna a diferença em minutos entre a hora local e o UTC (Tempo Universal Coordenado).

Sintaxe

userSettings.getTimeZoneOffsetMinutes()

Valor de retorno

Tipo: número

Descrição: deslocamento de fuso horário em minutos.

Contexto do cliente
Configurações da organização
Xrm.Utility.getGlobalContext
Tabela Configurações do Usuário (UserSettings)