Contexte côté client (référence côté client)

Date de publication : janvier 2017

S’applique à : Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Votre code doit fonctionner dans un contexte où un certain nombre de variables ne sont pas connues au moment de la création. L'objet de contexte fournit des méthodes pour récupérer des informations spécifiques à une organisation, à un utilisateur ou à des paramètres qui ont été transmis à une page.

L'objet de contexte est disponible dans les formulaires en référençant Xrm.Page.context.

Pour obtenir des ressources Web exécutées en dehors d'un formulaire, utilisez la Fonction GetGlobalContext pour récupérer un objet de contexte.

Propriétés et méthodes relatives au contexte

• client
  Donne accès aux méthodes getClient, getClientState et getFormFactor que vous pouvez utiliser pour déterminer le client utilisé, si celui-ci est connecté au serveur et le type d'appareil utilisé.

• getClientUrl
  Renvoie l'URL de base qui a été utilisée pour accéder à l'application.

• getCurrentTheme
  Renvoie une chaîne représentant le thème Microsoft Office Outlook actuel sélectionné par l'utilisateur.

• getIsAutoSaveEnabled
  Renvoie si l'enregistrement automatique est activé pour l'organisation.

• getOrgLcid
  Renvoie la valeur de l'identificateur du code de langue (LCID) représentant la langue de base de l’organisation.

• getOrgUniqueName
  Renvoie la valeur de texte unique du nom de l'organisation.

• getQueryStringParameters
  Renvoie un objet de dictionnaire de paires clé-valeur représentant des arguments de chaîne de requête qui ont été transmis à la page.

• getTimeZoneOffsetMinutes
  Renvoie la différence entre l'heure locale et le temps universel coordonné (UTC).

  Cette méthode a été introduite dans Mise à jour 1 de Microsoft Dynamics CRM Online 2015.

• getUserId
  Renvoie le GUID de la valeur d'SystemUser.Id pour l'utilisateur actuel.

• getUserLcid
  Renvoie la valeur de l'identificateur du code de langue (LCID) qui représente la langue mise en service que l'utilisateur a sélectionné comme sa langue par défaut.

• getUserName
  Renvoie le nom de l’utilisateur actuel.

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

• getVersion
  Retourne le numéro de version du serveur Dynamics 365.

• prependOrgName
  Ajoute le nom de l'organisation au début de l'emplacement spécifié.

• Méthodes supprimées
  Les méthodes supprimées sont soit obsolètes, soit remplacées par d'autres méthodes. Vous devez vous assurer que les méthodes ne sont pas utilisées dans vos scripts.

  Les méthodes getAuthenticationHeader et getServerUrl étaient obsolètes avec Microsoft Dynamics CRM 2011 et ne sont plus présentes dans Microsoft Dynamics 365 (Online et local).

  Les méthodes isOutlookClient et isOutlookOnline étaient obsolètes avec Microsoft Dynamics CRM 2013 et ne sont plus présentes dans Microsoft Dynamics 365 (Online et local).

client

Microsoft Dynamics CRM 2013 et Microsoft Dynamics CRM Online a ajouté l’objet client qui contient les méthodes getClient et getClientState pour obtenir des informations sur le client.

Mise à jour 1 de Microsoft Dynamics CRM Online 2015 a ajouté la méthode getFormFactor.

getClient

Renvoie une valeur qui indique le client dans lequel le script s’exécute.

context.client.getClient()

Utilisez cette méthode au lieu de la méthode isOutlookClient supprimée.

• Valeur renvoyée
  Type : Chaîne

  Les valeurs renvoyées sont les suivantes :

  Valeur	Client
  Web	Navigateur
  Outlook	Outlook
  Mobile	Mobile
  Mobile	Centre de services interactifs

getClientState

Utilisez cette méthode au lieu de la méthode isOutlookOnline supprimée.

Renvoie une valeur qui indique l’état du client.

context.client.getClientState()

• Valeur renvoyée
  Type : Chaîne

  Les valeurs possibles sont les suivantes :

  Valeur	Client
  En ligne	Web, Outlook, Mobile, Centre de services interactifs
  Hors connexion	Outlook, mobile

getFormFactor

Utilisez cette méthode pour obtenir des informations sur le type d'appareil utilisé par l'utilisateur.

context.client.getFormFactor()

• Valeur renvoyée
  Type : Nombre

  Les valeurs possibles sont les suivantes :

  Valeur	Facteur de formulaire
  0	Inconnu(e)
  1	Bureau
  2	Tablette
  3	Téléphone

• Remarques
  Cette méthode a été introduite dans Mise à jour 1 de Microsoft Dynamics CRM Online 2015

getClientUrl

Renvoie l'URL de base qui a été utilisée pour accéder à l'application.

context.getClientUrl()

Utilisez cette méthode au lieu de la méthode getServerUrl supprimée.

Les valeurs renvoyées ressembleront à celles répertoriées dans le tableau suivant.

• Valeur renvoyée
  Type : Chaîne

getCurrentTheme

Renvoie une chaîne représentant le thème Microsoft Office Outlook actuel sélectionné par l'utilisateur.

context.getCurrentTheme()

• Valeur renvoyée
  Type : Chaîne

Utilisez ces informations pour sélectionner un thème approprié pour vos ressources Web HTML et Silverlight une fois affichées dans Microsoft Dynamics 365 pour Outlook. Le tableau suivant répertorie les valeurs qui peuvent être renvoyées depuis cette méthode.

getIsAutoSaveEnabled

Cette méthode a été introduite dans Mise à jour de Microsoft Dynamics CRM 2015 et de Microsoft Dynamics CRM Online 2015

Renvoie si l'enregistrement automatique est activé pour l'organisation.

context.getIsAutoSaveEnabled()

• Valeur renvoyée
  Type : Booléen.

  Notes

  Cette fonction renvoie la valeur définit lorsque la page est ouverte. Lorsque vous testez le code à l'aide de cette valeur, vous devez actualiser la page après avoir modifié la valeur pour obtenir la nouvelle valeur.

  Pour plus d'informations :TechNet : Gérer l'enregistrement automatique.

getOrgLcid

Renvoie la valeur de l'identificateur du code de langue (LCID) représentant la langue de base de l’organisation.

context.getOrgLcid()

• Valeur renvoyée
  Type : Nombre

  Exemple : 1033 indique l'anglais.Les valeurs d'ID de paramètres régionaux valides sont disponibles sur la page Tableau des ID de paramètres régionaux (LCID).

  1033
  

getOrgUniqueName

Renvoie la valeur de texte unique du nom de l'organisation.

context.getOrgUniqueName()

• Valeur renvoyée
  Type : Chaîne

  Exemple : Cela correspond à la valeur du nom de l'organisation

  "adventureworkscycle"
  

getQueryStringParameters

Renvoie un objet de dictionnaire de paires clé-valeur représentant des arguments de chaîne de requête qui ont été transmis à la page.

context.getQueryStringParameters()

• Valeur renvoyée
  Type : Objet

getTimeZoneOffsetMinutes

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

context.getTimeZoneOffsetMinutes()

• Valeur renvoyée
  Type : Nombre

getUserId

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

context.getUserId()

• Valeur renvoyée
  Type : Chaîne

  Exemple :

  "{B05EC7CE-5D51-DF11-97E0-00155DB232D0}"
  

getUserLcid

Renvoie la valeur de l'identificateur du code de langue (LCID) qui représente le Module linguistique Microsoft Dynamics 365 que l'utilisateur a sélectionné comme sa langue par défaut.

context.getUserLcid()

• Valeur renvoyée
  Type : Nombre

  Exemple : 1041 indique le japonais.Les valeurs d'ID de paramètres régionaux valides sont disponibles sur la page Tableau des ID de paramètres régionaux (LCID).

  1041
  

getUserName

Renvoie le nom de l’utilisateur actuel.

context.getUserName()

• Valeur renvoyée
  Type : Chaîne

getUserRoles

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

Pour plus d'informations sur les rôles de sécurité, voir Comment la sécurité hiérarchique permet de contrôler l'accès aux entités dans Microsoft Dynamics 365.

context.getUserRoles()

• Valeur renvoyée
  Type : Tableau

  Exemple : Cet utilisateur a uniquement un rôle de sécurité associé à son compte d'utilisateur. La représentation JSON de ce tableau avec une valeur unique est :

  ["cf4cc7ce-5d51-df11-97e0-00155db232d0"]
  

getVersion

Retourne le numéro de version du serveur Dynamics 365.

context.getVersion()

• Valeur renvoyée
  Type : Chaîne

prependOrgName

Ajoute le nom de l'organisation au début de l'emplacement spécifié.

context.prependOrgName(sPath)

• Arguments
  Type : Chaîne

  Chemin local vers une ressource.

• Valeur renvoyée
  Type : Chaîne

  La valeur renvoyée suit ce modèle :

  "/"+ OrgName + sPath
  

Méthodes supprimées

Les méthodes supprimées sont soit obsolètes, soit remplacées par d'autres méthodes. Vous devez vous assurer que ces méthodes ne sont pas utilisées dans vos scripts.

Les méthodes suivantes ont été déconseillées avec les versions antérieures de Microsoft Dynamics 365 et ne sont plus présentes dans la version actuelle :

• getAuthenticationHeader
  Cette méthode prenait en charge l'utilisation des services Web de Microsoft Dynamics CRM 4.0, qui n'existent plus.

• getServerUrl
  Cette méthode a été remplacée par getClientUrl.

• isOutlookClient
  Cette méthode a été remplacée par client.getClient.

• isOutlookOnline
  Cette méthode a été remplacée par client.getClientState.

Voir aussi

Fonction GetGlobalContext et ClientGlobalContext.js.aspx (référence côté client)
Référence rapide des scripts de formulaires
Écrire du code pour les formulaires Microsoft Dynamics 365
Utiliser le modèle d’objet Xrm.Page
Référence par programmation côté client

Microsoft Dynamics 365

© 2017 Microsoft. Tous droits réservés. Copyright