Forms API-naslag

Er zijn twee hoofdobjecten waarmee u werkt met de Forms 2.0-API. De MktoForms2 en de Form object. De MktoForms2 -object is de naamruimte op hoofdniveau die zichtbaar is voor Forms2-functionaliteit en bevat functies voor het maken, laden en ophalen van formulierobjecten.

Methoden van MktoForms2

Methode
Beschrijving
Parameters
Retourneert
.loadForm(baseUrl, munchkinId, formId, callback)
Hiermee wordt een formulierdescriptor geladen vanaf Marketo-servers en wordt een nieuw object Form gemaakt.
baseUrl(String) - URL naar de Marketo-serverinstantie voor uw abonnement
ongedefinieerd
munchkinId (String) -Munchkin-id van het abonnement
formId (String of Number) - De Vid (form version id) van het formulier dat moet worden geladen
callback (optioneel) (Functie) - Een callback-functie waarmee het geconstrueerde object Form wordt doorgegeven nadat het is geladen en geïnitialiseerd.
.lightbox(form, opts)
Hiermee wordt een modaal dialoogvenster met de stijl van de lichtbak gemaakt waarin het formulierobject zich bevindt.
form (Form Object) - Een instantie van een object Form dat u in een lichtbak wilt weergeven.
Een lichtbakobject met de methoden .show() en .hide().
opts (optioneel)(Object) - Een object met opties die worden doorgegeven aan het lichtbakobject
onSuccess(Functie) - Een callback die wordt teweeggebracht wanneer de vorm wordt voorgelegd.
closeBtn (Boolean) standaard waar - Controles als een dichte knoop (X) op de lichtbakdialoog wordt getoond.
.newForm(formData, callback)
Maakt een nieuw object Form van een JS-object Form Descriptor. Voegt een callback functie toe die wordt geroepen zodra alle stylesheets en bekende loodinformatie is opgehaald en het voorwerp van de Vorm is gecreeerd.
formData (Object Form Descriptor) - Een formulierbeschrijvingsobject, zoals gemaakt door de Marketo Forms V2 Editor
ongedefinieerd
callback (optional)(Function) - Deze callback wordt aangeroepen met één argument, een nieuw gemaakt exemplaar van het object Form.
.getForm(formId)
Hiermee wordt een eerder gemaakt formulierobject opgehaald op basis van een formulierid
formId (Number of String) - Vid-id van formulier.
Formulierobject
.allForms()
Hiermee wordt een array opgehaald van alle formulierobjecten die eerder op de pagina zijn gemaakt.
nvt
Array van formulierobject
.getPageFields()
Haalt een JS-object op dat gegevens van de URL en de verwijzende persoon bevat die interessant kunnen zijn voor traceringsdoeleinden.
nvt
Object
.whenReady(callback)
Hiermee voegt u een callback toe die precies één keer wordt aangeroepen voor elk formulier op de pagina dat "gereed" wordt. Gereedheid betekent dat het formulier bestaat, in eerste instantie is gegenereerd en de initiële callbacks zijn opgeroepen. Als er al een formulier is dat gereed is op het moment dat deze functie wordt aangeroepen, wordt de doorgegeven callback onmiddellijk aangeroepen.
callback(Function) - De callback wordt doorgegeven aan één argument, een formulierobject.
Object MktoForms2
.onFormRender(callback)
Hiermee voegt u een callback toe die wordt aangeroepen wanneer een formulier op de pagina wordt weergegeven. Forms wordt weergegeven wanneer het wordt gemaakt en vervolgens telkens wanneer de zichtbaarheidsregels de structuur van het formulier wijzigen.
callback (Function) - De callback wordt doorgegeven aan één argument, het formulierobject van het formulier dat is gegenereerd.
Object MktoForms2
.whenRendered(callback)
Net als bij onFormRender voegt dit een callback toe die wordt aangeroepen telkens wanneer een formulier wordt gegenereerd. Daarnaast wordt de callback onmiddellijk opgeroepen voor alle formulieren die al zijn gegenereerd.
callback(Function) - Aan de callback wordt één argument doorgegeven, het formulierobject van het gegenereerde formulier.

Formuliermethoden

Methode
Beschrijving
Parameters
Retourneert
.render(formElem)
Hiermee wordt een formulierobject gegenereerd, waarbij een jQuery-object wordt geretourneerd waarin een formulierelement met het formulier wordt ondergebracht. Als een formElem wordt doorgegeven, wordt dit gebruikt als het formulierelement. Als dit niet het geval is, wordt er een nieuw formulier gemaakt.
formElem (optioneel) - Een formulierelement met een jQuery-object waarin moet worden gerenderd.
Een formulierelement met een jQuery-object dat het weergegeven formulier bevat.
.getId()
Hiermee wordt de id van het formulier opgehaald.
nvt
Number - De id van het formulierobject dat dit formulier vertegenwoordigt
.getFormElem()
Haalt het formulierelement met jQuery-inhoud van een gegenereerd formulier op.
nvt
A jQuery object-wrapped form element or null if the form has not been rendered with the render() method yet.
.validate()
Forces the form to validate, highlight any errors that may exist and return the result. Hiermee verzendt u het formulier niet.
nvt
Boolean - Retourneert true als alle validators op het formulier zijn geslaagd, anders false.
.onValidate(callback)
Voegt een validatiecallback toe die op elk moment dat de validatie wordt geactiveerd, wordt aangeroepen.
callback(Function) - Een callback die zal worden teweeggebracht wanneer de bevestiging voorkomt. Callback zal één parameter, een booleaanse verklaring worden overgegaan als de bevestiging was geslaagd.
Formulierobject: hetzelfde formulierobject waarvoor de methode is aangeroepen, voor kettingdoeleinden.
.submit()
De verzendgebeurtenis van het formulier wordt geactiveerd. Hiermee start u het formulier via de verzendstroom, waarbij u validatie uitvoert, gebeurtenissen onSubmit activeert, het formulier verzendt en eventuele gebeurtenissen onSuccess afvaagt als het verzenden van het formulier is gelukt.
nvt
Formulierobject: hetzelfde formulierobject waarvoor de methode is aangeroepen, voor kettingdoeleinden.
.onSubmit(callback)
Hiermee voegt u een callback toe die wordt aangeroepen wanneer het formulier wordt verzonden. Dit wordt in werking gesteld wanneer de voorlegging begint, alvorens het succes/het mislukken van het verzoek wordt gekend.
callback - Een functie die wordt aangeroepen wanneer het formulier wordt verzonden. Deze callback wordt doorgegeven aan één argument, dit object Form.
Formulierobject: hetzelfde formulierobject waarvoor de methode is aangeroepen, voor kettingdoeleinden.
.onSuccess(callback)
Hiermee voegt u een callback toe die wordt aangeroepen wanneer het formulier is verzonden maar voordat de lead naar de vervolgpagina is doorgestuurd. Kan worden gebruikt om te voorkomen dat de lead na een geslaagde verzending naar de vervolgpagina wordt doorgestuurd.
callback - Een functie die wordt aangeroepen wanneer het formulier is verzonden. Deze callback zal twee argumenten worden overgegaan. Een voorwerp JS die de waarden bevatten die werden voorgelegd en een URL van het Koord van de opvolgingspagina die de gebruiker aan, of ongeldig of leeg koord zal door:sturen als er geen gevormde opvolgingspagina is. Speciaal gedrag: Als deze callback "false"terugkeert (gemeten gebruikend ===) dan zal de bezoeker NIET aan de opvolgingspagina door:sturen en de pagina zal NIET worden opnieuw geladen. Hierdoor kan de implementator extra verwerkingen uitvoeren naar de follow-up-URL of actie ondernemen op de pagina met JavaScript in plaats van de pagina te verlaten.
Formulierobject: hetzelfde formulierobject waarvoor de methode is aangeroepen, voor kettingdoeleinden.
.submitTable(canSubmit) ook beschikbaar als: .submitable(canSubmit)
Hiermee wordt opgehaald of ingesteld of het formulier kan worden verzonden. Als deze functie zonder argumenten wordt aangeroepen, krijgt deze de waarde als deze met één argument wordt aangeroepen. Hiermee wordt voorkomen dat een formulier wordt verzonden, terwijl aan andere criteria buiten de normale vorm moet worden voldaan.
canSubmit (optioneel)(Boolean) - Hiermee wordt ingesteld dat het formulier moet worden verzonden of niet kan worden verzonden.
Booleaanse waarde of formulierobject - Bij aanroep zonder argumenten wordt een Booleaanse waarde geretourneerd die aangeeft of het formulier kan worden verzonden. Als deze optie met één argument wordt aangeroepen, wordt dit formulierobject geretourneerd voor kettingdoeleinden.
.allFieldsFilled()
Retourneert true als voor alle velden in het formulier waarden zijn ingesteld die niet leeg zijn.
nvt
Boolean - True als alle velden waarden hebben die niet leeg, leeg, niet ingesteld of null zijn, anders false.
.setValues(vals)
Hiermee stelt u waarden in voor een of meer velden in het formulier.
vals - Een JS-object. Voor elk sleutel-/waardepaar in het object wordt het formulierveld met de naam key ingesteld op waarde.
ongedefinieerd
.getValues()
Hiermee worden alle waarden van alle velden in het formulier opgehaald.
nvt
Object - Een JS-object dat sleutel/waardeparen bevat die de namen en waarden van de velden in het formulier vertegenwoordigen.
.addHiddenFields(values)
Hiermee voegt u invoerveld type=hidden toe aan het formulier.
waarden - Een JS-object dat sleutel/waardeparen bevat die de namen en waarden vertegenwoordigen van de verborgen velden die aan het formulier moeten worden toegevoegd.
ongedefinieerd
.vals(waarden)
jQuery-stijl .vals() setter/getter. Indien aangeroepen zonder argumenten, is dit gelijk aan het aanroepen van getValues(). Indien aangeroepen met één argument, is gelijk aan het aanroepen van setValues()
waarden (optioneel) - Object
ongedefinieerd
.showErrorMessage(msg, elem)
Toont een foutenmelding, richtend bij elem.
msg (Koord van HTML) - een koord die de tekst van de fout bevatten u wilt tonen.
Formulierobject - Dit formulierobject, voor ketting.
elem (optioneel)(jQuery-object) - Het element waarnaar de fout moet verwijzen. Als de waarde niet is ingesteld, wordt de verzendknop van het formulier gebruikt.
recommendation-more-help
bb269a6d-047a-4bf7-9acd-23ad9a63dc59