Aplicativos JS para Crowdin

O aplicativo para Crowdin JS é uma biblioteca construída para facilitar a interação com o Crowdin Enterprise. Como a integração usa iframes, existem certas limitações na interação entre as janelas: os ambientes são encapsulados e não têm acesso ao conteúdo da página, código, estilos e qualquer outra informação relacionada à página.

A biblioteca JS do aplicativo para Crowdin é baseada na tecnologia de mensagens entre janelas e usa postMessage() para interagir entre várias janelas.

Começando

Para usar esta biblioteca, conecte-a na página do módulo inserindo o seguinte código no cabeçalho da página:

<script src="https://cdn.crowdin.com/apps/dist/iframe.js"></script>

Depois de adicionar o código mencionado acima, você poderá usar a variável global AP.

Nota! Não baixe o arquivo iframe.jse exibi-lo diretamente do seu servidor de aplicativos. O arquivo iframe.js deve ser servido por Crowdin Enterprise para estabelecer a ponte de mensagens entre domínios. O arquivo iframe.js destina-se apenas ao uso em um iframe dentro do Crowdin Enterprise e não funciona para páginas da web autônomas.

Ações globais

Ações globais são as ações que estão disponíveis em todas as páginas do módulo.

AP.getContext(callback)

O método recupera as informações de contexto sobre a página atual e as coloca no retorno de chamada. Por exemplo, o ID do projeto onde o módulo é aberto ou a localidade usada na página.

Exemplo:

  AP.getContext(function(contextData) {
    console.log("Objeto: contexto", contextData);
  });

Propriedades:

callback

Tipo: function

Descrição: O retorno de chamada que lida com o objeto de resposta.

AP.getJwtToken(callback)

O método recupera uma string de token JWT. Usado para obter um token atual. Se o token anterior tiver um período de validade de menos de um minuto, o método irá gerar e retornar um novo token.

Exemplo:

  AP.getJwtToken(function(jwtToken) {
    console.log("Texto: token JWT", jwtToken);
  });

Propriedades:

callback

Tipo: function

Descrição: O retorno de chamada que lida com o texto de resposta.

Ações do módulo de editor

As ações do módulo Editor fornecem a possibilidade de obter informações do interface de usuário do editor. Essas ações estão disponíveis apenas em páginas carregadas em um iframe no módulo Painéis do editor.

AP.editor.getString(callback)

O método recupera informações sobre o texto atualmente selecionado no editor.

Exemplo:

  AP.editor.getString(function(stringData) {
    console.log("Objeto: fonte de texto", stringData);
  });

Propriedades:

callback

Tipo: function

Descrição: O retorno de chamada que lida com o objeto de resposta.

AP.editor.getTranslations(callback)

O método recupera uma lista de traduções sugeridas para o texto atualmente selecionado no editor. Além disso, a resposta contém informações sobre o autor da tradução, o número de votos e a aprovação da etapa do fluxo de trabalho atual.

Exemplo:

  AP.editor.getTranslations(function(translationsData) {
    console.log("Array:objetos de tradução", translationsData);
  });

Propriedades:

callback

Tipo: function

Descrição: O retorno de chamada que lida com o texto de array.

AP.editor.getTopTranslation(callback)

O método recupera uma tradução principal (a tradução com a maior prioridade) para a string fonte atualmente selecionada no Editor.

Exemplo:

  AP.editor.getTopTranslation(function(topTranslationData) {
    console.log("Objeto: tradução superior", topTranslationData);
  });

Propriedades:

callback

Tipo: function

Descrição: O retorno de chamada que lida com o objeto de resposta.

Evento do módulo de editor

As ações do módulo de evento fornecem a possibilidade de trabalhar com eventos, permitem que o aplicativo Crowdin responda a eventos que acontecem no interface de usuário do Crowdin Enterprise e acione seus próprios eventos.

AP.events.once(event, callback)

O método assina um ouvinte único para detectar eventos com um nome especificado. O listener é cancelado assim que o primeiro evento é processado.

Exemplo:

  AP.events.once("event", function(eventData) {
    console.log("Dados do evento", eventData);
  });

Propriedades:

event

Tipo: string

Descrição: O nome do evento ao qual o retorno de chamada da função deve reagir.

callback

Tipo: function

Descrição: O retorno de chamada que trata do evento. Dependendo do tipo do evento, pode haver um ou alguns argumentos no retorno de chamada.

AP.events.on(event, callback)

O método inscreve um ouvinte para todos os eventos com um nome especificado.

Exemplo:

  AP.events.on("event", function(eventData) {
    console.log("Dados do evento", eventData);
  });

Propriedades:

event

Tipo: string

Descrição: O nome do evento ao qual o retorno de chamada da função deve reagir.

callback

Tipo: function

Descrição: O retorno de chamada que trata do evento. Dependendo do tipo do evento, pode haver um ou alguns argumentos no retorno de chamada.

AP.events.off(event, callback)

O método cancela a assinatura de um ouvinte para um evento com um nome especificado.

Exemplo:

  function callback(eventData) {
    console.log("Dados do evento", eventData);
  };

  AP.events.on("event", callback);
  AP.events.off("event", callback);

Propriedades:

event

Tipo: string

Descrição: O nome do evento do qual o retorno de chamada da função deve ser cancelado.

callback

Tipo: function

Descrição: O retorno de chamada que foi inscrito anteriormente no evento.

AP.events.ofAll(event)

O método cancela a inscrição de todos os ouvintes inscritos anteriormente no evento especificado.

Exemplo:

  AP.events.offAll("event");
event

Tipo: string

Descrição: O nome do evento do qual todos os ouvintes devem ser cancelados.

AP.events.onAny(callback)

O método se inscreve em todos os eventos do interface de usuário do Crowdin Enterprise.

Exemplo:

  AP.events.onAny(function(event, data) {
    console.log("Texto do nome do evento", event);
    console.log("Dados do evento", data);
  });

Propriedades:

callback

Tipo: function

Descrição: O retorno de chamada que recebe o nome do evento e todos os dados transferidos para o evento.

AP.events.offAny(callback)

O método cancela a inscrição de um ouvinte em todos os eventos.

Exemplo:

  function callback(event, data) {
    console.log("Texto do nome do evento", event);
    console.log("Dados do evento", data);
  };

  AP.events.onAny(callback);
  AP.events.offAny(callback);

Propriedades:

callback

Tipo: function

Descrição: O retorno de chamada que foi inscrito em todos os eventos.

Este artigo foi útil?