Partager via

getGlobalContext.userSettings (référence de l’API client)

  • Article

Renvoie des informations sur les paramètres de l’utilisateur actuel.

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

Propriétés

L’objet userSettings contient les propriétés suivantes :

Nom  Type Description
dateFormattingInfo object Renvoie les informations de mise en forme de la date pour l’utilisateur actuel. Voir dateFormattingInfo
defaultDashboardId chaine Renvoie l’ID du tableau de bord par défaut de l’utilisateur actuel.
isGuidedHelpEnabled bool Indique si l’aide guidée est activée pour l’utilisateur actuel.
isHighContrastEnabled bool Indique si le contraste élevé est activé pour l’utilisateur actuel.
isRTL bool Indique si la langue de l’utilisateur actuel est une langue de droite à gauche (RTL).
languageId nombre Code de langue LCID de l’utilisateur actuel.
roles collecte Collection d’objets de recherche contenant le GUID et le nom complet de chacun des rôles de sécurité attribués à l’utilisateur et tous les rôles de sécurité attribués à l’équipe à laquelle l’utilisateur est associé. Voir les rôles
securityRolePrivileges string[] Tableau de chaînes qui représentent les valeurs GUID de chaque privilège de rôle de sécurité auquel l’utilisateur est associé et toutes les équipes auxquelles l’utilisateur est associé.
securityRoles string[] Déconseillé. Utilisez la propriété roles.
transactionCurrency object Objet contenant les valeurs id, name et entityType de la devise de transaction pour l’utilisateur actuel. Voir transactionCurrency
transactionCurrencyId chaine Déconseillé. Utiliser la propriété transactionCurrency
userId chaine Valeur systemuser.systemuserid de l’utilisateur actuel.
userName chaine Nom de l’utilisateur actuel.

dateFormattingInfo

Objet avec des propriétés de chaîne relatives à la mise en forme de la date, telles que FirstDayOfWeek, LongDatePattern, MonthDayPattern, TimeSeparator, etc.

rôles

La collection contient des objets avec les propriétés id et name pour chacun des rôles de sécurité ou équipes auxquels l’utilisateur est associé.

Cette propriété est uniquement prise en charge pour Unified Interface.

transactionCurrency

Cette méthode est uniquement prise en charge sur Unified Interface.

Les données peuvent ressembler à ce qui suit :

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

Méthodes

L’objet userSettings contient les méthodes suivantes :

Méthode getSecurityRolePrivilegesInfo

Renvoie une promesse qui se résout avec un objet dont les clés sont les GUID du privilège de rôle de sécurité et les valeurs sont des objets contenant businessUnitId, depth et privilegeName du privilège de rôle de sécurité.

Syntaxe

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

Paramètres

Nom Type Requise Description
successCallback Function Non Fonction à appeler si les informations de privilège de rôle de sécurité sont récupérées. Un dictionnaire est transmis au rappel de réussite où les GUID du privilège de rôle de sécurité sont les clés et les valeurs sont les objets contenant les propriétés suivantes :
id : chaîne. GUID du privilège de rôle de sécurité.
businessUnitId : chaîne. GUID de la division du privilège de rôle de sécurité.
privilegeName : chaîne. Nom du privilège de rôle de sécurité.
depth : chaîne. Profondeur du privilège de rôle de sécurité.
errorCallback Function Non Fonction à appeler lorsque l’opération échoue. Un objet avec les propriétés suivantes est transmis :
errorCode : nombre. Code d’erreur.
message : chaîne. Message d’erreur décrivant le problème.

Valeur renvoyée

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

En cas de réussite, renvoie un objet de la promesse contenant les valeurs spécifiées dans la description du paramètre successCallback ci-dessus.

Description : GUID et détails supplémentaires, comme la division et le nom du privilège de chaque privilège de rôle de sécurité.

Exemple 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éthode getTimeZoneOffsetMinutes

Renvoie la différence en minutes entre l’heure locale et le temps universel coordonné (UTC).

Syntaxe

userSettings.getTimeZoneOffsetMinutes()

Valeur renvoyée

Type : Nombre

Description : Décalage du fuseau horaire en minutes.

Contexte client
Paramètres de l’organisation
Xrm.Utility.getGlobalContext
Tables Paramètres utilisateur (UserSettings)