Partilhar 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 userSettings objeto tem as seguintes propriedades:

Nome Tipo Description
dateFormattingInfo objecto Retorna as informações de formatação de data para o usuário atual. Ver dateFormattingInfo
defaultDashboardId cadeia (de caracteres) 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 idioma LCID para o usuário atual.
roles coleção Uma coleção de objetos de pesquisa contendo 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 string[] uma matriz de cadeias de caracteres que representam os valores GUID de cada um dos privilégios de função de segurança aos quais o usuário está associado ou quaisquer equipes às quais o usuário está associado.
securityRoles string[] Deprecated. Use a roles propriedade.
transactionCurrency objecto Objeto que contém o id, namee entityType da moeda da transação para o usuário atual. Ver transactionCurrency
transactionCurrencyId cadeia (de caracteres) Deprecated. Use a transactionCurrency propriedade
userId cadeia (de caracteres) O valor systemuser.systemuserid do usuário atual.
userName cadeia (de caracteres) O nome do usuário atual.

dateFormattingInfo

Um objeto com propriedades de cadeia de caracteres sobre formatação de data, como FirstDayOfWeek, LongDatePattern, MonthDayPattern, TimeSeparatore assim por diante.

roles

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

Esta propriedade é suportada apenas na Interface Unificada.

moedaTransação

Este método é suportado apenas na Interface Unificada.

Os dados podem ter esta aparência:

{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 e valores de privilégio de função de segurança são objetos que contêm o businessUnitId, depthe privilegeName do privilégio de função de segurança.

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 sucesso, onde os GUIDs de privilégio da função de segurança serão as chaves e os valores serão objetos contendo as seguintes propriedades:
id: String. O GUID de privilégio da função de segurança.
businessUnitId: String. O GUID da unidade de negócios do privilégio de função de segurança.
privilegeName: String. O nome do privilégio da função de segurança.
depth: String. A profundidade do privilégio da função de segurança.
errorCallback Função Não Uma função para chamar quando a operação falhar. Um objeto com as seguintes propriedades será passado:
errorCode: Número. O código de erro.
message: String. Uma mensagem de erro descrevendo o problema.

Valor de retorno

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

No ê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 de Privilégio de cada um dos privilégios de função de segurança.

Exemplo de 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

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

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)