Xrm.Mobile.offline (klientsidereference)
Udgivet: januar 2017
Gælder for: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Xrm.Mobile.offline-navneområdet indeholder metoder til at oprette og administrere poster i Dynamics 365-mobileklienterne (Dynamics 365 til telefoner og Dynamics 365 til tablets), når du arbejder i offlinetilstand.
Bemærk
Xrm.Mobile.offline-navneområdet blev introduceret i December 2016 – opdatering til Dynamics 365 (online og det lokale miljø).
Disse klient-API'er under Xrm.Mobile.offline-navneområdet fungerer kun, hvis du er i offlinetilstand, og for objekter, der er aktiveret til synkronisering af Mobile Offline.Flere oplysninger:Hjælp og undervisning: Konfigurere synkronisering af Mobile offline til CRM til telefoner og tablets
Vigtigt
Når du opretter eller opdaterer en post i offlinetilstand, udføres der kun en grundlæggende validering af inputdataene. En grundlæggende validering omfatter ting som at sikre, at attributnavnet for en enhed angives med små bogstaver og findes for en enhed, at kontrollere, om der er uoverensstemmende datatyper for den angivne attributværdi, at forhindre oprettelse af poster med den samme GUID-værdi, at kontrollere, om det relaterede objekt er aktiveret offline, når du henter relaterede objektposter, og at validere, om den post, du vil hente , opdatere eller slette, faktisk findes i offlinedatalageret. Professionel validering udføres kun, når du har forbindelse til Dynamics 365-serveren, og dataene er synkroniseret. En post oprettes eller opdateres kun i Dynamics 365, hvis inputdataene er fuldstændig gyldige.
Dette emne indeholder
isOfflineEnabled
createRecord
retrieveRecord
retrieveMultipleRecords
updateRecord
deleteRecord
isOfflineEnabled
Returnerer, om et objekt aktiveres offline.
Xrm.Mobile.offline.isOfflineEnabled("entityType")
Parametre
Type: Streng. Objekttypen i Dynamics 365. For eksempel: "firma". Du kan finde oplysninger om objekttyper i Dynamics 365 under Web API EntityType Reference.Returværdi
Type: Boolesk værdi.True, hvis objektet er aktiveret offline. Ellers false.
createRecord
Opretter en objektpost i Dynamics 365-mobilklienter, når du arbejder i offlinetilstand.
Xrm.Mobile.offline.createRecord(entityType, data).then(successCallback, errorCallback)
Parametre
Navn
Skriv
Krævet
Beskrivelse
entityType
Streng
Ja
Objekttypen i Dynamics 365, som du vil oprette en post for. For eksempel: "firma". Du kan finde oplysninger om objekttyper i Dynamics 365 under Web API EntityType Reference.
-data
Objekt
Ja
Et ordbogsobjekt, der indeholder key : value-par, hvor key er egenskaben for objektsættet, og value er værdien for den egenskab, du vil bruge til at oprette objektposten. Definer for eksempel følgende objekt for at oprette et firma:
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");
Du kan finde oplysninger om objekttyper og deres egenskaber i Dynamics 365 under Web API EntityType Reference.
successCallback
Funktion
Nej
En funktion, der kan kaldes, når der oprettes en post. For at identificere den nye post sendes et objekt med følgende egenskaber:
id: Streng. GUID for den post, der blev oprettet.
logicalName: Streng. Logisk navn på objektet.
errorCallback
Funktion
Nej
En funktion, der kaldes, når handlingen ikke kan udføres. Et objekt med følgende egenskaber overføres:
errorCode: Tal. Fejlkoden.
message: Streng. En fejlmeddelelse, der beskriver problemet.
debugMessage: Streng. En intern fejlmeddelelse, der kan indeholde yderligere oplysninger om problemet.
Begrænsninger
Du kan ikke oprette gennemskærings- og aktivitetspartsobjekter.
Kun følgende attributtyper understøttes ved oprettelse af en post i offlinetilstand: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status og UniqueIdentifier.
retrieveRecord
Henter en objektpost i Dynamics 365-mobilklienter, når du arbejder i offlinetilstand.
Xrm.Mobile.offline.retrieveRecord(entityType, id, options).then(successCallback, errorCallback)
Parametre
Navn
Skriv
Krævet
Beskrivelse
entityType
Streng
Ja
Objekttypen i Dynamics 365, som du vil hente en post for. For eksempel: "firma". Du kan finde oplysninger om objekttyper i Dynamics 365 under Web API EntityType Reference.
id
Streng
Ja
GUID for den post, som du vil hente.
options
Streng
Nej
OData-systemforespørgselsindstillinger til hentning af dataene. Følgende systemforespørgselsindstillinger understøttes: $select og $expand.
Ved brug af $expand skal det relaterede objekt også være aktiveret offline. For eksempel for at hente den kontakt, der er relateret til en firmapost, skal både firma- og kontaktobjekter være aktiveret offline.
Du skal begynde med ?, når du angiver forespørgselsindstillinger. For at angive flere forespørgselsindstillinger skal du bruge & til at adskille forespørgselsindstillingerne. Eksempel:
?$select=name&$expand=primarycontactid($select=contactid,fullname)
Tip
Med hensyn til ydeevnen er den bedste fremgangsmåde at begrænse antallet af egenskaber, som du henter ved hjælp af $select-forespørgselsindstillingen. Ellers hentes alle egenskaber.
Når relaterede objektegenskabsnavne hentes ved hjælp af $expand-indstillingen, kan du desuden inkludere navnet på navigationsegenskaben for at få returneret alle egenskaber for relaterede poster. Du kan begrænse de egenskaber, der er returneres for relaterede poster, ved at angive $select-systemforespørgselsindstillingen i parentes efter navigationsegenskabsnavnet i $expand. Flere oplysninger: Hente relaterede objekter for et objekt ved at udvide navigationsegenskaber
successCallback
Funktion
Nej
En funktion, der kan kaldes, når der hentes en post. For at identificere den hentede post sendes der et objekt med følgende egenskaber:
id: Streng. GUID for den post, der blev hentet.
logicalName: Streng. Logisk navn på objektet.
errorCallback
Funktion
Nej
En funktion, der kaldes, når handlingen ikke kan udføres. Et objekt med følgende egenskaber overføres:
errorCode: Tal. Fejlkoden.
message: Streng. En fejlmeddelelse, der beskriver problemet.
debugMessage: Streng. En intern fejlmeddelelse, der kan indeholde yderligere oplysninger om problemet.
Begrænsninger
Kun $select-indstillingen kan angives inden for $expand.
Kun følgende attributtyper understøttes ved hentning af en post i offlinetilstand: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status og UniqueIdentifier.
retrieveMultipleRecords
Henter en samling objektposter i Dynamics 365-mobilklienter, når du arbejder i offlinetilstand.
Xrm.Mobile.offline.retrieveMultipleRecords(entityType, options, maxPageSize).then(successCallback, errorCallback)
Parametre
Navn
Skriv
Krævet
Beskrivelse
entityType
Streng
Ja
Objekttypen i Dynamics 365, som du vil hente poster for. For eksempel: "firma". Du kan finde oplysninger om objekttyper i Dynamics 365 under Web API EntityType Reference.
options
Streng
Nej
OData-systemforespørgselsindstillinger eller FetchXML-forespørgsel til hentning af dataene. Følgende systemforespørgselsindstillinger understøttes: $select, $top, $filter, $expand og $orderby.
Hvad angår $filter understøttes kun standardfilteroperatorer som nævnt i sektionen Filtrer resultater. Standardforespørgselsfunktioner understøttes ikke
Ved brug af $expand skal det relaterede objekt også være aktiveret offline. Hvis du for eksempel vil hente kontakt for firmaposterne, skal både firma- og kontaktobjekter være aktiveret offline. Hvis du udvider navigationsegenskaber med gruppeværdi, for at et objekt skal hente relaterede objekter, returneres en [NavigationPropertyName]@odata.nextLink-egenskab for de relaterede objekter. Hvis du udvider på primarycontactid-navigationsegenskaben, returnerer den primarycontactid@odata.nextLink. Du skal bruge værdien for primarycontactid@odata.nextLink-egenskaben med en ny GET-anmodning for at returnere de påkrævede data.
Du skal begynde med ?, når du angiver forespørgselsindstillinger. For at angive flere forespørgselsindstillinger skal du bruge & til at adskille forespørgselsindstillingerne. Eksempel:
?$top=5&$select=name&$expand=primarycontactid($select=contactid,fullname)
For at angive en FetchXML-forespørgsel skal du bruge fetchXml-parameteren til angivelse af forespørgslen:
?fetchXml=<FetchXML>
Med FetchXml kan du kun hente grundlæggende objektattributter.
For eksempel her er et eksempel på et hent flere-kald, som udføres ved hjælp af forespørgselsindstillingerne:
Xrm.Mobile.offline.retrieveMultipleRecords("account", "?select=name,revenue,&$orderby=revenue&$filter=revenue ne '60000.00'", null)
maxPageSize
Heltal
Nej
Angiv et positivt tal, der angiver antallet af objektposter, der skal returneres pr. side. Hvis du ikke angiver denne parameter, sendes standardværdien som 5000.
Hvis antallet af poster, der hentes, er mere end maxPageSize, returneres en @odata.nextLink-egenskab, og du kan bruge værdien af @odata.nextLink-egenskaben til en ny GET-anmodning om returnering af det næste sæt poster. Flere oplysninger: Angiv antallet af objekter, der skal returneres i en side
successCallback
Funktion
Nej
En funktion, der kan kaldes, når der hentes poster. Der sendes en ordbog, som indeholder key : value-datapar for at identificere de hentede poster.
errorCallback
Funktion
Nej
En funktion, der kaldes, når handlingen ikke kan udføres. Et objekt med følgende egenskaber overføres:
errorCode: Tal. Fejlkoden.
message: Streng. En fejlmeddelelse, der beskriver problemet.
debugMessage: Streng. En intern fejlmeddelelse, der kan indeholde yderligere oplysninger om problemet.
Begrænsninger
Højst 5000 relaterede poster kan hentes, når du bruger $expand.
Kun $select-indstillingen kan angives inden for $expand.
$skip-forespørgselsindstillingen understøttes ikke.
Kun følgende attributtyper understøttes ved hentning af poster i offlinetilstand: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status og UniqueIdentifier.
updateRecord
Opdaterer en objektpost i Dynamics 365-mobilklienter, når du arbejder i offlinetilstand.
Xrm.Mobile.offline.updateRecord(entityType, id, data).then(successCallback, errorCallback)
Parametre
Navn
Skriv
Krævet
Beskrivelse
entityType
Streng
Ja
Objekttypen i Dynamics 365, som du vil opdatere en post for. For eksempel: "firma". Du kan finde oplysninger om objekttyper i Dynamics 365 under Web API EntityType Reference.
id
Streng
Ja
GUID for den post, som du vil opdatere.
-data
Objekt
Ja
Et ordbogsobjekt, der indeholder key : value-par, hvor key er det logiske navn på den egenskab, du vil opdatere, og value er den opdaterede værdi for egenskaben. Kun de egenskaber og værdier, du angiver i ordbogsobjektet, bliver opdateret for posten. Eksempel:
var myUpdatedAccount = {}; myUpdatedAccount.name = "Changed Account Name"; myUpdatedAccount.revenue = "60000.00";
successCallback
Funktion
Nej
En funktion, der kan kaldes, når der opdateres en post. For at identificere den opdaterede post sendes der et objekt med følgende egenskaber:
id: Streng. GUID for den post, der blev opdateret.
logicalName: Streng. Logisk navn på objektet.
errorCallback
Funktion
Nej
En funktion, der kaldes, når handlingen ikke kan udføres. Et objekt med følgende egenskaber overføres:
errorCode: Tal. Fejlkoden.
message: Streng. En fejlmeddelelse, der beskriver problemet.
debugMessage: Streng. En intern fejlmeddelelse, der kan indeholde yderligere oplysninger om problemet.
Begrænsninger
Du kan ikke opdatere gennemskærings- og aktivitetspartsobjekter.
Kun følgende attributtyper understøttes ved opdatering af en post i offlinetilstand: BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName, Integer, Lookup, Memo, Money, Owner, Picklist, String, State, Status og UniqueIdentifier.
deleteRecord
Sletter en objektpost i Dynamics 365-mobilklienter, når du arbejder i offlinetilstand.
Xrm.Mobile.offline.deleteRecord(entityType, id).then(successCallback, errorCallback)
Parametre
Navn
Skriv
Krævet
Beskrivelse
entityType
Streng
Ja
Objekttypen i Dynamics 365, som du vil slette en post for. For eksempel: "firma". Du kan finde oplysninger om objekttyper i Dynamics 365 under Web API EntityType Reference.
id
Streng
Ja
GUID for den post, som du vil slette.
successCallback
Funktion
Nej
En funktion, der kan kaldes, når der slettes en post. For at identificere den slettede post sendes der et objekt med følgende egenskaber:
id: Streng. GUID for den post, der blev slettet.
logicalName: Streng. Logisk navn på objektet.
errorCallback
Funktion
Nej
En funktion, der kaldes, når handlingen ikke kan udføres. Et objekt med følgende egenskaber overføres:
errorCode: Tal. Fejlkoden.
message: Streng. En fejlmeddelelse, der beskriver problemet.
debugMessage: Streng. En intern fejlmeddelelse, der kan indeholde yderligere oplysninger om problemet.
Begrænsninger
Du kan ikke slette gennemskærings- og aktivitetspartsobjekter.
Se også
Skrive eller rette fejl i scripts til Dynamics 365 til telefoner og tablets
Programmeringsreference på klientsidenMicrosoft Dynamics 365
© 2017 Microsoft. Alle rettigheder forbeholdes. Ophavsret