Référence de l’API Forms

.loadForm(baseUrl, munchkinId, formId, callback)

Charge un descripteur de formulaire à partir des serveurs Marketo et crée un objet de formulaire.

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

indéfini

munchkinId (chaîne) - Munchkin ID 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)

Génère une boîte de dialogue modale de style Lightbox avec l’objet de formulaire qu’elle contient.

form (objet de formulaire) : instance d’un objet de formulaire que vous souhaitez rendre dans un cadre lumineux.

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

opts (facultatif) (objet) - Objet d’options transmis à l’objet Lightbox.

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

closeBtn(Boolean) default true : contrôle si un bouton de fermeture (X) s’affiche dans la boîte de dialogue Lightbox.

.newForm(formData, callback)

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

formData (objet de descripteur de formulaire) - Un objet descripteur de formulaire, tel que créé par Marketo Forms V2 Editor

indéfini

callback (facultatif)(fonction) : ce rappel est appelé avec un seul argument, une instance nouvellement créée de l’objet de formulaire.

.getForm(formId)

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

formId (nombre ou chaîne) - Identifiant de l’identifiant de l’identifiant de formulaire.

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’objet 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 appelé une seule fois pour chaque formulaire de la page qui devient "prêt". L’état de préparation signifie que le formulaire existe, a été initialement rendu et que ses premiers rappels ont été appelés. S’il existe déjà un formulaire prêt au moment de l’appel de cette fonction, le rappel transmis est appelé immédiatement.

callback(Fonction) : le rappel est transmis par un seul argument, un objet de formulaire.

Objet MktoForms2

.onFormRender(callback)

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

callback (fonction) : le rappel est transmis par un seul argument, l’objet de formulaire du formulaire rendu.

Objet MktoForms2

.whenRendered(callback)

Comme onFormRender, un rappel est appelé chaque fois qu’un formulaire est généré. En outre, cela appelle également le rappel immédiatement pour tous les formulaires déjà rendus.

callback(Fonction) : le rappel est transmis par un seul argument, l’objet de formulaire du formulaire rendu.

.render(formElem)

Génère un objet de formulaire, renvoyant un objet jQuery encapsulant un élément de formulaire contenant le formulaire. S’il transmet un élément formElem, il l’utilise comme élément de formulaire, sinon il en crée un nouveau.

formElem (facultatif) : élément de formulaire encapsulé d’objet jQuery dans lequel effectuer le rendu.

Elément de formulaire encapsulé d’objet jQuery contenant le formulaire rendu.

.getId()

Obtient l’identifiant du formulaire.

s/o

Nombre : identifiant de l’objet de formulaire représenté par ce formulaire.

.getFormElem()

Obtient l’élément de formulaire jQuery encapsulé d’un formulaire rendu.

s/o

Elément de formulaire encapsulé d’objet jQuery ou null si le formulaire n’a pas encore été rendu avec la méthode render() .

.validate()

Force le formulaire à valider, surligne les erreurs qui peuvent se produire et renvoie le résultat. N’envoie pas le formulaire.

s/o

Booléen : renvoie true si tous les validateurs du formulaire sont transmis, false dans le cas contraire.

.onValidate(callback)

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

callback(Fonction) : rappel qui sera déclenché chaque fois que la validation se produit. Le rappel est transmis par un paramètre, une valeur booléenne indiquant si la validation a réussi.

Objet de formulaire : objet de formulaire 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 à partir de l’envoi, en effectuant la validation, en déclenchant tout événement onSubmit, en envoyant le formulaire et en déclenchant tout événement onSuccess si l’envoi du formulaire a réussi.

s/o

Objet de formulaire : objet de formulaire 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. Cela est déclenché lorsque l’envoi commence, avant que la réussite/l’échec de la requête ne soit connu.

callback : fonction qui sera appelée lors de l’envoi du formulaire. Ce rappel sera transmis par un argument, cet objet de formulaire.

Objet de formulaire : objet de formulaire 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 été envoyé avec succès, mais avant que la piste ne soit transférée vers la page de suivi. Peut être utilisé pour empêcher le transfert de la piste vers la page de suivi après un envoi réussi.

callback : fonction qui sera appelée lorsque le formulaire a été envoyé avec succès. Ce rappel sera transmis par deux arguments. Objet JS contenant les valeurs qui ont été envoyées et une URL de chaîne de la page de suivi vers laquelle l’utilisateur sera transféré, ou chaîne nulle ou vide si aucune page de relance n’est configurée. Comportement spécial : si ce rappel renvoie "false" (mesuré à l’aide de ===), le visiteur NE sera PAS transféré 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 suivi ou d’effectuer une action sur la page à l’aide de JavaScript au lieu de quitter la page.

Objet de formulaire : objet de formulaire 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é. Appelé sans argument, il obtient la valeur, si appelé avec un argument, il définit la valeur. Elle peut être utilisée pour empêcher l’envoi d’un formulaire alors que d’autres critères en dehors du formulaire normal doivent être remplis.

canSubmit (facultatif)(booléen) : définit le formulaire à soumettre ou à ne pas soumettre.

Booléen ou objet de formulaire : s’il est appelé sans argument, renvoie une valeur booléenne indiquant si le formulaire est soumis. S’il est appelé avec un argument, renvoie cet objet de formulaire à des fins de chaîne.

.allFieldsFill()

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

s/o

Booléen : vrai si tous les champs ont des valeurs non vides/vides/non définies/nulles, faux 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 de 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 des champs input type=hidden au formulaire.

values : 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. S’il est appelé sans argument, il équivaut à appeler getValues(). S’il est appelé avec un argument, il équivaut à appeler setValues()

values (facultatif) - Object

indéfini

.showErrorMessage(msg, elem)

Affiche un message d’erreur, pointant vers elem.

msg (chaîne de HTML) - Chaîne contenant le texte de l’erreur que vous souhaitez afficher.

Objet de formulaire : objet de formulaire, à des fins de chaîne.

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