Xrm.Mobile.offline (clientreferentie)

  • Artikel

 

Gepubliceerd: januari 2017

Is van toepassing op: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

De naamruimte Xrm.Mobile.offline biedt methoden om records in de mobiele Dynamics 365-clients te maken en beheren (Dynamics 365 voor telefoons en Dynamics 365 voor tablets) in de offlinemodus.

Notitie

De naamruimte Xrm.Mobile.offline werd geïntroduceerd in Update voor Dynamics 365 (online en on-premises) - december 2016.

Deze client-API´s onder de naamruimte Xrm.Mobile.offline werken alleen als u in de offlinemodus werkt en voor entiteiten die voor mobiele offlinesynchronisatie zijn ingeschakeld.Meer informatie:Help en training: Synchronisatie van Mobile offline voor CRM configureren op telefoons en tablets

Belangrijk

Bij het maken of bijwerken van records in de offlinemodus, wordt alleen basisvalidatie uitgevoerd op de invoergegevens. Basisvalidatie omvat controle of de opgegeven naam van de entiteitskenmerken in kleine letters is opgegeven en bestaat voor een entiteit, of het gegevenstype overeenkomstmet de opgegeven kenmerkwaarde, om te voorkomen dat records worden gemaakt met dezelfde GUID-waarde, of de gerelateerde entiteit offline is ingeschakeld bij het ophalen van gerelateerde entiteitrecords en valideren of de record die u wilt ophalen, bijwerken of verwijderen bestaat in de offline gegevensopslag. Validatie op bedrijfsniveau vindt alleen plaats wanneer u met een Dynamics 365-server bent verbonden en de gegevens worden gesynchroniseerd. Er wordt alleen een record gemaakt of bijgewerkt in Dynamics 365 als de invoergegevens volledig geldig zijn.

In dit onderwerp

isOfflineEnabled

createRecord

retrieveRecord

retrieveMultipleRecords

updateRecord

deleteRecord

isOfflineEnabled

Hiermee wordt aangegeven of een entiteit offline is ingeschakeld.

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

  • Parameters
    Type: Tekenreeks. Het entiteitstype in Dynamics 365. Bijvoorbeeld 'account'. Raadpleeg voor meer informatie over entiteitstypen in Dynamics 365 het artikel Web API EntityType Reference.

  • Retourwaarde
    Type: Boole-waarde.True als de entiteit offline is ingeschakeld, anders false.

createRecord

Hiermee maakt u een entiteitsrecord in mobiele Dynamics 365-clients terwijl u werkt in de offlinemodus.

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

  • Parameters

    Naam

    Type

    Vereist

    Beschrijving

    entityType

    Tekenreeks

    Ja

    Het entiteitstype in Dynamics 365 waarvoor u een record wilt maken. Bijvoorbeeld 'account'. Raadpleeg voor meer informatie over entiteitstypen in Dynamics 365 het artikel Web API EntityType Reference.

    -gegevens

    Object

    Ja

    Een woordenlijstobject met key : value-paren, waarbij key eigendom is van de entiteitset en value de waarde is voor de eigenschap die u wilt gebruiken om een entiteitsrecord te maken. Definieer bijvoorbeeld het volgende object om een account te maken:

        var myAccount = {};
myAccount.name = "Sample Account Name";
myAccount.accountid = "2724A2AF-697E-E611-80DB-00155DB412B4";
myAccount.parentaccountid = {
    "logicalname": "account",
    "id": "76BE5E4A-5990-E611-80DA-00155DD8BA2D"
};
myAccount.revenue = "60000.00";
myAccount.primarycontactid = {
    "logicalname": "contact",
    "id": "76BE5E4A-5990-E611-80DA-00155DD8BA2D"
};
myAccount.new_customdate = new Date("September 29, 2016 12:00:00");

    Raadpleeg voor meer informatie over entiteitstypen en hun eigenschappen in Dynamics 365 het artikel Web API EntityType Reference.

    successCallback

    Functie

    Nee

    Een functie om aan te roepen wanneer een record wordt gemaakt. Een object met de volgende eigenschappen wordt doorgegeven om de nieuwe record te identificeren:

    • id: tekenreeks. GUID van de record die is gemaakt.

    • logicalName: tekenreeks. Logische naam van de entiteit.

    errorCallback

    Functie

    Nee

    Een functie die moet worden aangeroepen als de bewerking is mislukt. Een object met de volgende eigenschappen wordt doorgegeven:

    • errorCode: getal. De foutcode.

    • message: tekenreeks. Een foutbericht met de beschrijving van het probleem.

    • debugMessage: tekenreeks. Een intern foutbericht met mogelijk aanvullende informatie over het probleem.

  • Beperkingen

    • U kunt geen doorsnedenentiteiten en entiteiten voor betrokkene bij activiteit maken.

    • Alleen de volgende typen kenmerken worden ondersteund voor het maken van een record in de offline modus: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status en UniqueIdentifier.

retrieveRecord

Hiermee haalt u een entiteitsrecord in mobiele Dynamics 365-clients op terwijl u werkt in de offlinemodus.

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

  • Parameters

    Naam

    Type

    Vereist

    Beschrijving

    entityType

    Tekenreeks

    Ja

    Het entiteitstype in Dynamics 365 waarvoor u een record wilt ophalen. Bijvoorbeeld 'account'. Raadpleeg voor meer informatie over entiteitstypen in Dynamics 365 het artikel Web API EntityType Reference.

    id

    Tekenreeks

    Ja

    GUID van de record die u wilt ophalen.

    Opties

    Tekenreeks

    Nee

    OData-opties voor systeemquery's om uw gegevens op te halen. De volgende systeemqueryopties worden ondersteund: $select en $expand.

    • Voor het gebruik van $expand moet de gerelateerde entiteit ook offline ingeschakeld zijn. Als u de contactpersoon met betrekking tot een accountrecord wilt ophalen, moeten zowel account- als contactpersoonentiteiten offline ingeschakeld zijn.

    • U geeft de queryopties vanaf ? op. Als u meerdere queryopties wilt opgeven, gebruikt u & om de queryopties te scheiden. Bijvoorbeeld:

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

    Tip

    Voor optimale prestaties beperkt u hoeveel eigenschappen worden opgehaald met de queryoptie $select. Anders worden alle eigenschappen opgehaald.

    Als u bij het ophalen van gerelateerde entiteitseigenschapsnamen de optie $expand gebruikt en de naam van de navigatie-eigenschap opneemt, worden alle eigenschappen voor gerelateerde records opgehaald. U kunt het aantal geretourneerde eigenschappen voor de gerelateerde records beperken door tussen haakjes de systeemqueryoptie $select achter de naam van de navigatie-eigenschap toe te voegen in $expand. Meer info: Gerelateerde entiteiten ophalen voor een entiteit door navigatie-eigenschappen uit te vouwen

    successCallback

    Functie

    Nee

    Een functie om aan te roepen wanneer een record wordt opgehaald. Een object met de volgende eigenschappen wordt doorgegeven om de opgehaalde record te identificeren:

    • id: tekenreeks. GUID van de record die is opgehaald.

    • logicalName: tekenreeks. Logische naam van de entiteit.

    errorCallback

    Functie

    Nee

    Een functie die moet worden aangeroepen als de bewerking is mislukt. Een object met de volgende eigenschappen wordt doorgegeven:

    • errorCode: getal. De foutcode.

    • message: tekenreeks. Een foutbericht met de beschrijving van het probleem.

    • debugMessage: tekenreeks. Een intern foutbericht met mogelijk aanvullende informatie over het probleem.

  • Beperkingen

    • Alleen de optie $select kan worden opgegeven in $expand.

    • Alleen de volgende typen kenmerken worden ondersteund voor het ophalen van een record in de offline modus: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status en UniqueIdentifier.

retrieveMultipleRecords

Hiermee haalt u een verzameling entiteitsrecords in mobiele Dynamics 365-clients op terwijl u werkt in de offlinemodus.

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

  • Parameters

    Naam

    Type

    Vereist

    Beschrijving

    entityType

    Tekenreeks

    Ja

    Het entiteitstype in Dynamics 365 waarvoor u records wilt ophalen. Bijvoorbeeld 'account'. Raadpleeg voor meer informatie over entiteitstypen in Dynamics 365 het artikel Web API EntityType Reference.

    Opties

    Tekenreeks

    Nee

    OData-opties voor systeemquery's of FetchXML-query om uw gegevens op te halen. De volgende systeemqueryopties worden ondersteund: $select, $top, $filter, $expand en $orderby.

    • Voor $filter worden alleen de standaardfilteroperatoren beschreven in Resultaten filteren ondersteund. De standaardqueryfuncties worden niet ondersteund

    • Voor het gebruik van $expand moet de gerelateerde entiteit ook offline ingeschakeld zijn. Als u de contactpersoon voor de accountrecords wilt ophalen, moeten zowel account- als contactpersoonentiteiten offline ingeschakeld zijn. Als u voor een entiteit collection-valued navigatie-eigenschappen uitvouwt om gerelateerde entiteiten op te halen, wordt er een eigenschap [NavigationPropertyName]@odata.nextLink geretourneerd voor de gerelateerde entiteiten. Als u bijvoorbeeld de navigatie-eigenschap primarycontactid uitvouwt, wordt primarycontactid@odata.nextLink teruggestuurd. U moet de waarde van de eigenschap primarycontactid@odata.nextLink gebruiken in een nieuwe GET-aanvraag om de gewenste gegevens te retourneren.

    • U geeft de queryopties vanaf ? op. Als u meerdere queryopties wilt opgeven, gebruikt u & om de queryopties te scheiden. Bijvoorbeeld:

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

      Als u een FetchXML-query wilt opgeven, gebruikt u de parameter fetchXml voor het opgeven van de query:

      ?fetchXml=<FetchXML>

      Met FetchXml kunt u alleen basisentiteitskenmerken ophalen.

    U kunt bijvoorbeeld met een aanroep meerdere kenmerken ophalen met de queryopties:

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

    maxPageSize

    Geheel getal

    Nee

    Geef een positief getal op om aan te geven hoeveel entiteitsrecords per pagina moeten worden geretourneerd. Als u deze parameter niet opgeeft, wordt de standaardwaarde 5000 doorgegeven.

    Als meer records worden opgehaald dan aangegeven bij maxPageSize, zal een eigenschap @odata.nextLink worden geretourneerd en kunt u de waarde van eigenschap @odata.nextLink met een nieuwe GET-aanvraag gebruiken om de volgende verzameling records te retourneren. Meer info: Geef het aantal entiteiten op dat op een pagina moet worden weergegeven

    successCallback

    Functie

    Nee

    Een functie om aan te roepen wanneer records worden opgehaald. Een woordenboek met opgehaalde key : value-gegevensparen wordt doorgegeven om de opgehaalde record te identificeren.

    errorCallback

    Functie

    Nee

    Een functie die moet worden aangeroepen als de bewerking is mislukt. Een object met de volgende eigenschappen wordt doorgegeven:

    • errorCode: getal. De foutcode.

    • message: tekenreeks. Een foutbericht met de beschrijving van het probleem.

    • debugMessage: tekenreeks. Een intern foutbericht met mogelijk aanvullende informatie over het probleem.

  • Beperkingen

    • Maximaal 5000 verwante records kunnen worden opgehaald met $expand.

    • Alleen de optie $select kan worden opgegeven in $expand.

    • De queryoptie $skip wordt niet ondersteund.

    • Alleen de volgende typen kenmerken worden ondersteund voor het ophalen van records in de offline modus: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status en UniqueIdentifier.

updateRecord

Hiermee werkt u een entiteitsrecord in mobiele Dynamics 365-clients bij terwijl u werkt in de offlinemodus.

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

  • Parameters

    Naam

    Type

    Vereist

    Beschrijving

    entityType

    Tekenreeks

    Ja

    Het entiteitstype in Dynamics 365 waarvoor u een record wilt bijwerken. Bijvoorbeeld 'account'. Raadpleeg voor meer informatie over entiteitstypen in Dynamics 365 het artikel Web API EntityType Reference.

    id

    Tekenreeks

    Ja

    GUID van de record die u wilt bijwerken.

    -gegevens

    Object

    Ja

    Een woordenlijstobject met key : value-paren, waarbij key de logische naam is van de eigenschap die u wilt bijwerken en value de bijgewerkte waarde is voor de eigenschap. Alleen de eigenschappen en waarden die u in het woordenlijstobject opgeeft, worden bijgewerkt voor de record. Bijvoorbeeld:

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

    successCallback

    Functie

    Nee

    Een functie om aan te roepen wanneer een record wordt bijgewerkt. Een object met de volgende eigenschappen wordt doorgegeven om de bijgewerkte record te identificeren:

    • id: tekenreeks. GUID van de record die is bijgewerkt.

    • logicalName: tekenreeks. Logische naam van de entiteit.

    errorCallback

    Functie

    Nee

    Een functie die moet worden aangeroepen als de bewerking is mislukt. Een object met de volgende eigenschappen wordt doorgegeven:

    • errorCode: getal. De foutcode.

    • message: tekenreeks. Een foutbericht met de beschrijving van het probleem.

    • debugMessage: tekenreeks. Een intern foutbericht met mogelijk aanvullende informatie over het probleem.

  • Beperkingen

    • U kunt geen doorsnedenentiteiten en entiteiten voor betrokkene bij activiteit bijwerken.

    • Alleen de volgende typen kenmerken worden ondersteund voor het bijwerken van een record in de offline modus: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status en UniqueIdentifier.

deleteRecord

Hiermee verwijdert u een entiteitsrecord in mobiele Dynamics 365-clients terwijl u werkt in de offlinemodus.

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

  • Parameters

    Naam

    Type

    Vereist

    Beschrijving

    entityType

    Tekenreeks

    Ja

    Het entiteitstype in Dynamics 365 waarvoor u een record wilt verwijderen. Bijvoorbeeld 'account'. Raadpleeg voor meer informatie over entiteitstypen in Dynamics 365 het artikel Web API EntityType Reference.

    id

    Tekenreeks

    Ja

    GUID van de record die u wilt verwijderen.

    successCallback

    Functie

    Nee

    Een functie om aan te roepen wanneer een record wordt verwijderd. Een object met de volgende eigenschappen wordt doorgegeven om de verwijderde record te identificeren:

    • id: tekenreeks. GUID van de record die is verwijderd.

    • logicalName: tekenreeks. Logische naam van de entiteit.

    errorCallback

    Functie

    Nee

    Een functie die moet worden aangeroepen als de bewerking is mislukt. Een object met de volgende eigenschappen wordt doorgegeven:

    • errorCode: getal. De foutcode.

    • message: tekenreeks. Een foutbericht met de beschrijving van het probleem.

    • debugMessage: tekenreeks. Een intern foutbericht met mogelijk aanvullende informatie over het probleem.

  • Beperkingen
    U kunt geen doorsnedenentiteiten en entiteiten voor betrokkene bij activiteit verwijderen.

Zie ook

Scripts schrijven en fouten opsporen voor Dynamics 365 voor telefoons en tablets
Programmeerreferentie op de client

Microsoft Dynamics 365

© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht