Référence de l’API Forms

.loadForm(baseUrl, munchkinId, formId, callback)

Charge un descripteur de formulaire depuis les serveurs Marketo et crée un objet de formulaire.

baseUrl(String) - URL de l’instance de serveur Marketo pour votre abonnement

indéfini

munchkinId (chaîne) : ID Munchkin de l’abonnement

formId (chaîne ou nombre) - ID de version de formulaire (Vid) du formulaire à charger

callback (facultatif) (Fonction) - Fonction de rappel à laquelle transmettre l’objet de formulaire construit une fois qu’il a été chargé et initialisé.

.lightbox(form, opts)

Rend une boîte de dialogue modale de style Lightbox contenant l’objet Form.

form (objet de formulaire) - Instance d’un objet de formulaire que vous souhaitez rendre dans une lightbox.

Objet Lightbox avec les méthodes .show() et .hide().

opts (optional)(Object) - Objet d’options transmises à l’objet Lightbox

onSuccess(Function) - Un rappel déclenché lors de l’envoi du formulaire.

closeBtn(Boolean) default true - Contrôle si un bouton de fermeture (X) est affiché dans la boîte de dialogue Lightbox.

.newForm(formData, callback)

Crée un nouvel objet Form à partir d’un objet JS de descripteur de formulaire. Ajoute une fonction de rappel qui est appelée une fois que toutes les feuilles de style et les informations de prospect connues ont été récupérées et que l’objet Form a été créé.

formData (objet Descripteur de formulaire) : objet descripteur de formulaire, tel que créé par l’éditeur Forms V2 de Marketo

indéfini

callback (facultatif)(Fonction) - Ce rappel est appelé avec un seul argument, une instance nouvellement créée de l’objet Form.

.getForm(formId)

Obtient un objet Form créé précédemment par identifiant de formulaire

formId (Nombre ou Chaîne) - Identifiant du formulaire valide.

Objet de formulaire

.allForms()

Récupère un tableau de tous les objets de formulaire qui ont été précédemment construits sur la page.

s/o

Tableau d’objets de formulaire

.getPageFields()

Obtient un objet JS contenant des données de l’URL et du référent qui peuvent être intéressantes à des fins de suivi.

s/o

Objet

.whenReady(callback)

Ajoute un rappel qui est appelé exactement une fois pour chaque formulaire de la page qui devient « ready ». La préparation signifie que le formulaire existe, qu’il a été initialement rendu et que ses rappels initiaux ont été appelés. Si un formulaire est déjà prêt au moment de l’appel de cette fonction, le rappel transmis est appelé immédiatement.

callback(Function) - Le rappel est transmis à un seul argument, un objet de formulaire.

MktoForms2, objet

.onFormRender(callback)

Ajoute un rappel qui est appelé à chaque fois qu’un formulaire est rendu sur la page. Les Forms sont rendues lors de leur création initiale, puis à chaque fois que les règles de visibilité modifient la structure du formulaire.

callback (fonction) - Un seul argument est transmis au rappel : il s’agit de l’objet du formulaire dont le rendu a été effectué.

MktoForms2, objet

.whenRendered(callback)

Comme onFormRender, cela ajoute un rappel qui est appelé à chaque fois qu’un formulaire est rendu. En outre, cela appelle également immédiatement le rappel pour tous les formulaires qui ont déjà été rendus.

callback(Function) - Un seul argument est transmis au rappel, l’objet de formulaire du formulaire rendu.

.render(formElement)

Rend un objet de formulaire, renvoyant un objet jQuery enveloppant un élément de formulaire contenant le formulaire. Si un formElement est transmis, il l’utilise comme élément de formulaire, sinon il en crée un nouveau.

formElement (facultatif) - Élément de formulaire enveloppé d’un objet jQuery dans lequel effectuer le rendu.

Un élément de formulaire enveloppé d’un objet jQuery contenant le formulaire rendu.

.getId()

Obtient l'identifiant du formulaire.

s/o

Nombre - Identifiant de l’objet de formulaire que ce formulaire représente

.getFormElement()

Obtient l'élément jQuery wrapped form d'un formulaire rendu.

s/o

Un élément de formulaire enveloppé d’un objet jQuery ou la valeur null si le formulaire n’a pas encore été rendu avec la méthode render().

.validate()

Force la validation du formulaire, en mettant en surbrillance les erreurs éventuelles et en renvoyant le résultat. N’envoie pas le formulaire.

s/o

Booléen - Renvoie true si tous les validateurs du formulaire ont été transmis, false dans le cas contraire.

.onValidate(callback)

Ajoute un rappel de validation qui sera appelé chaque fois que la validation sera déclenchée.

callback(Function) - Rappel qui sera déclenché chaque fois que la validation aura lieu. Un paramètre est transmis au rappel, une valeur booléenne indiquant si la validation a réussi.

Objet de formulaire - Objet de formulaire identique à celui sur lequel la méthode a été appelée, à des fins de chaîne.

.submit()

Déclenche l’événement d’envoi du formulaire. Cela lancera le flux d’envoi du formulaire, exécutera la validation, déclenchera tous les événements onSubmit, enverra le formulaire et déclenchera tous les événements onSuccess si l’envoi du formulaire a réussi.

s/o

Objet de formulaire - Objet de formulaire identique à celui sur lequel la méthode a été appelée, à des fins de chaîne.

.onSubmit(callback)

Ajoute un rappel qui sera appelé lors de l’envoi du formulaire. Cette erreur se déclenche lorsque l’envoi commence, avant que la réussite ou l’échec de la requête ne soit connu.

callback : fonction qui sera appelée lors de l’envoi du formulaire. Un seul argument, cet objet Form, sera transmis à ce rappel.

Objet de formulaire - Objet de formulaire identique à celui sur lequel la méthode a été appelée, à des fins de chaîne.

.onSuccess(callback)

Ajoute un rappel qui sera appelé lorsque le formulaire a bien été envoyé mais avant que le prospect ne soit transféré vers la page de relance. Peut être utilisé pour empêcher le transfert du prospect vers la page de suivi après un envoi réussi.

callback : fonction qui sera appelée une fois le formulaire envoyé avec succès. Deux arguments seront transmis à ce rappel. Un objet JS contenant les valeurs envoyées et une URL de chaîne de la page de relance vers laquelle l’utilisateur sera transféré, ou une chaîne nulle ou vide s’il n’existe aucune page de relance configurée. Comportement spécial : si ce rappel renvoie « false » (mesuré à l’aide de ===), le visiteur ne sera PAS redirigé vers la page de suivi et la page ne sera PAS rechargée. Cela permet à l’implémentateur d’effectuer un traitement supplémentaire sur l’URL de relance ou d’agir sur la page à l’aide de JavaScript au lieu de quitter la page.

Objet de formulaire - Objet de formulaire identique à celui sur lequel la méthode a été appelée, à des fins de chaîne.

.submittable(canSubmit) également disponible sous : .submitable(canSubmit)

Obtient ou définit si le formulaire peut être envoyé. Si elle est appelée sans argument, elle obtient la valeur, si elle est appelée avec un argument, elle définit la valeur. Cela peut être utilisé pour empêcher l’envoi d’un formulaire tandis que d’autres critères en dehors du formulaire normal doivent être remplis.

canSubmit (facultatif)(booléen) : définit le formulaire comme pouvant être envoyé ou non envoyé.

Booléen ou objet de formulaire : si cette propriété est appelée sans argument, renvoie une valeur booléenne indiquant si le formulaire peut être envoyé. Si elle est appelée avec un seul argument, renvoie cet objet Form à des fins de chaîne.

.allFieldsFilled()

Renvoie « true » si des valeurs non vides sont définies pour tous les champs du formulaire.

s/o

Booléen : valeur true si tous les champs ont des valeurs non vides, vides, non définies ou nulles, false dans le cas contraire.

.setValues(vals)

Définit des valeurs sur un ou plusieurs champs du formulaire.

vals - Objet JS. Pour chaque paire clé/valeur dans l’objet, le champ de formulaire nommé clé est défini sur valeur.

indéfini

.getValues()

Obtient toutes les valeurs de tous les champs du formulaire.

s/o

Objet - Objet JS contenant des paires clé/valeur représentant les noms et les valeurs des champs du formulaire.

.addHiddenFields(values)

Ajoute les champs de type d’entrée=masqués au formulaire.

values - Un objet JS contenant des paires clé/valeur représentant les noms et les valeurs des champs masqués à ajouter au formulaire.

indéfini

.vals(values)

jQuery style .vals() setter/getter. Si elle est appelée sans argument, équivaut à appeler getValues(). Si elle est appelée avec un argument, équivaut à appeler setValues()

values (facultatif) - Objet

indéfini

.showErrorMessage(msg, element)

Affiche un message d’erreur, pointant vers l’élément .

msg (String of HTML) : chaîne contenant le texte de l’erreur à afficher.

Objet de formulaire - Cet objet de formulaire, à chaîner.

elem (facultatif)(objet jQuery) : élément vers lequel l’erreur doit pointer. Si cette option n’est pas définie, le bouton d’envoi du formulaire est utilisé.