Compartilhar via


Referência da API JavaScript do gerenciador de perfis de aplicativo

A Referência da API JavaScript do gerenciador de perfis de aplicativo inclui métodos e propriedades para gerenciar guias e sessões no espaço de trabalho do Copilot Service.

Pré-requisito

Você deve ter direitos de acesso de usuário do Perfil do Aplicativo ou do usuário das Ferramentas de produtividade para usar as APIs do gerenciador de perfis do aplicativo. Mais informações: Direitos de acesso

Gerenciamento de sessão

Os métodos e propriedades a seguir permitem que você gerencie sessões no espaço de trabalho do Copilot Service.

Método Description
getFocusedSession Retorna o objeto de sessão da sessão que está em foco.
getAllSessions Retorna o identificador exclusivo de todas as sessões.
getSession Retorna o objeto de sessão para a ID de sessão especificada.
createSession Cria uma sessão com base em um modelo de sessão e retorna o identificador exclusivo da sessão.
canCreateSession Retorna um valor booleano indicando se uma nova sessão pode ser criada.
fechar Fecha uma sessão.
foco Define o foco em uma sessão.
foco de solicitação Mostra um indicador de notificação em uma determinada sessão se a sessão não estiver em foco.
Propriedade Description
ID da sessão O ID de uma determinada sessão.
éPadrão Valor booleano que indica se uma sessão é a sessão inicial.
podeFechar Valor booleano que indica se uma sessão pode ser fechada.
title O rótulo de texto de uma sessão.

Gerenciamento de guias

Os métodos e propriedades a seguir permitem que você gerencie guias no espaço de trabalho do Copilot Service.

Método Description
Guia Focada Retorna o objeto tab da guia que está em foco.
getAllTabs Retorna o identificador exclusivo de todas as guias de uma sessão.
getTab Retorna o objeto de guia da ID de guia especificada.
createTab Cria uma guia em uma sessão focada e retorna o identificador exclusivo da guia.
canCreateTab Retorna um valor booleano que indica se uma nova guia pode ser criada para uma sessão.
fecharAba Fecha o objeto de guia para uma ID de guia.
guia de foco Define o foco no objeto de guia para uma ID de guia.
guia de atualização Atualiza o objeto de guia para uma ID de guia.
Propriedade Description
Identificação da guia A ID de uma guia.
podeFechar Valor booleano que indica se uma guia pode ser fechada.
title O rótulo de texto de uma guia.

Gerenciamento de contexto

O método a seguir permite que você gerencie o contexto da sessão no espaço de trabalho do Copilot Service.

Método Description
updateContext Define o dicionário de automação e permite que os provedores adicionem, modifiquem e removam valores de slugs; Os valores atualizados ficam disponíveis para chamar macros no futuro.

Eventos do lado do cliente

Event Description
ON_SESSION_SWITCH Invocado quando a sessão é alternada.
ON_SESSION_CLOSED Invocado quando uma sessão é fechada.