Riferimento API di Forms

Esistono due oggetti principali con cui interagirai utilizzando l’API di Forms 2.0. Il MktoForms2 oggetto e Form oggetto. Il MktoForms2 L'oggetto è lo spazio dei nomi di primo livello pubblicamente visibile per la funzionalità di Forms2 e contiene funzioni per la creazione, il caricamento e il recupero di oggetti Form.

Metodi MktoForms2

Metodo
Descrizione
Parametri
Restituisce
.loadForm(baseUrl, munchkinId, formId, callback)
Carica un descrittore di modulo dai server Marketo e crea un nuovo oggetto Form.
baseUrl(String) - URL dell’istanza del server Marketo per la sottoscrizione
non definito
munchkinId (String) - ID Munchkin dell’abbonamento
formId (String o Number): l’ID versione modulo (Vid) del modulo da caricare
callback (facoltativo) (funzione): funzione di callback a cui passare l'oggetto Form costruito dopo averlo caricato e inizializzato.
.lightbox(form, opts)
Esegue il rendering di una finestra di dialogo modale in stile lightbox con l'oggetto Form al suo interno.
form (oggetto Form) - Istanza di un oggetto Form di cui si desidera eseguire il rendering in un lightbox.
Oggetto lightbox con i metodi .show() e .hide().
opts (optional)(Object) - Oggetto di opzioni passato all'oggetto lightbox
onSuccess(Function) - Callback attivato quando il modulo viene inviato.
closeBtn(Boolean) default true - Controlla se nella finestra di dialogo Lightbox viene visualizzato un pulsante di chiusura (X).
.newForm(formData, callback)
Crea un nuovo oggetto Form da un oggetto JS del descrittore del modulo. Aggiunge una funzione di callback chiamata dopo il recupero di tutti i fogli di stile e delle informazioni sul lead noto e la creazione dell'oggetto Form.
formData (oggetto descrittore modulo): un oggetto descrittore del modulo, come creato dall’editor di Marketo Forms V2
non definito
callback (facoltativo)(Function) - Questo callback viene chiamato con un singolo argomento, un'istanza appena creata dell'oggetto Form.
.getForm(formId)
Ottiene un oggetto Form creato in precedenza tramite l'identificatore di modulo
formId (numero o stringa) - Identificatore ID modulo.
Oggetto modulo
.allForms()
Recupera un array di tutti gli oggetti modulo creati in precedenza nella pagina.
n/d
Array di oggetto modulo
.getPageFields()
Ottiene un oggetto JS contenente i dati dell'URL e del referente che possono essere interessanti a scopo di tracciamento.
n/d
Oggetto
.whenReady(callback)
Aggiunge un callback che viene chiamato esattamente una volta per ogni modulo sulla pagina che diventa "pronto". La preparazione significa che il modulo esiste, è stato inizialmente renderizzato e i suoi callback iniziali sono stati chiamati. Se esiste già un modulo pronto al momento della chiamata di questa funzione, il callback passato viene chiamato immediatamente.
callback(Function) - Al callback viene passato un singolo argomento, un oggetto form.
Oggetto MktoForms2
.onFormRender(callback)
Aggiunge un callback chiamato ogni volta che viene eseguito il rendering di un modulo della pagina. Viene eseguito il rendering di Forms al momento della creazione iniziale, quindi ogni volta che le regole di visibilità modificano la struttura del modulo.
callback (Function) - Al callback viene passato un singolo argomento, l'oggetto form del form di cui è stato eseguito il rendering.
Oggetto MktoForms2
.whenRendered(callback)
Analogamente a onFormRender, questo comando aggiunge un callback che viene chiamato ogni volta che viene eseguito il rendering di un modulo. Inoltre, richiama immediatamente il callback per tutti i moduli di cui è già stato eseguito il rendering.
callback(Function) - Al callback viene passato un singolo argomento, l'oggetto form del form di cui è stato eseguito il rendering.

Metodi modulo

Metodo
Descrizione
Parametri
Restituisce
.render(formElem)
Esegue il rendering di un oggetto modulo, restituendo un oggetto jQuery che racchiude un elemento modulo che contiene il modulo. Se viene passato un formElem, questo verrà utilizzato come elemento del form, altrimenti ne verrà creato uno nuovo.
formElem (facoltativo): elemento form racchiuso in un oggetto jQuery in cui eseguire il rendering.
Elemento form con wrapping di oggetti jQuery contenente il form sottoposto a rendering.
.getId()
Ottiene l'ID del modulo.
n/d
Numero: l’ID dell’oggetto modulo rappresentato da questo modulo
.getFormElem()
Ottiene l'elemento form con wrapping jQuery di un form di cui è stato eseguito il rendering.
n/d
Elemento form con wrapping di oggetti jQuery oppure null se il form non è ancora stato sottoposto a rendering con il metodo render().
.validate()
Forza la convalida del modulo, evidenziando eventuali errori e restituendo il risultato. Non invia il modulo.
n/d
Booleano: restituisce true se tutte le convalide nel modulo sono state passate, in caso contrario restituisce false.
.onValidate(callback)
Aggiunge un callback di convalida che verrà chiamato ogni volta che viene attivata la convalida.
callback(Function): callback che verrà attivato ogni volta che si verifica la convalida. Al callback verrà trasmesso un parametro, un valore booleano che indica se la convalida è riuscita.
Oggetto Form: lo stesso oggetto form in cui è stato chiamato il metodo, a scopo di concatenamento.
.submit()
Attiva l'evento di invio del modulo. In questo modo si avvia il flusso di invio da, si esegue la convalida, si attivano eventuali eventi onSubmit, si invia il modulo e si attivano eventuali eventi onSuccess se l’invio del modulo ha avuto esito positivo.
n/d
Oggetto Form: lo stesso oggetto form in cui è stato chiamato il metodo, a scopo di concatenamento.
.onSubmit(callback)
Aggiunge un callback che verrà chiamato quando il modulo viene inviato. Viene attivato all’inizio dell’invio, prima che sia noto l’esito positivo o negativo della richiesta.
callback: funzione che verrà chiamata quando il modulo verrà inviato. Questo callback riceverà un argomento, questo oggetto Form.
Oggetto Form: lo stesso oggetto form in cui è stato chiamato il metodo, a scopo di concatenamento.
.onSuccess(callback)
Aggiunge un callback che verrà chiamato quando il modulo verrà inviato correttamente ma prima che il lead venga inoltrato alla pagina di follow-up. Può essere utilizzato per impedire che il lead venga inoltrato alla pagina di follow-up dopo l’invio corretto.
callback: funzione che verrà chiamata quando il modulo verrà inviato correttamente. A questo callback verranno passati due argomenti. Un oggetto JS contenente i valori inviati e un URL String della pagina di follow-up a cui l’utente verrà inoltrato, oppure una stringa nulla o vuota se non è presente una pagina di follow-up configurata. Comportamento speciale: se questo callback restituisce "false" (misurato con ===), il visitatore NON verrà inoltrato alla pagina di follow-up e la pagina NON verrà ricaricata. Questo consente all’implementatore di eseguire elaborazioni aggiuntive all’URL di follow-up o di intervenire sulla pagina utilizzando JavaScript invece di uscire dalla pagina.
Oggetto Form: lo stesso oggetto form in cui è stato chiamato il metodo, a scopo di concatenamento.
.submittable(canSubmit) disponibile anche come: .submitable(canSubmit)
Ottiene o imposta se è possibile inviare il modulo. Se chiamato senza argomenti, ottiene il valore, se chiamato con un argomento imposta il valore. Questo può essere utilizzato per impedire l'invio di una maschera mentre devono essere soddisfatti altri criteri al di fuori della maschera normale.
canSubmit (facoltativo)(booleano) - Imposta il modulo in modo che sia inviabile o non inviabile.
Booleano o oggetto modulo: se chiamato senza argomenti, restituisce un valore booleano che indica se il modulo è inviabile. Se chiamato con un argomento, restituisce questo oggetto Form a scopo di concatenamento.
.allFieldsFilled()
Restituisce true se per tutti i campi del modulo sono impostati valori non vuoti.
n/d
Booleano: True se tutti i campi hanno valori non vuoti/vuoti/non impostati/nulli, in caso contrario false.
.setValues(vals)
Imposta i valori in uno o più campi del modulo.
vals - Un oggetto JS. Per ogni coppia chiave/valore nell’oggetto, il campo modulo denominato chiave verrà impostato su valore.
non definito
.getValues()
Ottiene tutti i valori di tutti i campi del modulo.
n/d
Oggetto: oggetto JS contenente coppie chiave/valore che rappresentano i nomi e i valori dei campi nel modulo.
.addHiddenFields(values)
Aggiunge al modulo il valore type=hidden fields.
values - Oggetto JS contenente coppie chiave/valore che rappresentano i nomi e i valori dei campi nascosti da aggiungere al modulo.
non definito
.vals(values)
Imposta/getter stile jQuery .vals(). Se viene chiamato senza argomenti, equivale a chiamare getValues(). Se viene chiamato con un argomento, equivale a chiamare setValues()
Valori (facoltativi) - Oggetto
non definito
.showErrorMessage(msg, elem)
Visualizza un messaggio di errore che indica l'elemento.
msg (String of HTML) - Stringa contenente il testo dell’errore che si desidera visualizzare.
Oggetto modulo: questo oggetto modulo, per il concatenamento.
elem (facoltativo)(jQuery Object): l’elemento a cui deve puntare l’errore. Se non viene impostato, viene utilizzato il pulsante di invio del modulo.
recommendation-more-help
bb269a6d-047a-4bf7-9acd-23ad9a63dc59