Histórico da Página
Para consultar dados do ambiente da sessão via JavaScipt (client side) é possível utilizar nos eventos a biblioteca WCMAPI. As propriedades disponíveis através da WCMAPI são:
Método | Especificação | |||||
---|---|---|---|---|---|---|
WCMAPI.version | Retorna a versão do fluig. Exemplo: "1.6.2" | |||||
WCMAPI.serverURL ou WCMAPI.getServerURL() | Retorna o endereço principal do servidor do fluig: "http://" ou "https://" seguido do endereço do servidor e a porta (se for diferente de 80). Exemplo: "http://empresa.fluig.com:8080" | |||||
WCMAPI.organizationId ou WCMAPI.getOrganizationId() | Retorna o ID do tenant ao qual o usuário está conectado. Exemplos: "1", "12", "99" | |||||
WCMAPI.tenantCode ou WCMAPI.getTenantCode() | Retorna o código do tenant ao qual o usuário está conectado. Exemplos: "suaempresa", "totvs", "demo" | |||||
WCMAPI.Create | Envia uma requisição ao servidor do fluig. Exemplo:
| |||||
WCMAPI.serverContextURL ou WCMAPI.getServerContextURL() | Retorna a raiz da URL do portal da plataforma. Valor: "/portal" | |||||
WCMAPI.logoff | Encerra a sessão de um usuário na plataforma. Exemplo de utilização na função click de um botão implementado no arquivo JavaScript de um widget:
| |||||
WCMAPI.addListener | Adiciona um evento customizado na widget. Exemplo de implementação:
| |||||
WCMAPI.fireEvent | Dispara um evento customizado pela widget. Exemplo de implementação:
| |||||
WCMAPI.failHandler | Exibe um alerta detalhado sobre o erro de alguma requisição. Exemplo de implementação:
| |||||
WCMAPI.convertFtlAsync | Realiza a renderização de uma widget pelo frontend. Esse método retorna o HTML de uma widget parseado pelo backend e também inclui todos os resources (css e js) dessa widget na página. Observação: O método WCMAPI.convertFtl não deve ser usado pois ele realiza uma chamada síncrona e isso prejudica a experiência do usuário na página. Exemplo de implementação:
| |||||
WCMAPI.generateId() | Retorna um ID único para ser usado no desenvolvimento de uma widget. Exemplo de implementação:
| |||||
WCMAPI.getSourceImage | Retorna a url da imagem ou o base64 dela caso ela possua algum tipo de customização feita pelo dispositivo que criou ela, como rotação feita por um celular. Exemplo de implementação:
| |||||
WCMAPI.isReplicationServerAccessible | Verifica se a replicação de arquivos pelo servidor está disponível e acessível. Exemplo de implementação:
| |||||
WCMAPI.setSessionAttribute | Adiciona algum valor na sessão do usuário (backend). Exemplo de implementação:
| |||||
WCMAPI.getSessionAttribute | Retorna algum valor que foi adicionado na sessão do usuário (backend). Exemplo de implementação:
| |||||
WCMAPI.getProtectedContextPath | Retorna o path protegido (que exige autenticação para acessar) do servidor do Fluig. Exemplo de implementação:
| |||||
WCMAPI.isNull | Retorna um booleano se um valor é nulo ou não. Observação: Recomenda-se usar JavaScript puro para realizar essa verificação. Exemplo de implementação:
|
Inserir introdução sobre o wcmAPI...