Referência da API do Forms

Há dois objetos principais com os quais você interagirá usando a API do Forms 2.0. Os objetos MktoForms2 e Form. O objeto MktoForms2 é o namespace publicamente visível de nível superior para a funcionalidade Forms2 e contém funções para criar, carregar e buscar objetos Form.

Métodos MktoForms2

Método
Descrição
Parâmetros
Devoluções
.loadForm(baseUrl, munchkinId, formId, retorno de chamada)
Carrega um descritor de formulário dos servidores da Marketo e cria um novo objeto de formulário.
baseUrl(String) - URL para a instância do servidor Marketo da sua assinatura
não definido(a)s
munchkinId (String) - ID do Munchkin da assinatura
formId (String ou Número) - A ID de versão do formulário (Vid) a ser carregada
callback (opcional) (Função) - Uma função callback para passar o objeto Form construído para depois de ter sido carregado e inicializado.
.lightbox(formulário, opções)
Processa uma caixa de diálogo modal de estilo lightbox com o objeto Formulário nela.
formulário (Objeto de formulário) - Uma instância de um objeto de formulário que você deseja renderizar em uma lightbox.
Um objeto lightbox com os métodos .show() e .hide().
opts (opcional)(Objeto) - Um objeto de opções passado para o objeto lightbox
onSuccess(Function) - Um retorno de chamada que é acionado quando o formulário é enviado.
closeBtn(Boolean) default true - Controla se um botão fechar (X) é exibido na caixa de diálogo lightbox.
.newForm(formData, retorno de chamada)
Cria um novo objeto de formulário a partir de um objeto JS do descritor de formulário. Adiciona uma função de retorno de chamada que é chamada depois que todas as folhas de estilos e informações de cliente potencial conhecidas são buscadas e o objeto de formulário é criado.
formData (Objeto Descritor de Formulário) - Um objeto descritor de formulário, conforme criado pelo Editor Forms V2 do Marketo
não definido(a)s
callback (opcional)(Função) - Esse callback é chamado com um único argumento, uma instância recém-criada do objeto Form.
.getForm(formId)
Obtém um objeto de formulário criado anteriormente pelo identificador de formulário
formId (Número ou String) - Identificador de Vid do Formulário.
Objeto de formulário
.allForms()
Busca uma matriz de todos os objetos de formulário que foram construídos anteriormente na página.
n/d
Matriz de objeto de formulário
.getPageFields()
Obtém um objeto JS contendo dados do URL e do referenciador que podem ser interessantes para fins de rastreamento.
n/d
Objeto
.whenReady(retorno de chamada)
Adiciona um retorno de chamada que é chamado exatamente uma vez para cada formulário na página que fica "pronto". Prontidão significa que o formulário existe, foi renderizado inicialmente e teve seus retornos de chamada iniciais chamados. Se já houver um formulário que esteja pronto no momento em que essa função for chamada, o retorno de chamada transmitido será chamado imediatamente.
callback(Função) - O callback recebe um único argumento, um objeto de formulário.
Objeto MktoForms2
.onFormRender(callback)
Adiciona um retorno de chamada que é chamado toda vez que qualquer formulário na página é renderizado. Os Forms são renderizados quando criados inicialmente, em seguida, sempre que as regras de visibilidade alteram a estrutura do formulário.
callback (Função) - O callback recebe um único argumento, o objeto de formulário do formulário que foi renderizado.
Objeto MktoForms2
.whenRendered(retorno de chamada)
Assim como onFormRender, adiciona um retorno de chamada que é chamado sempre que um formulário é renderizado. Além disso, isso também chama o retorno de chamada imediatamente para todos os formulários que já foram renderizados.
callback(Função) - O callback recebe um único argumento, o objeto de formulário do formulário renderizado.

Métodos de formulário

Método
Descrição
Parâmetros
Devoluções
.render(formElem)
Renderiza um objeto de formulário, retornando um objeto jQuery encapsulando um elemento de formulário que contém o formulário. Se for transmitido um formElem, ele usará isso como o elemento de formulário, caso contrário, criará um novo.
formElem (opcional) - um elemento de formulário jQuery encapsulado por objetos no qual será renderizado.
Um elemento de formulário jQuery com quebra de objeto contendo o formulário renderizado.
.getId()
Obtém a ID do formulário.
n/d
Número - A ID do objeto de formulário que este formulário representa
.getFormElem()
Obtém o elemento de formulário encapsulado jQuery de um formulário renderizado.
n/d
Um elemento de formulário jQuery envolvido em objetos ou nulo se o formulário ainda não tiver sido renderizado com o método render().
.validate()
Força a validação do formulário, destacando todos os erros que possam existir e retornando o resultado. Não envia o formulário.
n/d
Booleano - Retorna verdadeiro se todos os validadores no formulário forem transmitidos; caso contrário, retorna falso.
.onValidate(retorno de chamada)
Adiciona um retorno de chamada de validação que será chamado sempre que a validação for acionada.
callback(Função) - Um callback que será acionado sempre que a validação ocorrer. A chamada de retorno receberá um parâmetro, um booleano informando se a validação foi bem-sucedida.
Objeto de formulário - O mesmo objeto de formulário no qual o método foi chamado, para fins de encadeamento.
.submit()
Aciona o evento de envio do formulário. Isso iniciará o fluxo de envio do, executando a validação, acionando qualquer evento onSubmit, enviando o formulário e acionando qualquer evento onSuccess se o envio do formulário tiver sido bem-sucedido.
n/d
Objeto de formulário - O mesmo objeto de formulário no qual o método foi chamado, para fins de encadeamento.
.onSubmit(callback)
Adiciona um retorno de chamada que será chamado quando o formulário for enviado. Isso é acionado quando o envio começa, antes que o sucesso/falha da solicitação seja conhecido.
callback - Uma função que será chamada quando o formulário for enviado. Esse retorno de chamada receberá um argumento, esse objeto Form.
Objeto de formulário - O mesmo objeto de formulário no qual o método foi chamado, para fins de encadeamento.
.onSuccess(callback)
Adiciona um retorno de chamada que será chamado quando o formulário for enviado com êxito, mas antes do cliente em potencial ser encaminhado para a página de acompanhamento. Pode ser usado para impedir que o cliente potencial seja encaminhado para a página de acompanhamento após o envio bem-sucedido.
callback - Uma função que será chamada quando o formulário for enviado com êxito. Essa chamada de retorno receberá dois argumentos. Um objeto JS contendo os valores que foram enviados e um URL de string da página de acompanhamento à qual o usuário será encaminhado, ou uma string nula ou vazia se não houver uma página de acompanhamento configurada. Comportamento especial: se esse retorno de chamada retornar "false" (medido usando ===), o visitante NÃO será encaminhado para a página de acompanhamento e a página NÃO será recarregada. Isso permite que o implementador faça processamento extra no url de acompanhamento ou execute uma ação na página usando o JavaScript em vez de sair da página.
Objeto de formulário - O mesmo objeto de formulário no qual o método foi chamado, para fins de encadeamento.
.submittable(canSubmit) também disponível como: .submitable(canSubmit)
Obtém ou define se o formulário pode ser enviado. Se chamado sem argumentos, ele obtém o valor; se chamado com um argumento, ele define o valor. Isso pode ser usado para impedir que um formulário seja enviado, enquanto outros critérios fora do formulário normal devem ser atendidos.
canSubmit (opcional)(Booleano) - Define o formulário como enviado ou não.
Booleano ou objeto de formulário - Se chamado sem argumentos, retorna um booleano indicando se o formulário é enviado. Se chamado com um argumento, retorna este Objeto de formulário para fins de encadeamento.
.allFieldsFilled()
Retornará true se todos os campos no formulário tiverem valores não vazios definidos.
n/d
Booleano - Verdadeiro se todos os campos tiverem valores não vazios/vazios/não definidos/nulos; caso contrário, falso.
.setValues(vals)
Define valores em um ou mais campos no formulário.
vals - Um Objeto JS. Para cada par de chave/valor no objeto, o campo de formulário chamado chave será definido como valor.
não definido(a)s
.getValues()
Obtém todos os valores de todos os campos do formulário.
n/d
Objeto - Um objeto JS que contém pares de chave/valor representando os nomes e valores dos campos no formulário.
.addHiddenFields(valores)
Adiciona campos de entrada type=hidden ao formulário.
valores - um objeto JS que contém pares de chave/valor representando os nomes e valores dos campos ocultos a serem adicionados ao formulário.
não definido(a)s
.vals(valores)
jQuery style .vals() setter/getter. Se chamado sem argumentos, é equivalente a chamar getValues(). Se chamado com um argumento, é equivalente a chamar setValues()
valores (opcional) - Objeto
não definido(a)s
.showErrorMessage(msg, elem)
Mostra uma mensagem de erro, apontando para elem.
msg (String of HTML) - Uma string que contém o texto do erro que você deseja mostrar.
Objeto de formulário - Este objeto de formulário, para encadeamento.
elem (opcional)(Objeto jQuery)- O elemento para o qual o erro aponta. Se não estiver definido, o botão enviar do formulário será usado.
recommendation-more-help
bb269a6d-047a-4bf7-9acd-23ad9a63dc59