Compartilhar via


createTab (Referência da API JavaScript) para Dynamics 365 Channel Integration Framework 2.0

Observação

Use essa API somente quando a sessão focada pertencer ao provedor ou se for a sessão inicial ou padrão.

Cria uma guia em uma sessão focada e retorna o identificador exclusivo da guia criada.

Sintaxe

Microsoft.CIFramework.createTab(input, correlationId).then(successCallback, errorCallback);

Parâmetros

Nome Tipo Required Descrição
entrada String Yes Entrada JSON
sucessoRetorno de chamada Função Não Uma função a ser chamada quando um registro é criado. O identificador exclusivo (ID da guia) da guia criada é retornado na resposta.
erroRetorno de chamada Função Não Uma função a ser chamada quando a operação falhar. Um objeto com as seguintes propriedades será passado:
errorCode: Número. O código do erro.
message: String. Uma mensagem de erro descrevendo o problema.

A estrutura do input parâmetro JSON é a seguinte:

{
    //Unique name of the tab 
    // type = string
    templateName: <unique name of the tab template>;

    //additional context for tab creation and tab slugs
    // type = JSON Object
    templateParameters?:<>
    
    //should this tab be focused after the creation
    // type=boolean
    isFocused?: <true or false>;
}

Valor de retorno

Promise com o valor do ID da guia como String

Example

var tabInput = {
    //Unique Name of the Application Tab Template
    // type = string
    templateName: "msdyn_test_entity",
    templateParameters: {
    entityName: "incident",
    data: "{}",
    },
    isFocused: true
};
Microsoft.CIFramework.createTab(tabInput).then((tabId)=>{
    console.log("created tab with id" + tabId);
}, (error)=>{
    console.log(error);
});