SpContextManager - Cliente

Cria dados de um Portal de serviços widget disponível para outras aplicações e serviços em um Portal de serviços página. Por exemplo, passe dados do widget para Bate-papo do agente quando ele abre em um Portal de serviços página.

. SpContextManager A API é um serviço AngularJS que você pode usar no Portal de serviços scripts de cliente de widget.

As chaves passadas para esta API são exclusivas por página. Por exemplo, se o "bate-papo do agente" a chave já foi inicializada por outro widget na página por meio de AddContext() , você deve usar UpdateContextForKey() método para atualizar os dados da chave. As chaves disponíveis incluem: Agent-chat: Envia dados do widget para Bate-papo do agente.

Para obter mais informações sobre como passar dados para Bate-papo do agente, consulte Configure o Bate-papo do agente no Portal de serviços .

SpContextManager - addContext(chave de cadeia de caracteres, contexto do objeto)

Inicializa uma chave e adiciona dados do widget como o valor. Por exemplo, adicione dados à chave "bate-papo do agente" para disponibilizá-los para Bate-papo do agente.

Use este método na primeira vez que os dados forem adicionados a uma chave específica em um Portal de serviços página. Se a chave já estiver sendo usada por outro widget na página, use UpdateContextForKey() em vez disso.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
chave	Cadeia de caracteres	Nome da chave para enviar os dados. As chaves disponíveis incluem bate-papo do agente : Envia dados do widget para Bate-papo do agente quando ele abre em um Portal de serviços página.
contexto	Objeto	Dados do widget no formato JSON a serem enviados para a aplicação ou serviço especificado no parâmetro de chave. Por exemplo, "approval_count": 5] .

Tabela 2. Retornos

Tipo	Descrição
vazio

Passe approval_count para Bate-papo do agente. Quando um usuário inicia uma conversa Bate-papo do agente na página inicial de Portal de serviços, o sistema anexa &sysparm_approval_count=5 ao URL do Bate-papo do agente iframe.

function ($scope, spContextManager) {
    spContextManager.addContext('agent-chat', {
        'approval_count': 5       
    });
};

SpContextManager - getContext()

Retorna cada chave e objeto de dados associado definido por qualquer widget na página.

Usar este método pode afetar o desempenho. Use este método para entender quais chaves são inicializadas na página e para obter seus valores atuais. Se você souber qual chave precisa acessar, use GetContextForKey() em vez disso.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 4. Retorna

Tipo	Descrição
Objeto	Cada chave e objeto de dados associado definidos na página.

function ($scope, spContextManager) {
  spContextManager.getContext();
} 

SpContextManager - getContextForKey(Chave de cadeia de caracteres, booliano retornarPromise)

Retorna os dados do widget associados a uma chave.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
chave	Cadeia de caracteres	Nome da chave da qual obter contexto. As chaves disponíveis incluem: Agent-chat: Envia dados do widget para Bate-papo do agente.
ReturnPromise	Booliano	Sinalizador que determina se os dados associados a uma chave devem ser retornados como promessa ou objeto. Os valores incluem: Verdadeiro: Retorna os dados como uma promessa. Use esta opção se outro widget na página usar AddContext() método para inicializar a mesma chave. Retornar uma promessa impede o retorno de um objeto indefinido quando a chave ainda não foi inicializada. Falso: Retorna um objeto que contém os dados associados à chave.

Tabela 6. Retornos

Tipo	Descrição
Promessa	Se returnPromise for verdadeiro, retornará uma promessa que será cumprida quando outro widget na página inicializar a chave.
Objeto	Se returnPromise for falso, retornará um objeto que contém os dados associados à chave. Por exemplo, (approval_count: 5) .

Passe approval_count para Bate-papo do agente. Quando um usuário inicia uma conversa Bate-papo do agente na página inicial de Portal de serviços, o sistema anexa &sysparm_approval_count=5 ao URL do Bate-papo do agente iframe.

function ($scope, spContextManager) {
  spContextManager.getContextForKey('agent-chat', true).then(function(context) {
    context = context || {};
    context.approval_count = 5; 
    spContextManager.updateContextForKey('agent-chat', context);
  });
} 

SpContextManager - updateContextForKey(chave de cadeia de caracteres, contexto de objeto)

Envia dados para uma chave existente. Por exemplo, se outro widget na página usar a chave "bate-papo do agente" para passar dados para Bate-papo do agente, você deve atualizar o contexto da chave em vez de usar AddContext() método.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
chave	Cadeia de caracteres	Nome da chave para enviar os dados. As chaves disponíveis incluem bate-papo do agente : Envia dados do widget para Bate-papo do agente quando ele abre em um Portal de serviços página.
contexto	Objeto	Dados do widget no formato JSON a serem enviados para a aplicação ou serviço especificado no parâmetro de chave. Por exemplo, "approval_count": 5] .

Tabela 8. Retornos

Tipo	Descrição
vazio

Passe approval_count para Bate-papo do agente. Quando um usuário inicia uma conversa Bate-papo do agente na página inicial de Portal de serviços, o sistema anexa &sysparm_approval_count=5 ao URL do Bate-papo do agente iframe.

function ($scope, spContextManager) {
  spContextManager.getContextForKey('agent-chat', true).then(function(context) {
    context = context || {};
    context.approval_count = 5; 
    spContextManager.updateContextForKey('agent-chat', context);
  });
}