Partilhar via


Métodos Microsoft.CIFramework (referência da API JavaScript do Dynamics 365 Channel Integration Framework 1.0)

O Microsoft CIFramework fornece métodos para usar a API JavaScript para gerenciar o painel de comunicação, registros e formulários no aplicativo controlado por modelo do Dynamics 365.

Importante

  • O manipulador de eventos CIFInitDone deve ser invocado antes de chamar as outras APIs.
  • O limite de tempo limite para as APIs é de 10 segundos. Se as APIs não forem executadas em 10 segundos, elas deverão ser executadas novamente com parâmetros ou escopo alterados.

APIs de gerenciamento de painel de comunicação

O painel de comunicação é onde você, como agente, interage com o cliente. Os widgets de parceiros criados usando o Channel Integration Framework 1.0 são carregados neste painel. O widget nesta versão é exibido à direita da tela e suporta os modos Docked e Minimized.

Use as APIs a seguir para gerenciar o estado do painel de comunicação (widget).

Methods Description
setWidth Define a largura do painel para todas as sessões.
getWidth Obtém a largura do painel em pixels.
setMode Define o estado do painel.
getMode Define o estado do painel.

APIs de operações CRUD

Use as APIs a seguir para executar operações CRUD em registros de entidade.

Methods Description
createRecord Cria um registro de entidade.
retrieveRecord Recupera um registro de entidade.
updateRecord Atualiza um registro de entidade.
deleteRecord Exclui um registro de entidade.

Métodos diversos

Methods Description
getEntityMetadata Retorna os metadados da entidade para a entidade especificada.
setClickToAct Define um valor booleano para habilitar ou desabilitar a comunicação de saída (ClickToAct).
getClickToAct Retorna um valor booleano para indicar se a comunicação de saída (ClickToAct) está habilitada ou não.
pesquisaAndOpenRecords O método procura o registro do widget de comunicação durante a comunicação de entrada e abre o registro.
getAmbiente Obtém o aplicativo de Interface Unificada atual e os detalhes da página. Os detalhes incluem ID do aplicativo (appid), pageType(pageType), ID do registro (id), geografia da organização (orgGeo) e tipo de navegação da sessão (navigationType).
Formulário aberto Abre um formulário de entidade ou um formulário de criação rápida.
renderSearchPage Permite pesquisar entre os registos de um determinado tipo de entidade. Essa API abre a página da entidade Interface Unificada com o campo de pesquisa pré-preenchido com a cadeia de caracteres de pesquisa que é passada como parâmetro.
addHandler Adiciona o assinante aos eventos.

Observação

Essa API pode ser usada no widget e na página da Interface Unificada.

removeHandler Remove o assinante dos eventos.

Observação

Essa API pode ser usada no widget e na página da Interface Unificada.

raiseEvento Invoca o assinante associado para o evento.

Observação

Se você criou eventos personalizados usando o método addHandler, poderá gerar esses eventos passando o nome do evento como parâmetro nesse método.

updateContext Esse método permite que você defina o dicionário de automação.

O que há de novo no Dynamics 365 Channel Integration Framework
Requisitos do sistema do Dynamics 365 Channel Integration Framework 1.0