Forms-API-Referenz

Letzte Aktualisierung: 31. Dezember 2024

Erstellt für:

  • Admin

Es gibt zwei Hauptobjekte, mit denen Sie mithilfe der Forms 2.0-API interagieren werden. Das MktoForms2 und das Form. Das 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

MethodeBeschreibungParameterRückgaben
.loadForm(baseUrl, munchkinId, formId, callback)Lädt einen Formulardeskriptor von den Marketo-Servern und erstellt ein neues Formularobjekt.baseUrl(String) - URL zur Marketo-Serverinstanz für Ihr Abonnementnicht definiert
munchkinId (String) -Munchkin-ID des Abonnements
formId (Zeichenfolge oder Zahl) - Die Formularversions-ID (Vid) des zu ladenden Formulars
Callback (optional) (Funktion) - Eine Callback-Funktion, mit der das erstellte Formularobjekt an übergeben wird, nachdem es geladen und initialisiert wurde.
.Lightbox(form, opts)Rendert ein modales Dialogfeld im Lightbox-Stil mit dem darin enthaltenen Formularobjekt.form (Formularobjekt) - Eine Instanz eines Formularobjekts, das Sie in einer Lightbox gerendert haben möchten.Ein Lightbox-Objekt mit den Methoden .show() und .hide().
opts (optional)(Object) - Ein Objekt mit Optionen, die an das Lightbox-Objekt übergeben werden
onSuccess(Funktion) - Ein Rückruf, der ausgelöst wird, wenn das Formular übermittelt wird.
closeBtn(Boolescher Wert) default true - Steuert, ob im Lightbox-Dialogfeld eine Schaltfläche zum Schließen (X) angezeigt wird.
.newForm(formData, callback)Erstellt ein neues Formularobjekt aus einem JS-Objekt für den Formulardeskriptor. Fügt eine Callback-Funktion hinzu, die aufgerufen wird, sobald alle Stylesheets und bekannte Lead-Informationen abgerufen und das Formularobjekt erstellt wurde.formData (Formulardeskriptorobjekt) - Ein Formulardeskriptorobjekt, wie es vom Marketo Forms V2-Editor erstellt wurdenicht definiert
Callback (optional) (Funktion) - Dieser Callback wird mit einem einzigen Argument aufgerufen, einer neu erstellten Instanz des Formularobjekts.
.getForm(formId)Ruft ein zuvor erstelltes Formularobjekt anhand der Formularkennung abformId (Zahl oder Zeichenfolge) - Formular-VID-Kennung.Formularobjekt
.allForms()Ruft ein Array aller Formularobjekte ab, die zuvor auf der Seite erstellt wurden.Nicht zutreffendArray von Formularobjekten
.getPageFields()Ruft ein JS-Objekt ab, das Daten von der URL und dem Referrer enthält, die für Tracking-Zwecke interessant sein können.Nicht zutreffendObjekt
.whenReady(callback)Fügt für jedes Formular auf der Seite, das „bereit“ wird, einen Callback hinzu, der genau einmal aufgerufen wird. Bereitschaft bedeutet, dass das Formular vorhanden ist, ursprünglich gerendert wurde und seine ersten Callbacks aufgerufen wurden. Wenn zum Zeitpunkt des Aufrufs dieser Funktion bereits ein Formular vorhanden ist, wird der übergebene Callback sofort aufgerufen.callback(Funktion) - Der Callback wird an ein einzelnes Argument, ein Formularobjekt, übergeben.MktoForms2-Objekt
.onFormRender(callback)Fügt einen Callback hinzu, der jedes Mal aufgerufen wird, wenn ein Formular auf der Seite gerendert wird. Forms werden gerendert, wenn sie anfänglich erstellt werden, und anschließend jedes Mal, wenn die Sichtbarkeitsregeln die Formularstruktur ändern.Callback (Funktion) - Dem Callback wird ein einzelnes Argument übergeben, das Formularobjekt des Formulars, das gerendert wurde.MktoForms2-Objekt
.whenRendered(callback)Wie onFormRender fügt dies einen Callback hinzu, der jedes Mal aufgerufen wird, wenn ein Formular gerendert wird. Außerdem wird dadurch der Callback sofort für alle Formulare aufgerufen, die bereits gerendert wurden.callback(Funktion) - Der Callback wird als einzelnes Argument übergeben, das Formularobjekt des gerenderten Formulars.

Formularmethoden

MethodeBeschreibungParameterRückgaben
.render(formElement)Rendert ein Formularobjekt und gibt ein jQuery-Objekt zurück, das ein Formularelement einschließt, das das Formular enthält. Wenn ein formElement übergeben wird, wird es als Formularelement verwendet, andernfalls wird ein neues erstellt.formElement (optional) - Ein von einem jQuery-Objekt umschlossenes Formularelement, in das gerendert werden soll.Ein in ein jQuery-Objekt eingeschlossenes Formularelement, das das gerenderte Formular enthält.
.getId()Ruft die ID des Formulars ab.Nicht zutreffendNumber : Die ID des Formularobjekts, das dieses Formular darstellt
.getFormElement()Ruft das in jQuery eingeschlossene Formularelement eines gerenderten Formulars ab.Nicht zutreffendEin in ein jQuery-Objekt eingeschlossenes Formularelement oder null, wenn das Formular noch nicht mit der render()-Methode gerendert wurde.
.validate()Erzwingt die Validierung des Formulars, wobei eventuell vorhandene Fehler hervorgehoben und das Ergebnis zurückgegeben werden. Sendet das Formular nicht.Nicht zutreffendBoolesch - Gibt „true“ zurück, wenn alle Validierer im Formular übergeben wurden, andernfalls „false“.
.onValidate(callback)Fügt einen Validierungsrückruf hinzu, der bei jeder ausgelösten Validierung aufgerufen wird.callback(Function) - Ein Callback, der bei jeder Validierung ausgelöst wird. Dem Callback wird ein Parameter übergeben, ein boolescher Wert, der angibt, ob die Validierung erfolgreich war.Formularobjekt : Dasselbe Formularobjekt, für das die Methode zu Verkettungszwecken aufgerufen wurde.
.submit()Trigger des Übermittlungsereignisses des Formulars. Dieser startet den Übermittlungsfluss, führt die Validierung durch, löst alle onSubmit-Ereignisse aus, übermittelt das Formular und löst alle onSuccess-Ereignisse aus, wenn die Formularübermittlung erfolgreich war.Nicht zutreffendFormularobjekt : Dasselbe Formularobjekt, für das die Methode zu Verkettungszwecken aufgerufen wurde.
.onSubmit(callback)Fügt einen Callback hinzu, der aufgerufen wird, wenn das Formular übermittelt wird. Dieser wird ausgelöst, wenn die Übermittlung beginnt, bevor der Erfolg/Misserfolg der Anfrage bekannt ist.Callback : Eine Funktion, die aufgerufen wird, wenn das Formular übermittelt wird. Diesem Callback wird ein Argument, dieses Formularobjekt, übergeben.Formularobjekt : Dasselbe Formularobjekt, für das die Methode zu Verkettungszwecken aufgerufen wurde.
.onSuccess(callback)Fügt einen Callback hinzu, der aufgerufen wird, wenn das Formular erfolgreich übermittelt wurde, aber bevor der Lead zur Folgeseite weitergeleitet wird. Kann verwendet werden, um zu verhindern, dass der Lead nach erfolgreicher Übermittlung an die Folgeseite weitergeleitet wird.Callback : Eine Funktion, die aufgerufen wird, wenn das Formular erfolgreich gesendet wurde. Dieser Callback wird mit zwei Argumenten weitergeleitet. Ein JS-Objekt, das die gesendeten Werte und eine String-URL der Folgeseite enthält, an die der Benutzer weitergeleitet wird, oder null oder leere Zeichenfolge, wenn keine konfigurierte Folgeseite vorhanden ist. Spezielles Verhalten: Wenn dieser Callback „false“ zurückgibt (gemessen mit ===), wird der Besucher NICHT zur Folgeseite weitergeleitet und die Seite NICHT neu geladen. Dadurch kann der Implementierer die Follow-up-URL zusätzlich verarbeiten oder eine Aktion auf der Seite mit JavaScript durchführen, anstatt die Seite zu verlassen.Formularobjekt : Dasselbe Formularobjekt, für das die Methode zu Verkettungszwecken aufgerufen wurde.
.submittable(canSubmit) auch verfügbar als: .submitable(canSubmit)Ruft ab oder legt fest, ob das Formular gesendet werden kann. Wird der Aufruf ohne Argumente durchgeführt, wird der Wert abgerufen. Wird er mit einem Argument aufgerufen, wird der Wert festgelegt. 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) (Boolescher Wert) - Legt das Formular als übermittelbar oder nicht übermittelbar fest.Boolescher Wert oder Formularobjekt - Wenn aufgerufen, aber ohne Argumente, wird ein boolescher Wert zurückgegeben, der angibt, ob das Formular übermittelt werden kann. Wird dieses Formularobjekt mit einem Argument aufgerufen, wird es zu Verkettungszwecken zurückgegeben.
.allFieldsFilled()Gibt „true“ zurück, wenn alle Felder im Formular nicht leere Werte aufweisen.Nicht zutreffendBoolesch - True, wenn alle Felder nicht leere/leere/unset/null-Werte aufweisen, andernfalls „false“.
.setValues(values)Legt Werte für ein oder mehrere Felder im Formular fest.calves : Ein JS-Objekt. Für jedes Schlüssel/Wert-Paar im -Objekt wird das Formularfeld mit dem Namen Schlüssel auf Wert festgelegt.nicht definiert
.getValues()Ruft alle Werte aller Felder im Formular ab.Nicht zutreffendObjekt - 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.Werte - Ein JS-Objekt, das Schlüssel/Wert-Paare enthält, die die Namen und Werte der ausgeblendeten Felder darstellen, die dem Formular hinzugefügt werden sollen.nicht definiert
.Vals(values)jQuery-Stil .vals() Setter/Getter. Wenn aufgerufen wird, ohne Argumente, entspricht dies dem Aufruf von getValues(). Wenn mit einem Argument aufgerufen wird, entspricht dies dem Aufruf von setValues()Werte (optional) - Objektnicht definiert
.showErrorMessage(msg, elem)Zeigt eine Fehlermeldung an, die auf ein Element verweist.msg (String von HTML) - Eine Zeichenfolge, die den Text des Fehlers enthält, den Sie anzeigen möchten.Formularobjekt - Dieses Formularobjekt zum Verketten.
element (optional)(jQuery-Objekt) - Das Element, auf das der Fehler verweisen soll. Wenn diese Option deaktiviert ist, wird die Senden-Schaltfläche des Formulars verwendet.
Vorherige SeiteBeispiele
Nächste SeiteBesucherdaten abrufen

Marketo Engage