Xrm.Mobile.offline (clientseitiger Verweis)

  • Artikel

 

Veröffentlicht: Januar 2017

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

Der Xrm.Mobile.offline-Namespace stellt Methoden bereit, um Datensätze im mobilen Clients Dynamics 365 zu erstellen und zu verwalten (Dynamics 365 für Smartphones und Dynamics 365 für Tablets) während Sie im Offlinemodus arbeiten.

Hinweis

Der Xrm.Mobile.offline-Namespace wurde in Update für Dynamics 365 (online und lokal), Dezember 2016eingegeben.

Dieser neue Client APIs unter dem Xrm.Mobile.offlineNamespace funktioniert nur, wenn Sie sich im Offlinemodus befinden und für Entitäten, die für mobile Offlinesynchronisierung aktiviert wird.Weitere Informationen:Hilfe und Training: Konfigurieren der mobilen Offlinesynchronisierung für CRM für Telefone und Tablets

Wichtig

Beim Erstellen oder Aktualisieren des Datensatzes im Offlinemodus werden nur grundlegende Überprüfungen für die eingegebenen Daten durchgeführt. Grundlegende Überprüfung umfasst Dinge wie Sicherstellen, dass der Entitätsattributname in Kleinbuchstaben angegeben und für eine Entität vorhanden ist, Überprüfung auf Datentypkonflikt für den angegebenen Attributwert, Verhindern, dass Datensätze mit demselben GUID-Wert erstellt werden, Überprüfen, ob die verknüpfte Entität offline aktiviert ist, wenn verknüpfte Entitätsdatensätze abgerufen werden, und prüfen, ob der Datensatz, den Sie anzeigen, überprüfen, aktualisieren oder löschen möchten, tatsächlich im Offlinedatenspeicher vorhanden ist. Überprüfungen auf Geschäftsebene finden nur statt, wenn Sie mit dem Dynamics 365-Server verbunden sind und die Daten synchronisiert werden. Ein Datensatz wird in Dynamics 365 erstellt oder aktualisiert, wenn die Eingabedaten vollständig gültig sind.

In diesem Thema

isOfflineEnabled

createRecord

retrieveRecord

retrieveMultipleRecords

updateRecord

deleteRecord

isOfflineEnabled

Gibt zurück, ob eine Entität offline aktiviert ist.

Xrm.Mobile.offline.isOfflineEnabled("entityType")

  • Parameter
    Typ:: Zeichenfolge. Der Entitätstyp in Dynamics 365. Zum Beispiel: "Konto". Weitere Informationen zur Entitätssuche finden Sie unter Dynamics 365Web API EntityType Reference.

  • Rückgabewert
    Typ:: Boolesch.True wenn die Entität aktiviert ist; sonst false.

createRecord

Erstellt einen Entitätsdatensatz im Dynamics 365 mobilen Client, während Sie im Offlinemodus arbeiten.

Xrm.Mobile.offline.createRecord(entityType, data).then(successCallback, errorCallback)

retrieveRecord

Ruft einen Entitätsdatensatz im Dynamics 365 mobilen Client ab, während Sie im Offlinemodus arbeiten.

Xrm.Mobile.offline.retrieveRecord(entityType, id, options).then(successCallback, errorCallback)

  • Parameter

    Name

    Typ

    Erforderlich

    Beschreibung

    entityType

    Zeichenfolge

    Ja

    Der Entitätstyp in Dynamics 365 für den Sie einen Datensatz abrufen möchten. Zum Beispiel: "Konto". Weitere Informationen zu den Entitätstypen finden Sie unter Dynamics 365Web API EntityType Reference.

    ID

    Zeichenfolge

    Ja

    GUID des Datensatzes, den Sie abrufen möchten.

    Optionen

    Zeichenfolge

    Nein

    OData Systemabfrageoptionen, um die Daten abzurufen. Die folgenden Systemabfrageoptionen werden unterstützt: $select und $expand

    • Für die Verwendung von $expand muss die verknüpfte Entität in Offline ebenfalls aktiviert werden. Wenn Sie beispielsweise den verknüpften Kontakt für einen Firmendatensatz abrufen, müssen sowohl Firmen- wie auch Kontaktentitäten offline aktiviert werden.

    • Sie geben die Abfrageoptionen beginnend mit ?an. Um mehreren Abfrageoptionen zu definieren, verwenden Sie &, um die Abfrageoptionen zu trennen. Beispiel:

      ?$select=name&$expand=primarycontactid($select=contactid,fullname)

    Tipp

    Als leistungsbewährte Methode schränken Sie die Anzahl Eigenschaften ein, die Sie abrufen, wenn Sie die $select Abfrageoption verwenden. Sonst werden alle aufgelisteten Eigenschaften abgerufen.

    Auch beim Abrufen von Entitätseigenschaftennamen, die die $expand Option verwenden, gibt das Einschließen des Namens der Navigationseigenschaft alle Eigenschaften für die verknüpften Datensätze zurück. Sie können die Eigenschaften begrenzen, die für verknüpfte Datensätze mithilfe der $select Systemabfrageoption in Klammern nach dem Namen der Navigationseigenschaft $expand zurückgegeben werden. Weitere Informationen: Abrufen verwandter Entitäten für eine Entität durch Erweitern der Navigationseigenschaften

    successCallback

    Funktion

    Nein

    Eine Funktion zum Aufrufen, wenn ein Datensatz abgerufen wird. Ein Objekt mit den folgenden Eigenschaften wird übergeben, um den abgerufenen Datensatz zu ermitteln:

    • id: Zeichenfolge. GUID des Datensatzes, der abgerufen wurde.

    • logicalName: Zeichenfolge. Logischer Name der Entität.

    errorCallback

    Funktion

    Nein

    Eine Funktion zum Aufrufen, wenn der Vorgang fehlschlug. Es wird ein Objekt mit den folgenden Eigenschaften übergeben:

    • errorCode: Anzahl. Der Fehlercode.

    • message: Zeichenfolge. Eine Fehlermeldung, die das Problem beschreibt.

    • debugMessage: Zeichenfolge. Eine interne Fehlermeldung, die möglicherweise weitere Informationen zum Problem enthält.

  • Einschränkungen

    • Nur $select Option kann in $expandangegeben werden.

    • Nur die folgenden Attributtypen sind zum Abrufen eines Datensatzes im Offlinemodus unterstützt: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status und UniqueIdentifier.

retrieveMultipleRecords

Ruft eine Sammlung von Entitätsdatensätzen in Dynamics 365 mobilen Clients ab, während Sie im Offlinemodus arbeiten.

Xrm.Mobile.offline.retrieveMultipleRecords(entityType, options, maxPageSize).then(successCallback, errorCallback)

  • Parameter

    Name

    Typ

    Erforderlich

    Beschreibung

    entityType

    Zeichenfolge

    Ja

    Der Entitätstyp in Dynamics 365 für den Sie Datensätze abrufen möchten. Zum Beispiel: "Konto". Weitere Informationen zu den Entitätstypen finden Sie unter Dynamics 365Web API EntityType Reference.

    Optionen

    Zeichenfolge

    Nein

    OData Systemabfrageoptionen oder FetchXML-Abfragen, um ihn abzurufen. Die folgenden Systemabfrageoptionen werden unterstützt: $select$top, $filter,$expand, und $orderby.

    • Für $filter, wird nur die Standardfilteroperatoren, wie unter Ergebnisse filtern beschrieben unterstützt; die Standardabfragenfunktionen werden nicht unterstützt.

    • Für die Verwendung von $expand muss die verknüpfte Entität in Offline ebenfalls aktiviert werden. Wenn Sie beispielsweise den verknüpften Kontakt für einen Firmendatensatz abrufen, müssen sowohl Firmen- wie auch Kontaktentitäten offline aktiviert sein. Wenn Sie die sammlungswertigen Navigationseigenschaften für eine Entität erweitern, um verknüpfte Entitäten abzurufen, wird eine [NavigationPropertyName]@odata.nextLink Eigenschafte für die verknüpften Entitäten abgerufen. Wenn Sie auf der primarycontactid Navigationseigenschaft erweitern, wird sie primarycontactid@odata.nextLink zurückgeben. Sie sollten den Wert der primarycontactid@odata.nextLink-Eigenschaft mit einer neuen GET-Anforderung nutzen, um die benötigten Daten zurückzugeben.

    • Sie geben die Abfrageoptionen beginnend mit ?an. Um mehreren Abfrageoptionen zu definieren, verwenden Sie &, um die Abfrageoptionen zu trennen. Beispiel:

      ?$top=5&$select=name&$expand=primarycontactid($select=contactid,fullname)

      Um eine FetchXML-Abfrage anzugeben, verwenden Sie den fetchXml-Parameter für die Angabe der Abfrage:

      ?fetchXml=<FetchXML>

      Wenn Sie FetchXml verwenden, können Sie nur Basisentitätsattribute abrufen.

    Beispielsweise ist hier das Beispiel aufgeführt, um mehrere Anrufe mit den Abfrageoptionen abzurufen.

    Xrm.Mobile.offline.retrieveMultipleRecords("account", "?select=name,revenue,&$orderby=revenue&$filter=revenue ne '60000.00'", null)

    maxPageSize

    Ganze Zahl

    Nein

    Definieren Sie eine positive Zahl, die die Zahl der Entitätsdatensätze angibt, die pro Seite zurückgegeben werden. Wird dieser Parameter nicht angegeben, wird der Standard 5000 verwendet.

    Wenn die Anzahl von Datensätzen größer ist als maxPageSizeist, wird eine @odata.nextLink-Eigenschaft zurückgegeben, und Sie können den Wert der @odata.nextLink-Eigenschaft mit einer neuen GET Anforderung verwenden, um das nächste Set von Datensätzen zurückzugeben. Weitere Informationen: Geben Sie die Anzahl der in einer Seite zurückzugebenden Entitäten an

    successCallback

    Funktion

    Nein

    Eine Funktion zum Aufrufen, wenn ein Datensatz abgerufen wird. Ein Wörterbuch mit den key : value Datenpaaren, die abgerufen werden, dient zum Identifizieren der abgerufenen Datensätze.

    errorCallback

    Funktion

    Nein

    Eine Funktion zum Aufrufen, wenn der Vorgang fehlschlug. Es wird ein Objekt mit den folgenden Eigenschaften übergeben:

    • errorCode: Anzahl. Der Fehlercode.

    • message: Zeichenfolge. Eine Fehlermeldung, die das Problem beschreibt.

    • debugMessage: Zeichenfolge. Eine interne Fehlermeldung, die möglicherweise weitere Informationen zum Problem enthält.

  • Einschränkungen

    • Ein Maximum von 5000 verknüpften Datensätze kann abgerufen werden kann, wenn $expandverwendet wird.

    • Nur $select Option kann in $expandangegeben werden.

    • Die $skip-Abfrageoption wird nicht unterstützt.

    • Nur die folgenden Attributtypen sind zum Abrufen von Datensätzen im Offlinemodus unterstützt: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status und UniqueIdentifier.

updateRecord

Aktualisiert einen Entitätsdatensatz im Dynamics 365 mobilen Client, während Sie im Offlinemodus arbeiten.

Xrm.Mobile.offline.updateRecord(entityType, id, data).then(successCallback, errorCallback)

  • Parameter

    Name

    Typ

    Erforderlich

    Beschreibung

    entityType

    Zeichenfolge

    Ja

    Der Entitätstyp in Dynamics 365 für den Sie einen Datensatz aktualisieren möchten. Zum Beispiel: "Konto". Weitere Informationen zu den Entitätstypen finden Sie unter Dynamics 365Web API EntityType Reference.

    ID

    Zeichenfolge

    Ja

    GUID des Datensatzes, den Sie aktualisieren möchten.

    -Daten

    Objekt

    Ja

    Ein Wörterbuchobjekt, das das key : value-Paar enthält, wenn key der logische Name der Eigenschaft ist, die Sie aktualisieren möchten und value der aktualisierte Wert für die Eigenschaft ist. Nur die Eigenschaften und die Werte, die Sie im Wörterbuchobjekt angeben, werden für den Datensatz aktualisiert. zum Beispiel:

    var myUpdatedAccount = {};
myUpdatedAccount.name = "Changed Account Name";
myUpdatedAccount.revenue = "60000.00";

    successCallback

    Funktion

    Nein

    Eine Funktion zum Aufrufen, wenn ein Datensatz aktualisiert wird. Ein Objekt mit den folgenden Eigenschaften wird übergeben, um den aktualisierten Datensatz zu ermitteln:

    • id: Zeichenfolge. GUID des Datensatzes, der aktualisiert wurde.

    • logicalName: Zeichenfolge. Logischer Name der Entität.

    errorCallback

    Funktion

    Nein

    Eine Funktion zum Aufrufen, wenn der Vorgang fehlschlug. Es wird ein Objekt mit den folgenden Eigenschaften übergeben:

    • errorCode: Anzahl. Der Fehlercode.

    • message: Zeichenfolge. Eine Fehlermeldung, die das Problem beschreibt.

    • debugMessage: Zeichenfolge. Eine interne Fehlermeldung, die möglicherweise weitere Informationen zum Problem enthält.

  • Einschränkungen

    • Sie können keine überschneidende und Aktivitätsparteientitäten aktualisieren.

    • Nur die folgenden Attributtypen sind zum Aktualisieren eines Datensatzes im Offlinemodus unterstützt: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status und UniqueIdentifier.

deleteRecord

Löschen eines Entitätsdatensatz im Dynamics 365 mobilen Client, während Sie im Offlinemodus arbeiten.

Xrm.Mobile.offline.deleteRecord(entityType, id).then(successCallback, errorCallback)

  • Parameter

    Name

    Typ

    Erforderlich

    Beschreibung

    entityType

    Zeichenfolge

    Ja

    Der Entitätstyp in Dynamics 365 für den Sie einen Datensatz löschen möchten. Zum Beispiel: "Konto". Weitere Informationen zu den Entitätstypen finden Sie unter Dynamics 365Web API EntityType Reference.

    ID

    Zeichenfolge

    Ja

    GUID des Datensatzes, den Sie löschen möchten.

    successCallback

    Funktion

    Nein

    Eine Funktion zum Aufrufen, wenn ein Datensatz gelöscht wird. Ein Objekt mit den folgenden Eigenschaften wird übergeben, um den gelöschten Datensatz zu ermitteln:

    • id: Zeichenfolge. GUID des Datensatzes, der gelöscht wurde.

    • logicalName: Zeichenfolge. Logischer Name der Entität.

    errorCallback

    Funktion

    Nein

    Eine Funktion zum Aufrufen, wenn der Vorgang fehlschlug. Es wird ein Objekt mit den folgenden Eigenschaften übergeben:

    • errorCode: Anzahl. Der Fehlercode.

    • message: Zeichenfolge. Eine Fehlermeldung, die das Problem beschreibt.

    • debugMessage: Zeichenfolge. Eine interne Fehlermeldung, die möglicherweise weitere Informationen zum Problem enthält.

  • Einschränkungen
    Sie können keine überschneidende und Aktivitätsparteientitäten löschen.

Siehe auch

Schreiben und Debuggen von Skripts für Dynamics 365 für Smartphones und Tablets
Cclientseitige Programmierreferenz

Microsoft Dynamics 365

© 2017 Microsoft. Alle Rechte vorbehalten. Copyright