Clientseitiger Kontext (clientseitige Referenz)

  • Artikel

 

Veröffentlicht: Januar 2017

Gilt für: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Ihr Code muss in einem Kontext funktionieren, in dem verschiedene Variablen zur Entwurfszeit nicht bekannt sind. Das Kontextobjekt stellt Methoden zum Abrufen von Informationen bereit, die für eine Organisation, einen Benutzer oder Parameter spezifisch sind, die einer Seite übergeben wurden.

Das Kontextobjekt ist in Formulare verfügbar ist, indem auf Xrm.Page.context verwiesen wird.

Für Webressourcen, die außerhalb eines Formulars ausgeführt werden, verwenden Sie GetGlobalContext-Funktion, um ein Kontextobjekt abzurufen.

Kontexteigenschaften und -methoden

  • client
    Bietet Zugriff auf die getClient, getClientState- und getFormFactor-Methoden, die Sie verwenden können, um zu bestimmen, welcher Client verwendet wird, ob der Client mit dem Server verbunden ist, und welcher Gerätetyp verwendet wird.

  • getClientUrl
    Gibt die Basis-URL zurück, die verwendet wurde, um auf die Anwendung zuzugreifen.

  • getCurrentTheme
    Gibt eine Zeichenfolge zurück, die das aktuelle Microsoft Office Outlook-Theam zurückgibt, das vom Benutzer ausgewählt wurde.

  • getIsAutoSaveEnabled
    Gibt zurück, ob Autosave für die Organisation aktiviert ist.

  • getOrgLcid
    Gibt den Sprachcode-ID (LCIC-Wert zurück, der die Ausgangssprache für die Organisation darstellt.

  • getOrgUniqueName
    Gibt den eindeutigen Textwert des Namens der Organisation zurück.

  • getQueryStringParameters
    Gibt ein Wörterbuchobjekt von Schlüsselwertpaaren zurück, die die Abfragezeichenfolgenargumente darstellen, die zur Seite übergeben wurden.

  • getTimeZoneOffsetMinutes
    Gibt die Differenz zwischen der Ortszeit und der Coordinated Universal Time (UTC) zurück.

    Diese Methode wurde mit Microsoft Dynamics CRM Online 2015-Update 1 eingeführt.

  • getUserId
    Gibt die GUID des SystemUser.Id-Werts für den aktuellen Benutzer zurück.

  • getUserLcid
    Gibt den LCID-Wert zurück, der die Sprache bereitgestellte Sprache darstellt, die der Benutzer als bevorzugte Sprache ausgewählt hat.

  • getUserName
    Gibt den Namen des aktuellen Benutzers zurück.

  • getUserRoles
    Gibt ein Zeichenfolgenarray zurück, das die GUID-Werte für jede der Sicherheitsrollen darstellt, die dem Benutzer oder jedem Team zugeordnet sind, dem der Benutzer angehört.

  • getVersion
    Gibt die Versionsnummer des Dynamics 365Servers zurück.

  • prependOrgName
    Stellt den Organisationsnamen zu dem angegebenen Pfad voran.

  • Entfernte Methoden
    Entfernte Methoden sind entweder veraltet oder durch anderer Methoden ersetzt. Sie müssen sicherstellen, dass diese Methoden nicht in den Skripts verwendet werden.

    Die getAuthenticationHeader- und getServerUrl-Methoden sind in Microsoft Dynamics CRM 2011 veraltet und sind in Microsoft Dynamics 365 (online und lokal) nicht mehr vorhanden.

    Die isOutlookClient- und isOutlookOnline-Methoden sind in Microsoft Dynamics CRM 2013 veraltet und sind in Microsoft Dynamics 365 (online und lokal) nicht mehr vorhanden.

client

Bei Microsoft Dynamics CRM 2013 und Microsoft Dynamics CRM Online wurde das Clientobjekt ergänzt, das die getClient- und getClientState-Methode enthält, um Informationen zum Client abzurufen.

In Microsoft Dynamics CRM Online 2015-Update 1 wurde die getFormFactor-Methode hinzugefügt.

getClient

Gibt einen Wert zurück, um anzugeben, in welchem Client das Skript ausgeführt wird.

context.client.getClient()

Verwenden Sie dies anstelle der entfernten isOutlookClient-Methode.

  • Rückgabewert
    Typ: Zeichenfolge

    Die zurückgegebenen Werte sind:

    Wert

    Client

    Internet

    Browser

    Outlook

    Outlook

    Mobile Geräte

    Mobile Geräte

    Mobile Geräte

    Interaktiver Servicehub

getClientState

Verwenden Sie dies anstelle der entfernten isOutlookOnline-Methode.

Gibt einen Wert zurück, um den Status des Clients anzugeben.

context.client.getClientState()

  • Rückgabewert
    Typ: Zeichenfolge

    Die möglichen zurückgegebenen Werte sind:

    Wert

    Client

    Online

    Internet, Outlook, Mobil, Interaktiver Servicehub

    Offline

    Outlook, Mobile

getFormFactor

Verwenden Sie diese Methode, um Informationen zur Art des Geräts, das der Benutzer verwendet, abzurufen.

context.client.getFormFactor()

  • Rückgabewert
    Typ: Anzahl

    Die möglichen zurückgegebenen Werte sind:

    Wert

    Formularfaktor

    0

    Unbekannt

    1

    Desktop

    2

    Tablet

    3

    Telefon

  • Anmerkungen
    Diese Methode wurde mit Microsoft Dynamics CRM Online 2015-Update 1 eingeführt

getClientUrl

Gibt die Basis-URL zurück, die verwendet wurde, um auf die Anwendung zuzugreifen.

context.getClientUrl()

Verwenden Sie dies anstelle der entfernten getServerUrl-Methode.

Die Werte, die zurückgegebenen Werte ähneln denen, die in der folgenden Tabelle aufgeführt sind.

Wert

Client

http(s)://server/org

Dynamics 365 (lokal)

https://org.crm.dynamics.com

Microsoft Dynamics 365 (online)

https://localhost:2525

Microsoft Dynamics 365 für Outlook mit Offlinezugriff im Offlinemodus
  • Rückgabewert
    Typ: Zeichenfolge

getCurrentTheme

Gibt eine Zeichenfolge zurück, die das aktuelle Microsoft Office Outlook-Theam zurückgibt, das vom Benutzer ausgewählt wurde.

Hinweis

Diese Funktion wird für mobile Dynamics 365-Clients (Smartphones und Tablets) und den interaktiven Servicehub nicht unterstützt.

context.getCurrentTheme()
  • Rückgabewert
    Typ: Zeichenfolge

Erstellen Sie anhand dieser Informationen ein geeignetes Thema für die HTML- und Silverlight-Webressourcen, wenn sie in der Microsoft Dynamics 365 für Outlook angezeigt werden. In der folgenden Tabelle sind die Werte aufgelistet, auf die von dieser Methode zurückgegeben werden können.

Hinweis

Formulare passen sich nicht sich Änderungen im Microsoft Office-Thema an, daher ist der einzige Fall, in dem Sie an die Microsoft Office-Themen anpassen möchten, wenn Sie eine Seite der Navigation in mit einer HTML-Webressource anzeigen. Selbst in diesem Szenario sind sichtbare Unterschiede schwer zu erkennen.

Wert

Thema

Standard

Microsoft Dynamics 365-Webanwendung

Office12Blue

Microsoft Dynamics 365 für Outlook 2007 oder 2010 Blue Theme

Office14Silver

Microsoft Dynamics 365 für Outlook 2007 oder 2010 Silver oder Black Theme

getIsAutoSaveEnabled

Diese Methode wurde mit Microsoft Dynamics CRM 2015 und Microsoft Dynamics CRM Online 2015-Update eingeführt

Gibt zurück, ob Autosave für die Organisation aktiviert ist.

context.getIsAutoSaveEnabled()

  • Rückgabewert
    Typ: Boolesch.

    Hinweis

    Diese Funktion gibt den Wert zurück, der zum Zeitpunkt festgelegt ist, wenn die Seite geöffnet wird. Wenn Sie mithilfe dieses Werts Code testen, müssen Sie die Seite aktualisieren, nachdem Sie den Wert geändert haben, um den neuen Wert abzurufen.

    Weitere Informationen:TechNet: Verwalten der automatischen Speicherung.

getOrgLcid

Gibt den LCID-Wert zurück, der die Ausgangssprache für die Organisation darstellt.

context.getOrgLcid()

  • Rückgabewert
    Typ: Anzahl

    Beispiel: 1033 gibt die englische Sprache an.Gültige Gebietsschema-ID-Werte finden Sie unter Gebietsschema-ID-Diagramm (LCID).

    1033

getOrgUniqueName

Gibt den eindeutigen Textwert des Namens der Organisation zurück.

context.getOrgUniqueName()

  • Rückgabewert
    Typ: Zeichenfolge

    Beispiel: Dies entspricht dem Organisationsnamewert

    "adventureworkscycle"

getQueryStringParameters

Gibt ein Wörterbuchobjekt von Schlüsselwertpaaren zurück, die die Abfragezeichenfolgenargumente darstellen, die zur Seite übergeben wurden.

context.getQueryStringParameters()
  • Rückgabewert
    Typ: Objekt

getTimeZoneOffsetMinutes

Gibt die Differenz zwischen der Ortszeit und der Coordinated Universal Time (UTC) zurück.

Hinweis

Diese Methode wurde mit Microsoft Dynamics CRM Online 2015-Update 1 eingeführt.

context.getTimeZoneOffsetMinutes()
  • Rückgabewert
    Typ: Anzahl

getUserId

Gibt die GUID des SystemUser.Id-Werts für den aktuellen Benutzer zurück.

context.getUserId()

  • Rückgabewert
    Typ: Zeichenfolge

    Beispiel:

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

getUserLcid

Gibt den LCID-Wert zurück, der die Microsoft Dynamics 365Sprachpaket darstellt, die der Benutzer als bevorzugte Sprache ausgewählt hat.

context.getUserLcid()

  • Rückgabewert
    Typ: Anzahl

    Beispiel: 1041 gibt die japanische Sprache an.Gültige Gebietsschema-ID-Werte finden Sie unter Gebietsschema-ID-Diagramm (LCID).

    1041

getUserName

Gibt den Namen des aktuellen Benutzers zurück.

context.getUserName()
  • Rückgabewert
    Typ: Zeichenfolge

getUserRoles

Gibt ein Zeichenfolgenarray zurück, das die GUID-Werte für jede der Sicherheitsrollen darstellt, die dem Benutzer oder jedem Team zugeordnet sind, dem der Benutzer angehört.

Weitere Informationen zu Sicherheitsrollen finden Sie unter So kann die rollenbasierte Sicherheit verwendet werden, um den Zugriff auf Entitäten in Microsoft Dynamics 365 zu steuern.

context.getUserRoles()

  • Rückgabewert
    Typ: Array

    Beispiel: Dieser Benutzer hat eine Sicherheitsrolle, die seinem Benutzerkonto zugeordnet ist. Die JSON-Darstellung dieses Arrays mit einem einzigen Wert:

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

getVersion

Gibt die Versionsnummer des Dynamics 365Servers zurück.

context.getVersion()
  • Rückgabewert
    Typ: Zeichenfolge

prependOrgName

Stellt den Organisationsnamen zu dem angegebenen Pfad voran.

context.prependOrgName(sPath)

  • Argumente
    Typ: Zeichenfolge

    Ein lokaler Pfad zu einer Ressource.

  • Rückgabewert
    Typ: Zeichenfolge

    Der zurückgegebene Wert flgt diesem Muster:

    "/"+ OrgName + sPath

Entfernte Methoden

Entfernte Methoden sind entweder veraltet oder durch anderer Methoden ersetzt. Sie müssen sicherstellen, dass diese Methoden nicht in den Skripts verwendet werden.

Folgende Möglichkeiten wurden in früheren Versionen von Microsoft Dynamics 365 veraltet und sind nicht mehr in der aktuellen Version vorhanden:

  • getAuthenticationHeader
    Dieser Methode unterstützte die Verwendung von Microsoft Dynamics CRM 4.0-Webdiensten, die nicht mehr vorhanden sind.

  • getServerUrl
    Diese Methode wird durch getClientUrl ersetzt.

  • isOutlookClient
    Diese Methode wird durch client.getClient ersetzt.

  • isOutlookOnline
    Diese Methode wird durch client.getClientState ersetzt.

Siehe auch

GetGlobalContext function und ClientGlobalContext.js.aspx (clientseitige Referenz)
Kurzübersicht zum Formularskripting
Schreiben von Code für Microsoft Dynamics 365-Formulare
Verwenden des Xrm.Page-Objektmodells
Cclientseitige Programmierreferenz

Microsoft Dynamics 365

© 2017 Microsoft. Alle Rechte vorbehalten. Copyright