Base de Conhecimento

Este caso de uso descreve um exemplo de implementação do método SDK Action Rule Matched.

O exemplo apresenta um botão no site, que, se clicado, verifica se alguma ActionRule corresponde. Se tiver, um emblema é mostrado.

Etapas

1. Implemente o método SDK em seu site

Primeiro, precisamos implementar o método de API 'Has Action Rule Matched' no site. A documentação para isso pode ser encontrada aqui.

HTML

Aqui nós criamos o emblema, para ser mostrado no site se alguma ActionRule corresponder.

   <span style="background-color:#93beff; display:none" id="actionRuleMatched">ActionRule Matched!</span>

Também precisamos do botão, que chamará um método js para verificar as ActionRules correspondentes.

  <button onclick="checkActionRulesMatched()">Check ActionRules matched</button>

JavaScript

É aqui que implementamos o método SDK.

Como ele retorna uma matriz, sabemos que pelo menos uma regra teve correspondência se o tamanho do resultado for maior que 1. Nesse caso, o emblema é definido como visível.

/** 
* perform check for matched ActionRules, show badge if any have matched, hide if none
*/
function checkActionRulesMatched() {
    // Action Rule Listeners
    CV.api.hasActionRuleMatched(function (result) {
        var notificationElement = document.getElementById("actionRuleMatched");
        if (result.length > 0) {
            notificationElement.style.display = "inline";
        } else {
            notificationElement.style.display = "none";
        }
    });
}string específica. Dessa forma, pode haver várias ActionRules, cada uma das quais pode fazer com que algo diferente aconteça aqui.

Se a verificação de ActionRules correspondentes também deve ser realizada automaticamente depois que a página e o Chatvisor forem carregados, podemos adicionar um Event Listener para executar o método assim que essas condições forem atendidas.

/** 
* perform check for matched ActionRules once page and CV loaded
*/
window.addEventListener('load', function () {
    if (!window.CVLoaded) {
        window.CVLoaded = checkActionRulesMatched;
    } else {
        checkActionRulesMatched();
    }
})

Lembre-se de que, como essa verificação ocorre logo após o carregamento, algumas ActionRules que só corresponderão mais tarde não serão mostradas. Por exemplo, uma ActionRule com a condição 'Usuário na página por X segundos' irá corresponder apenas após X segundos, instante em que esse listener já teria executado o método.

2. Configurando uma ActionRule

Agora, precisamos configurar uma regra para utilizar a API. Informações sobre como configurar ActionRules podem ser encontradas aqui.

Condição

Para este exemplo, a regra apresenta a condição 'Durante o horário de funcionamento', que é correspondida se o horário atual for durante o horário de funcionamento selecionado. Informações sobre esse recurso podem ser encontradas aqui.

Você pode, é claro, selecionar qualquer combinação de condições que se adeque aos seus objetivos.

Ação

Para que esta ActionRule seja adicionada ao conjunto de regras correspondentes, é necessária a ação Javascript Event.

Esta é a forma como a regra é configurada neste exemplo. Se a hora atual for durante o horário de funcionamento, a regra é marcada como correspondida e a partir de agora estará na matriz de resultados ao executar o método SDK.

3. Confira o resultado

O emblema de exemplo, que originalmente tinha o estilo display: none definido, agora é visível ao visitar durante o horário de funcionamento.