Forms API-Referenz

Es gibt zwei Hauptobjekte, mit denen Sie mit der Forms 2.0-API interagieren. Die MktoForms2 und dem Form -Objekt. Die MktoForms2 -Objekt ist der öffentlich sichtbare Namespace der obersten Ebene für Forms2-Funktionen und enthält Funktionen zum Erstellen, Laden und Abrufen von Formularobjekten.

MktoForms2-Methoden

Methode
Beschreibung
Parameter
Rückgaben
.loadForm(baseUrl, munchkinId, formId, callback)
Lädt einen Formulardeskriptor von Marketo-Servern und erstellt ein neues Formularobjekt.
baseUrl(String) - URL zur Marketo-Serverinstanz für Ihr Abonnement
nicht definiert
munchkinId (String) -Munchkin-ID des Abonnements
formId (Zeichenfolge oder Zahl) - Die Formular-Version-ID (Vid) des Formulars, das geladen werden soll
callback (optional) (Funktion) - Eine Rückruffunktion, die das konstruierte Formularobjekt nach dem Laden und Initialisieren an weitergibt.
.lightbox(form, opts)
Gibt ein modales Dialogfeld mit Lightbox-Stil-Stil mit dem darin enthaltenen Formularobjekt wieder.
form (Form Object) - Eine Instanz eines Formularobjekts, das Sie in einer Lightbox wiedergeben möchten.
Ein Lightbox-Objekt mit den Methoden .show() und .hide().
opts (optional)(Object) - Ein Objekt von Optionen, die an das Lightbox-Objekt übergeben werden
onSuccess(Function) - Ein Callback, der beim Senden des Formulars ausgelöst wird.
closeBtn(Boolean) default true - Steuert, ob eine Schließen-Schaltfläche (X) im Lightbox-Dialogfeld angezeigt wird.
.newForm(formData, callback)
Erstellt ein neues Formularobjekt aus einem Formulardeskriptor-JS-Objekt. Fügt eine Callback-Funktion hinzu, die aufgerufen wird, sobald alle Stylesheets und bekannten Lead-Informationen abgerufen und das Formularobjekt erstellt wurde.
formData (Form Descriptor Object) - Ein Formulardeskriptorobjekt, wie vom Marketo Forms V2-Editor erstellt
nicht definiert
callback (optional)(Funktion) - Dieser Rückruf wird mit einem einzelnen Argument aufgerufen, einer neu erstellten Instanz des Formularobjekts.
.getForm(formId)
Ruft ein zuvor erstelltes Formularobjekt anhand der Formular-ID ab
formId (Zahl oder Zeichenfolge) - Formular-ID-Kennung.
Formularobjekt
.allForms()
Ruft ein Array aller Formularobjekte ab, die zuvor auf der Seite erstellt wurden.
Nicht zutreffend
Array von Formularobjekten
.getPageFields()
Ruft ein JS-Objekt ab, das Daten aus der URL und dem Referrer enthält, die für Tracking-Zwecke interessant sein können.
Nicht zutreffend
Objekt
.whenReady(callback)
Fügt einen Rückruf hinzu, der genau einmal für jedes Formular auf der Seite aufgerufen wird, das "bereit"wird. "Bereitschaft"bedeutet, dass das Formular vorhanden ist, ursprünglich wiedergegeben wurde und die ersten Rückrufe aufgerufen wurden. Wenn bereits ein Formular vorhanden ist, das zum Zeitpunkt des Aufrufs dieser Funktion bereit ist, wird der übergebene Rückruf sofort aufgerufen.
callback(Function) - Der Rückruf wird an ein einzelnes Argument übergeben, ein Formularobjekt.
MktoForms2-Objekt
.onFormRender(callback)
Fügt einen Rückruf hinzu, der jedes Mal aufgerufen wird, wenn ein Formular auf der Seite gerendert wird. Forms werden bei der anfänglichen Erstellung wiedergegeben und jedes Mal, wenn diese Sichtbarkeitsregeln die Struktur des Formulars ändern.
callback (Funktion) - Der Rückruf wird an ein einzelnes Argument übergeben, das Formularobjekt des wiedergegebenen Formulars.
MktoForms2-Objekt
.whenRendered(callback)
Wie onFormRender fügt dies einen Callback hinzu, der jedes Mal aufgerufen wird, wenn ein Formular wiedergegeben wird. Darüber hinaus wird dadurch auch der Rückruf sofort für alle Formulare aufgerufen, die bereits wiedergegeben wurden.
callback(Function) - Der Rückruf wird an ein einzelnes Argument übergeben, das Formularobjekt des wiedergegebenen Formulars.

Formularmethoden

Methode
Beschreibung
Parameter
Rückgaben
.render(formElem)
Gibt ein Formularobjekt wieder und gibt ein jQuery-Objekt zurück, das ein Formularelement umschließt, das das Formular enthält. Wenn ein formElement übergeben wird, wird dieses als Formularelement verwendet, andernfalls wird ein neues erstellt.
formElement (optional) - Ein jQuery-Objekt-umschlossenes Formularelement, in das gerendert werden soll.
Ein mit einem jQuery-Objekt umschlossenes Formularelement, das das wiedergegebene Formular enthält.
.getId()
Ruft die ID des Formulars ab.
Nicht zutreffend
Number - Die ID des Formularobjekts, das dieses Formular darstellt
.getFormElem()
Ruft das umschlossene jQuery-Formularelement eines wiedergegebenen Formulars ab.
Nicht zutreffend
Ein mit einem jQuery-Objekt umschlossenes Formularelement oder null , wenn das Formular noch nicht mit der render()-Methode wiedergegeben wurde.
.validate()
Erzwingt die Validierung des Formulars, markiert etwaige Fehler und gibt das Ergebnis zurück. Sendet das Formular nicht.
Nicht zutreffend
Boolesch - Gibt "true"zurück, wenn alle Validatoren im Formular übergeben wurden, andernfalls "false".
.onValidate(callback)
Fügt einen Validierungs-Callback hinzu, der jedes Mal aufgerufen wird, wenn eine Validierung ausgelöst wird.
callback(Function) - Ein Callback, der jedes Mal ausgelöst wird, wenn eine Überprüfung erfolgt. Der Rückruf wird an einen Parameter übergeben, ein boolescher Wert, der angibt, ob die Überprüfung erfolgreich war.
Formularobjekt: Das gleiche Formularobjekt, für das die Methode aufgerufen wurde, zu Verkettungszwecken.
.submit()
Trigger des Sendeintereignisses des Formulars. Dadurch wird der Formularübermittlungsfluss gestartet, eine Überprüfung durchgeführt, alle onSubmit-Ereignisse ausgelöst, das Formular gesendet und alle onSuccess-Ereignisse ausgelöst, wenn die Formularübermittlung erfolgreich war.
Nicht zutreffend
Formularobjekt: Das gleiche Formularobjekt, für das die Methode aufgerufen wurde, zu Verkettungszwecken.
.onSubmit(callback)
Fügt einen Rückruf hinzu, der beim Senden des Formulars aufgerufen wird. Dies wird ausgelöst, wenn die Übermittlung beginnt, bevor der Erfolg/Misserfolg der Anfrage bekannt ist.
callback - Eine Funktion, die aufgerufen wird, wenn das Formular gesendet wird. Dieser Rückruf wird an ein Argument übergeben, dieses Form -Objekt.
Formularobjekt: Das gleiche Formularobjekt, für das die Methode aufgerufen wurde, zu Verkettungszwecken.
.onSuccess(callback)
Fügt einen Rückruf hinzu, der aufgerufen wird, wenn das Formular erfolgreich gesendet wurde, aber bevor der Lead an die Nachverfolgungsseite weitergeleitet wird. Kann verwendet werden, um zu verhindern, dass der Lead nach erfolgreicher Übermittlung an die Nachverfolgungsseite weitergeleitet wird.
callback - Eine Funktion, die aufgerufen wird, wenn das Formular erfolgreich gesendet wurde. Dieser Rückruf wird zwei Argumente übergeben. Ein JS-Objekt, das die gesendeten Werte und eine String-URL der Nachverfolgungsseite enthält, an die der Benutzer weitergeleitet wird, oder eine Null- oder leere Zeichenfolge, wenn keine konfigurierte Nachverfolgungsseite vorhanden ist. Sonderverhalten: Wenn dieser Rückruf "false"(gemessen mit ====) zurückgibt, wird der Besucher NICHT an die Folgenachricht weitergeleitet und die Seite wird NICHT neu geladen. Auf diese Weise kann der Implementor zusätzliche Verarbeitungsschritte für die Follow-up-URL durchführen oder Aktionen auf der Seite mit JavaScript ausführen, anstatt die Seite zu verlassen.
Formularobjekt: Das gleiche Formularobjekt, für das die Methode aufgerufen wurde, zu Verkettungszwecken.
.submittable(canSubmit) auch verfügbar als: .submitable(canSubmit)
Ruft ab oder legt fest, ob das Formular gesendet werden kann. Wenn sie ohne Argumente aufgerufen wird, erhält sie den Wert. Wenn sie mit einem Argument aufgerufen wird, setzt sie den Wert. Damit kann verhindert werden, dass ein Formular gesendet wird, während andere Kriterien außerhalb des normalen Formulars erfüllt sein müssen.
canSubmit (optional) (Boolesch) - Legt fest, dass das Formular gesendet werden kann oder nicht gesendet werden kann.
Boolesch oder Formularobjekt: Wenn ohne Argumente aufgerufen wird, wird ein boolescher Wert zurückgegeben, der angibt, ob das Formular übermittelt werden kann. Wenn mit einem -Argument aufgerufen wird, wird dieses Formularobjekt zu Verkettungszwecken zurückgegeben.
.allFieldsFilled()
Gibt "true"zurück, wenn für alle Felder im Formular Werte festgelegt sind, die nicht leer sind.
Nicht zutreffend
Boolesch - True , wenn alle Felder nicht leere/leere/unset/null-Werte aufweisen, andernfalls false .
.setValues(vals)
Legt Werte für ein oder mehrere Felder im Formular fest.
vals - Ein JS-Objekt. Für jedes Schlüssel/Wert-Paar im Objekt wird das Formularfeld mit dem Namen key auf value festgelegt.
nicht definiert
.getValues()
Ruft alle Werte aller Felder im Formular ab.
Nicht zutreffend
Objekt - Ein JS-Objekt, das Schlüssel/Wert-Paare enthält, die die Namen und Werte der Felder im Formular darstellen.
.addHiddenFields(values)
Fügt dem Formular "input type=hidden"-Felder hinzu.
values - Ein JS-Objekt, das Schlüssel/Wert-Paare enthält, die die Namen und Werte der ausgeblendeten Felder darstellen, die zum Formular hinzugefügt werden sollen.
nicht definiert
.vals(values)
jQuery style .vals() setter/getter. Wenn ohne Argumente aufgerufen wird, entspricht dem Aufruf von getValues(). Wenn mit einem -Argument aufgerufen wird, entspricht dem Aufruf von setValues()
values (optional) - Object
nicht definiert
.showErrorMessage(msg, elem)
Zeigt eine Fehlermeldung mit einem Verweis auf das Element an.
msg (Zeichenfolge der HTML) - Eine Zeichenfolge, die den Text des anzuzeigenden Fehlers enthält.
Formularobjekt - Dieses Formularobjekt zum Verketten.
elem (optional)(jQuery Object) - Das Element, auf das der Fehler verweisen soll. Wenn diese Option deaktiviert ist, wird die Senden-Schaltfläche des Formulars verwendet.
recommendation-more-help
bb269a6d-047a-4bf7-9acd-23ad9a63dc59