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

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

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

L’objet userSettings fournit les propriétés suivantes et une méthode.

dateFormattingInfo

Renvoie les informations de mise en forme de la date pour l’utilisateur actuel.

Syntaxe

userSettings.dateFormattingInfo

Valeur renvoyée

Type : Objet

Description : objet comportant les informations de mise en forme de la date telles que FirstDayOfWeek, LongDatePattern, MonthDayPattern, TimeSeparator, etc.

defaultDashboardId

Renvoie l’ID du tableau de bord par défaut de l’utilisateur actuel.

Syntaxe

userSettings.defaultDashboardId

Valeur renvoyée

Type : Chaîne

Description : ID du tableau de bord par défaut.

isGuidedHelpEnabled

Indique si l’aide guidée est activée pour l’utilisateur actuel.

Syntaxe

userSettings.isGuidedHelpEnabled

Valeur renvoyée

Type : booléen

Description : true si activé ; false sinon.

isHighContrastEnabled

Indique si le contraste élevé est activé pour l’utilisateur actuel.

Syntaxe

userSettings.isHighContrastEnabled

Valeur renvoyée

Type : booléen

Description : true si activé ; false sinon.

isRTL

Indique si la langue de l’utilisateur actuel est une langue de droite à gauche (RTL).

Syntaxe

userSettings.isRTL

Valeur renvoyée

Type : booléen

Description: true si RTL ; false sinon.

languageId

Renvoie l’ID de langue de l’utilisateur actuel.

Syntaxe

userSettings.languageId

Valeur renvoyée

Type : Nombre

Description : ID de langue.

rôles

Renvoie une collection d’objets de recherche contenant le GUID et le nom d’affichage de chaque rôle de sécurité attribué à l’utilisateur et tous les rôles de sécurité attribués à l’équipe à laquelle l’utilisateur est associé. Cette méthode est uniquement prise en charge sur Unified Interface.

Syntaxe

userSettings.roles

Valeur renvoyée

Type : Collection

Description : object contenant l’id et le name de chacun des rôles de sécurité ou des équipes auxquelles l’utilisateur est associé.

securityRolePrivileges

Renvoie un tableau de chaînes qui représente les valeurs GUID de chaque privilège de rôle de sécurité attribué à l’utilisateur et à toutes les équipes auxquelles l’utilisateur est associé.

Notes

Cette API n’est pas disponible pour les déploiements locaux Dynamics 365 Customer Engagement. En savoir plus : API client non prises en charge dans Customer Engagement (on-premises)

Syntaxe

userSettings.securityRolePrivileges

Valeur renvoyée

Type : Tableau.

Description : valeurs GUID de chaque privilège de rôle de sécurité.

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 : Numéro. 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

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

Renvoie un tableau de chaînes qui représente les valeurs GUID de chaque rôle de sécurité ou équipe auxquels l’utilisateur est associé.

Obsolète ; utilisez userSettings.roles à la place, pour afficher les noms d’affichage des rôles de sécurité ou des équipes avec l’ID.

Syntaxe

userSettings.securityRoles

Valeur renvoyée

Type : Tableau.

Description : valeurs GUID de chaque rôle de sécurité. Par exemple :

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

transactionCurrency

Renvoie un objet de recherche contenant l’ID, le nom d’affichage et le type de table de la devise de transaction de l’utilisateur actuel. Cette méthode est uniquement prise en charge sur Unified Interface.

Syntaxe

userSettings.transactionCurrency

Valeur renvoyée

Type : Objet de recherche

Description : Objet contenant l’id, le name, et le entityType de la devise de transaction. Par exemple :

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

transactionCurrencyId

Renvoie l’ID de devise de transaction de l’utilisateur actuel.

Obsolète ; utilisez userSettings.transactionCurrency à la place pour accéder au nom d’affichage ainsi qu’à l’ID.

Syntaxe

userSettings.transactionCurrencyId

Valeur renvoyée

Type : Chaîne

Description : ID de devise de transaction.

userId

Renvoie le GUID de la valeur SystemUser.Id pour l’utilisateur actuel.

Syntaxe

userSettings.userId

Valeur renvoyée

Type : Chaîne

Description : L’ID de l’utilisateur. Par exemple :

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

userName

Renvoie le nom de l’utilisateur actuel.

Syntaxe

userSettings.userName

Valeur renvoyée

Type : Chaîne

Description : Nom de l’utilisateur actuel.

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.

Articles associés

Contexte client
Paramètres de l’organisation
Xrm.Utility.getGlobalContext

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).