Desenvolvendo uma nova Ação Kaizala

  • Artigo

Um pacote kaizala Action é um arquivo zip que contém todos os arquivos de manifesto e recursos requeriados na raiz.

Para começar, crie uma nova pasta no computador para torná-la seu diretório de trabalho.

Você precisará de um editor de código para trabalhar com diferentes tipos de recursos web & arquivos de manifesto.

Recomendamos o editor de Visual Studio Code. Você pode baixá-lo daqui

Definindo o Modelo de Aplicativo

Atualmente, as Ações kaizala dão suporte a modelos de dados baseados em formulários que podem ser usados para criar, coletar e agregar dados usando os Serviços de Agregação kaizala.

Portanto, primeiro você precisará definir as 'perguntas' que precisa incluir para criar um objeto de formulário.

Consulte o esquema JSON do modelo de aplicativo para criar o modelo de aplicativo da ação.

Definir o Modo de Exibição de Criação

Quando uma nova instância da Ação Kaizala é invocada da Paleta de Ações do aplicativo, o recurso HTML marcado como CreationView é renderizado. O objetivo dessa exibição de criação é criar uma nova instância do objeto Form, conforme definido no modelo de aplicativo.

Para interagir com os Serviços de Agregação kaizala e criar a nova instância de formulário, você pode consultar as APIs no SDK do KASClient JS. Você precisará baixar o Arquivo JS KASClient e incluí-lo em seu pacote.

Crie um novo arquivo HTML que represente essa exibição de criação. No arquivo javascript correspondente, invoque o SDK do KASClient JS e crie um objeto de formulário.

Criar o arquivo Manifesto do Pacote

Agora que você tem uma aparência do que deseja alcançar e criou uma exibição com êxito, você pode começar a criar o arquivo de manifesto do pacote.

O arquivo de manifesto do Pacote Kaizala fornece informações essenciais para a plataforma Kaizala para que ele reconheça e execute sua ação kaizala personalizada.

Consulte o esquema JSON do manifesto do pacote para criar o manifesto do pacote da Ação.

Neste ponto, você também deve incluir um arquivo de ícone para sua ação personalizada no pacote.

Consulte o arquivo HTML de exibição de criação no manifesto do pacote e mapeie-o para o objeto de parâmetro relevante.

Configurar o cartão que aparece na tela de conversa

Quando uma nova instância de uma Ação Kaizala é criada e postada em uma conversa, um Cartão de Ação é exibido na tela para outros usuários na conversa exibirem e enviarem suas respostas.

Para personalizar o Modo de Exibição do Cartão de Chat, consulte Personalizando ChatCardView

Definir as exibições de resumo de & de resposta

Quando os usuários tentam exibir detalhes e responder a uma instância da Ação Kaizala postada em uma conversa, eles podem ver dois tipos de exibições.

  • Exibição de resposta quando eles tocam no botão de chamada para ação primária e querem postar um reponse
  • Exibição de resumo quando eles tocam no cabeçalho cartão e gostariam de exibir a exibição agregada de todos os reesponses postados

Crie um ou mais arquivos HTML conforme necessário para que você defina sua Ação e mapeie-os para os parâmetros relevent no arquivo de manifesto do pacote.

Para interagir com os Serviços de Agregação kaizala e o cliente nativo do Kaizala para recuperar informações, enviar uma resposta ou obter respostas agregadas, você pode se referir às APIs no SDK do KASClient JS.

Criar o arquivo ZIP

Selecione todos os arquivos em seu diretório de trabalho e crie um novo arquivo zip para seu pacote. Verifique se todos os arquivos estão presentes no diretório raiz do pacote.