Referencia de API de Forms

Existen dos objetos principales con los que interactuará mediante la API de Forms 2.0. El MktoForms2 y el objeto Form objeto. El MktoForms2 es el espacio de nombres visible públicamente de nivel superior para la funcionalidad de Forms2 y contiene funciones para crear, cargar y recuperar objetos Form.

Métodos MktoForms2

Método
Descripción
Parámetros
Devuelve
.loadForm(baseUrl, munchkinId, formId, callback)
Carga un descriptor de formulario desde los servidores de Marketo y crea un nuevo objeto de formulario.
baseUrl(String): URL de la instancia del servidor de Marketo para su suscripción
no definido
munchkinId (String): ID de Munchkin de la suscripción
formId (Cadena o Número): el ID de versión del formulario (Vid) que se va a cargar.
callback (opcional) (función): una función de llamada de retorno para pasar el objeto de formulario construido a una vez que se ha cargado e inicializado.
.lightbox(formulario, opciones)
Procesa un cuadro de diálogo modal de estilo light box con el objeto Form en él.
form (objeto Form): instancia de un objeto Form que desea que se procese en un lightbox.
Objeto lightbox con métodos .show() y .hide().
opts (optional)(Object): un objeto de opciones que se pasa al objeto lightbox
onSuccess(Función): una llamada de retorno que se activa cuando se envía el formulario.
closeBtn(Boolean) default true: controla si se muestra un botón de cierre (X) en el cuadro de diálogo de LightBox.
.newForm(formData, callback)
Crea un nuevo objeto Form a partir de un objeto JS de descriptor de formulario. Agrega una función de llamada de retorno que se llama una vez que se han recuperado todas las hojas de estilo e información de posibles clientes conocida y se ha creado el objeto Form.
formData (objeto descriptor de formulario): un objeto descriptor de formulario, creado por el Editor de Forms V2 de Marketo
no definido
callback (opcional)(Función): a esta llamada de retorno se le llama con un solo argumento, una instancia recién creada del objeto Form.
.getForm(formId)
Obtiene un objeto Form creado anteriormente por el identificador de formulario
formId (número o cadena): Identificador de Vid de formulario.
Objeto Form
.allForms()
Obtiene una matriz de todos los objetos de formulario que se han construido anteriormente en la página.
n/a
Matriz del objeto de formulario
.getPageFields()
Obtiene un objeto JS que contiene datos de la dirección URL y del referente que pueden resultar interesantes para el seguimiento.
n/a
Objeto
.whenReady(callback)
Agrega una llamada de retorno que se llama exactamente una vez para cada formulario de la página que esté "listo". La preparación significa que el formulario existe, se ha procesado inicialmente y se han llamado sus llamadas de retorno iniciales. Si ya hay un formulario listo en el momento de llamar a esta función, la llamada de retorno pasada se llama inmediatamente.
callback(Función): la llamada de retorno se pasa a un solo argumento, un objeto de formulario.
Objeto MktoForms2
.onFormRender(callback)
Agrega una llamada de retorno que se llama cada vez que se procesa cualquier formulario de la página. Forms se procesa cuando se crea inicialmente y, a continuación, cada vez que las reglas de visibilidad modifican la estructura del formulario.
callback (Función): la llamada de retorno se pasa a un solo argumento, el objeto de formulario del formulario que se procesó.
Objeto MktoForms2
.whenRendered(callback)
Al igual que onFormRender, agrega una llamada de retorno que se llama cada vez que se procesa un formulario. Además, esto también llama inmediatamente a la devolución de llamada para todos los formularios que ya se han procesado.
callback(Función): la llamada de retorno se pasa a un solo argumento, el objeto de formulario del formulario procesado.

Métodos de formulario

Método
Descripción
Parámetros
Devuelve
.render(formElem)
Representa un objeto de formulario, devolviendo un objeto jQuery que ajusta un elemento de formulario que contiene el formulario. Si se pasa un formElement, se utilizará como el elemento de formulario; de lo contrario, se creará uno nuevo.
formElement (opcional): un elemento de formulario ajustado en un objeto jQuery en el que se procesará.
Elemento de formulario ajustado a objetos jQuery que contiene el formulario procesado.
.getId()
Obtiene el id. del formulario.
n/a
Número: el ID del objeto de formulario que representa este formulario.
.getFormElement()
Obtiene el elemento de formulario jQuery ajustado de un formulario procesado.
n/a
Un elemento de formulario jQuery ajustado en objeto o nulo si el formulario aún no se ha representado con el método render().
.validate()
Fuerza la validación del formulario, resaltando los errores que puedan existir y devolviendo el resultado. No envía el formulario.
n/a
Booleano: devuelve el valor "True" si se han superado todos los validadores del formulario y el valor "False" en caso contrario.
.onValidate(callback)
Agrega una llamada de retorno de validación a la que se llamará cada vez que se active la validación.
callback(Función): Se activará una llamada de retorno cada vez que se produzca la validación. La llamada de retorno se pasará a un parámetro, un booleano que indica si la validación se ha realizado correctamente.
Objeto de formulario: el mismo objeto de formulario en el que se llamó al método con fines de encadenamiento.
.submit()
Déclencheur el evento de envío del formulario. Esto iniciará el flujo de envío desde, realizando la validación, activando cualquier evento de envío, enviando el formulario y activando cualquier evento de éxito si el envío del formulario se ha realizado correctamente.
n/a
Objeto de formulario: el mismo objeto de formulario en el que se llamó al método con fines de encadenamiento.
.onSubmit(callback)
Agrega una llamada de retorno que se llamará cuando se envíe el formulario. Esto se activa cuando comienza el envío, antes de que se conozca el éxito/error de la solicitud.
callback: una función a la que se llamará cuando se envíe el formulario. Esta llamada de retorno pasará un argumento, este objeto Form.
Objeto de formulario: el mismo objeto de formulario en el que se llamó al método con fines de encadenamiento.
.onSuccess(callback)
Agrega una llamada de retorno que se llamará cuando el formulario se haya enviado correctamente pero antes de que el posible cliente se reenvíe a la página de seguimiento. Se puede utilizar para evitar que el posible cliente se reenvíe a la página de seguimiento después del envío correcto.
callback: una función a la que se llamará cuando el formulario se haya enviado correctamente. Esta llamada de retorno pasará con dos argumentos. Un objeto JS que contiene los valores enviados y una dirección URL de cadena de la página de seguimiento a la que se reenviará al usuario, o una cadena nula o vacía si no hay ninguna página de seguimiento configurada. Comportamiento especial: Si esta llamada de retorno devuelve "false" (medido con ===), el visitante NO se reenvía a la página de seguimiento y la página NO se vuelve a cargar. Esto permite al implementador realizar un procesamiento adicional de la URL de seguimiento o realizar acciones en la página mediante JavaScript en lugar de abandonar la página.
Objeto de formulario: el mismo objeto de formulario en el que se llamó al método con fines de encadenamiento.
.submittable(canSubmit) también disponible como: .submitable(canSubmit)
Obtiene o establece si el formulario se puede enviar. Si se le llama sin argumentos, obtiene el valor; si se le llama con un argumento, establece el valor. Esto se puede utilizar para evitar que se envíe un formulario, mientras que se deben cumplir otros criterios fuera del formulario normal.
canSubmit (opcional)(booleano): establece el formulario como enviable o no enviable.
Booleano u Objeto de formulario: si se llama sin argumentos, devuelve un booleano que indica si el formulario es enviable. Si se llama con un argumento, devuelve este objeto de formulario con fines de encadenamiento.
.allFieldsFilled()
Devuelve verdadero si todos los campos del formulario tienen valores establecidos que no estén en blanco.
n/a
Boolean: True si todos los campos tienen valores no vacíos/vacíos/no establecidos/nulos; false en caso contrario.
.setValues(vals)
Establece valores en uno o varios campos del formulario.
vals: un objeto JS. Para cada par clave/valor del objeto, el campo de formulario denominado clave se establecerá en valor.
no definido
.getValues()
Obtiene todos los valores de todos los campos del formulario.
n/a
Objeto: un objeto JS que contiene pares de clave/valor que representan los nombres y valores de los campos del formulario.
.addHiddenFields(values)
Agrega campos input type=hidden al formulario.
values: un objeto JS que contiene pares de clave/valor que representan los nombres y valores de los campos ocultos que se agregan al formulario.
no definido
.vals(valores)
jQuery style .vals() setter/getter. Si se llama a sin argumentos, equivale a llamar a getValues(). Si se llama con un argumento, equivale a llamar a setValues()
values (optional) - Object
no definido
.showErrorMessage(msg, elem)
Muestra un mensaje de error que apunta a elem.
msg (String of HTML): cadena que contiene el texto del error que desea mostrar.
Objeto Form: este objeto Form, para encadenar.
element (opcional)(objeto jQuery): el elemento al que apunta el error. Si no se configura, se utiliza el botón de envío del formulario.
recommendation-more-help
bb269a6d-047a-4bf7-9acd-23ad9a63dc59