Forms API-referens

.loadForm(baseUrl, munchkinId, formId, callback)

Läser in en formulärbeskrivning från Marketo-servrar och skapar ett nytt Form-objekt.

baseUrl(String) - URL till Marketo-serverinstansen för prenumerationen

undefined

munchkinId (String) -Munchkin ID för prenumerationen

formId (String eller Number) - Formulärversions-ID (Vid) för formuläret som ska läsas in

callback (valfri) (Function) - en callback-funktion som skickar det konstruerade Form-objektet till när det har lästs in och initierats.

.lightbox(form, opts)

Återger en modal dialogruta av ljuslådeformat med formulärobjektet i.

form (formulärobjekt) - en instans av ett formulärobjekt som du vill ha återgivet i en ljuslåda.

Ett ljuslådeobjekt med metoderna .show() och .hide().

opts (optional)(Object) - Ett objekt med alternativ som skickas till ljuslådeobjektet

onSuccess(Function) - Ett återanrop som aktiveras när formuläret skickas.

closeBtn(Boolean) default true - Kontrollerar om en stängningsknapp (X) visas i ljuslådedialogrutan.

.newForm(formData, callback)

Skapar ett nytt formulärobjekt från ett JS-objekt för en formulärbeskrivning. Lägger till en återanropsfunktion som anropas när alla formatmallar och känd lead-information har hämtats och formulärobjektet har skapats.

formData (Form Descriptor Object) - ett formulärbeskrivningsobjekt som skapats av Marketo Forms V2 Editor

undefined

callback (valfri)(Function) - Det här återanropet anropas med ett argument, en ny instans av Form-objektet.

.getForm(formId)

Hämtar ett tidigare skapat formulärobjekt per formulärets identifierare

formId (Number eller String) - Vid-identifierare för formulär.

Formulärobjekt

.allForms()

Hämtar en array med alla formulärobjekt som tidigare har skapats på sidan.

n/a

Array med formulärobjekt

.getPageFields()

Hämtar ett JS-objekt som innehåller data från URL:en och referenten som kan vara intressanta i spårningssyfte.

n/a

Objekt

.whenReady(callback)

Lägger till ett återanrop som anropas exakt en gång för varje formulär på sidan som blir"klart". Beredskap innebär att formuläret finns, har återgetts initialt och att dess initiala återanrop har anropats. Om det redan finns ett formulär som är klart när den här funktionen anropas anropas det skickade återanropet omedelbart.

callback(Function) - callback-funktionen skickas som ett argument, ett formulärobjekt.

MKTOForms2-objekt

.onFormRender(callback)

Lägger till ett återanrop som anropas varje gång något formulär på sidan återges. Forms återges när det skapas, och sedan igen varje gång som synlighetsreglerna ändrar formulärets struktur.

callback (Function) - callback-funktionen skickas som ett argument, formulärobjektet för det formulär som återgavs.

MKTOForms2-objekt

.whenRendered(callback)

Precis som onFormRender lägger detta till ett återanrop som anropas varje gång ett formulär återges. Dessutom anropas återanropet omedelbart för alla formulär som redan har återgetts.

callback(Function) - återanropet skickas som ett argument, formulärobjektet för det återgivna formuläret.

.render(formElem)

Återger ett formulärobjekt och returnerar ett jQuery-objekt som kapslar in ett formulärelement som innehåller formuläret. Om ett formElem skickas kommer det att användas som formulärelement, annars skapas ett nytt.

formElem (valfritt) - Ett jQuery-objektomslutet formulärelement som ska återges.

Ett jQuery-objektomslutet formulärelement som innehåller det återgivna formuläret.

.getId()

Hämtar formulärets ID.

n/a

Number - ID:t för det formulärobjekt som det här formuläret representerar

.getFormElem()

Hämtar det jQuery-figursatta formulärelementet för ett återgivet formulär.

n/a

Ett jQuery-objektomslutet formulärelement eller null om formuläret ännu inte har renderats med metoden render().

.validate()

Tvingar formuläret att validera, markera eventuella fel som kan finnas och returnera resultatet. Skickar inte formuläret.

n/a

Boolean - Returnerar true om alla validerare i formuläret skickas. Annars returneras false.

.onValidate(callback)

Lägger till ett återanrop för validering som anropas när valideringen utlöses.

callback(Function) - ett återanrop som aktiveras när valideringen inträffar. Återanropet skickas med en parameter, ett booleskt värde som anger om valideringen lyckades.

Formulärobjekt - Samma formulärobjekt som metoden anropades på, för kedjeändamål.

.submit()

Startar formulärets skicka-händelse. Detta startar formuläret från skicka-flödet, utför validering, aktiverar eventuella onSubmit-händelser, skickar formuläret och aktiverar eventuella onSuccess-händelser om formuläret kunde skickas.

n/a

Formulärobjekt - Samma formulärobjekt som metoden anropades på, för kedjeändamål.

.onSubmit(callback)

Lägger till ett återanrop som anropas när formuläret skickas. Detta utlöses när inlämningen börjar, innan det går att avgöra om begäran är slutförd eller inte.

callback - En funktion som anropas när formuläret skickas. Det här återanropet skickas med ett argument, det här formulärobjektet.

Formulärobjekt - Samma formulärobjekt som metoden anropades på, för kedjeändamål.

.onSuccess(callback)

Lägger till ett återanrop som anropas när formuläret har skickats men innan leadet vidarebefordras till uppföljningssidan. Kan användas för att förhindra att leadet vidarebefordras till uppföljningssidan efter att det har skickats.

callback - En funktion som anropas när formuläret har skickats. Det här återanropet skickas med två argument. Ett JS-objekt som innehåller de värden som skickades och en sträng-URL för den uppföljningssida som användaren kommer att vidarebefordras till, eller null eller tom sträng om det inte finns någon konfigurerad uppföljningssida. Speciellt beteende: Om återanropet returnerar "false" (mätt med ===) vidarebefordras besökaren INTE till uppföljningssidan och sidan läses INTE in igen. Detta gör att användaren kan utföra extra bearbetning på uppföljnings-URL:en eller vidta åtgärder på en sida med JavaScript istället för att lämna sidan.

Formulärobjekt - Samma formulärobjekt som metoden anropades på, för kedjeändamål.

.submitTable(canSubmit) är även tillgänglig som: .splatable(canSubmit)

Hämtar eller anger om formuläret kan skickas. Om det anropas utan argument hämtas värdet, om det anropas med ett argument, och värdet ställs in. Detta kan användas för att förhindra att ett formulär skickas, medan andra villkor utanför det normala formuläret måste uppfyllas.

canSubmit (valfritt)(Boolean) - Anger att formuläret ska kunna skickas eller inte skickas.

Boolesk eller Formulärobjekt - Om anropas utan argument returneras ett booleskt värde som anger om formuläret kan skickas. Om det anropas med ett argument returneras det här formulärobjektet för kedjeändamål.

.allFieldsFilled()

Returnerar true om alla fält i formuläret har värden som inte är tomma.

n/a

Boolean - True om alla fält har värden som inte är tomma/tomma/unset/null, annars false.

.setValues(vals)

Anger värden för ett eller flera fält i formuläret.

vals - Ett JS-objekt. För varje nyckel/värde-par i objektet ställs formulärfältet med namnet key in på value.

undefined

.getValues()

Hämtar alla värden för alla fält i formuläret.

n/a

Object - Ett JS-objekt som innehåller nyckel/värde-par som representerar namnen och värdena för fälten i formuläret.

.addHiddenFields(values)

Lägger till indatatyp=dolda fält i formuläret.

values - A JS Object containing key/value pairs representing the names and values of the hidden fields to add to the form.

undefined

.vals(values)

jQuery style .vals() setter/getter. Om det anropas utan argument motsvarar det att anropa getValues(). Om det anropas med ett argument, motsvarar det anropande setValues()

värden (valfritt) - Objekt

undefined

.showErrorMessage(msg, elements)

Visar ett felmeddelande som pekar på ett element.

msg (String of HTML) - en sträng som innehåller texten för det fel som du vill visa.

Formulärobjekt - det här formulärobjektet, för kedjning.

element (valfritt)(jQuery-objekt) - Det element som felet ska peka på. Om det inte är aktiverat används formulärets Skicka-knapp.