Social Webform Javascript API

From Social ID Developers
Revision as of 20:18, 12 April 2013 by Renato.neves (Talk | contribs)
Jump to: navigation, search

Contents

Description

Renderiza o widget do Social Webform em um elemento do DOM.

Usage

 SocialId.Campaign.init(options)

Options

elementId obrigatório id do elemento DOM onde será inserido o widget.
campaign_id obrigatório o identificador numérico do Webform.
app_id opcional (*) o identificador numérico da aplicação de Social Login. (*) Para Webforms integrados ao Social Login esta opção é obrigatória.
mode opcional pode ser "modal" ou "embedded". Especifica o modo de renderização do widget. "Modal" abre um diálogo modal ao se clicar no elementId. "Embedded" renderiza o widget do Social Webform dentro do elementId. Default: "modal".
closeLinkLabel opcional link mostrado no canto superior direito do diálogo que, ao ser clicado, fecha o diálogo. Default: "Close".
style opcional objeto que pode ser usado para customizar o layout dos elementos criados para mostrar o webform em modo diálogo (overlay, content, closeLink e iframe) ou embedded (iframe). Veja a estrutura HTML do widget e o source do Javascript inserido pelo widget para maiores detalhes sobre esta customização.
view opcional uma função (objeto) Javascript responsável por renderizar um Widget do Social Webform. A função default é determinada pela opção mode (modal ou embedded), mas é possível passar uma função customizada aqui. Veja o source do Javascript inserido pelo widget para maiores detalhes sobre esta customização.
doc deprecated uma referência ao documento onde estão os elementos a serem manipulados. Default: window.document.
url deprecated url a ser carregada no iframe inserido pelo Widget. Esta opção está atualmente descontinuada visto que ela é automaticamente determinada a partir das opções campaign_id e app_id.
connection_id deprecated o identificador de uma conexão ativa de um usuário para Webforms integrados ao Social Login. Esta opção não é mais utilizada atualmente, o connection_id é identificado automaticamente a partir da sessão do usuário logado ao Social Login.

Example

Renderiza em "socialid_webform_container" um widget do Social Webform em modo "modal":

 SocialId.Campaign.init({
    campaign_id: 153,
    closeLinkLabel: 'Close',
    elementId: 'socialid_webform_container',
    mode: 'modal'
 });

Renderiza em "socialid_webform_login_container" um widget do Social Webform integrado ao Social Login em modo "embedded", com dimensões customizadas em 400 x 800px:

 SocialId.Campaign.init({
    campaign_id: 117,
    app_id: 54,
    elementId: 'socialid_webform_login_container',
    mode: 'embedded',
    style: {
       iframe: {
          width: '400px',
          height: '800px'
       }
    }
 });

Veja exemplos de webforms em: https://sid-examples.herokuapp.com/campaigns/

Javascript Source

O código fonte desta API está disponível nas urls:

  https://app.socialidnow.com/assets/marketing/registration_widget.js
  https://app.socialidnow.com/javascripts/marketing/registration_widget.js
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox