Compartilhar 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 baseado em 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 do 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 Encaixado e Minimizado.

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.
Modo de conjunto Define o estado do painel.
Modo de obtenção 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
criar registro Cria um registro de entidade.
recuperar Registro Recupera um registro de entidade.
updateRecord Atualiza um registro de entidade.
Registro de exclusão Exclui um registro de entidade.

Métodos diversos

Methods Description
getEntityMetadata Retorna os metadados da entidade especificada.
setClickToAct Define um valor booliano para habilitar ou desabilitar a comunicação de saída (ClickToAct).
getClickToAct Retorna um valor booliano para indicar se a comunicação de saída (ClickToAct) está habilitada ou não.
searchAndOpenRecords O método procura o registro do widget de comunicação durante a comunicação de entrada e abre o registro.
getEnvironment Obtém o aplicativo atual da Interface Unificada 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).
openForm Abre um formulário de entidade ou um formulário de criação rápida.
renderSearchPage Permite pesquisar entre os registros de um determinado tipo de entidade. Essa API abre a página de entidade da Interface Unificada com o campo de pesquisa pré-preenchido com a cadeia de caracteres de pesquisa que é passada como um 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.

raiseEvent 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 Este método permite que você defina o dicionário de automação.

Novidades na Estrutura de Integração de Canais do Dynamics 365
Requisitos do sistema do Dynamics 365 Channel Integration Framework 1.0