spUtil - Cliente

A API spUtil fornece métodos de utilitário para executar funções comuns em um script de cliente de widget Portal de serviços.

Essas funções incluem:

• Exibir uma mensagem de erro de notificação. spUtil - addErrorMessage (cadeia de caracteres mensagem)
• Exibir uma mensagem informativa de notificação. spUtil – addInfoMessage(cadeia de caracteres mensagem)
• Exibir uma mensagem de notificação comum. spUtil - addTrivialMessage (cadeia de caracteres mensagem)
• Crie um identificador exclusivo. spUtil – createUid()
• Formate uma cadeia de caracteres com variáveis. spUtil - format (modelo de cadeia de caracteres, dados do objeto)
• Incorporar um modelo de widget em um client script de widget. spUtil – get(cadeia de caracteres dados do objeto widgetId)
• Recupere todos os cabeçalhos a serem usados em chamadas de API. spUtil – getHeaders()
• Retorne o domínio do host completo. spUtil – getHost()
• Execute o retorno de chamada com a resposta Preferência do usuário passando o nome da preferência. spUtil – getPreference (preferência de cadeia de caracteres, retorno de chamada de função)
• Retornar as informações de URL do portal de serviços atual. spUtil – getURL()
• Verifique se o cliente atual é um dispositivo móvel. spUtil – isMobile()
• Analise os atributos separados por vírgulas em uma cadeia de caracteres especificada. spUtil - parseAttributes (atributos de cadeia de caracteres)
• Observe se há atualizações em uma tabela ou filtro e retorna o valor da função de retorno de chamada. spUtil - recordWatch(Object $scope, Tabela de cadeia de caracteres, Filtro de cadeia de caracteres, Retorno de chamada de função)
• Chama o servidor e substitui as opções e os dados atuais pela resposta do servidor. spUtil - atualizar (objeto $escopo)
• Role até o elemento com o seletor especificado, durante um período de tempo especificado. spUtil – rollTo(seletor de cadeia de caracteres, tempo numérico)
• Atualize as trilhas do cabeçalho. spUtil – setBreadCrumb(Objeto $escopo, trilhas de matriz)
• Defina uma preferência do usuário. spUtil – setPreference(cadeia de caracteres pref, valor de cadeia de caracteres)
• Atualize a página de pesquisa. spUtil – setSearchPage(cadeia de caracteres searchPage)
• Atualize o objeto de dados no servidor dentro de um determinado escopo. spUtil - update(Object $scope)

Para obter informações adicionais sobre widgets, consulte Widgets do Portal de serviços.

spUtil - addErrorMessage (cadeia de caracteres mensagem)

Exibe uma mensagem de erro de notificação.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
message	Cadeia de caracteres	Mensagem de erro a ser exibida.

Tabela 2. Retornos

Tipo	Descrição
vazio

spUtil.addErrorMessage("There has been an error processing your request")

spUtil – addInfoMessage(cadeia de caracteres mensagem)

Exibe uma mensagem informativa de notificação.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
message	Cadeia de caracteres	Mensagem a ser exibida.

Tabela 4. Retornos

Tipo	Descrição
vazio

spUtil.addInfoMessage("Your order has been placed")

spUtil - addTrivialMessage (cadeia de caracteres mensagem)

Exibe uma mensagem de notificação comum.

As mensagens triviais desaparecem após um curto período de tempo.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
message	Cadeia de caracteres	Mensagem a ser exibida.

Tabela 6. Retornos

Tipo	Descrição
vazio

spUtil.addTrivialMessage("Thanks for your order")

spUtil – createUid()

Crie um identificador exclusivo.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 8. Retorna

Tipo	Descrição
Cadeia de caracteres	Um ID exclusivo de 32 caracteres.

spUtil – get(cadeia de caracteres dados do objeto widgetId)

Incorpora um modelo de widget em um client script de widget.

A função de retorno de chamada retorna o modelo de widget completo. Para obter informações adicionais sobre widgets, consulte Widgets do Portal de serviços.

Tabela 9. Parâmetros

Nome	Tipo	Descrição
ID do widget	Cadeia de caracteres	ID do widget ou sys_id do widget a ser incorporado.
dados	Objeto	Opcional. Pares de nome/valor de parâmetros a serem passados para o modelo de widget.

Tabela 10. Retornos

Tipo	Descrição
Objeto	Modelo do widget incorporado.

Sem dados passados.

spUtil.get("widget-cool-clock").then(function(response) {
  c.coolClock = response;
});

Com dados passados.

spUtil.get('pps-list-modal', {title: c.data.editAllocations, 
  table: 'resource_allocation', 
  queryString: 'GROUPBYuser^resource_plan=' + c.data.sysId, 
  view: 'resource_portal_allocations' }).then(function(response) {
    var formModal = response;
    c.allocationListModal = response;
  });  	

spUtil – getHeaders()

Recupera todos os cabeçalhos a serem usados para chamadas de API.

Tabela 11. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 12. Retorna

Tipo	Descrição
Objeto	Todos os cabeçalhos a serem usados para chamadas de API.

spUtil – getHost()

Retorna o domínio do host completo.

Tabela 13. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 14. Retorna

Tipo	Descrição
Cadeia de caracteres	O domínio do host completo, por exemplo hi.servicenow.com

spUtil – getPreference (preferência de cadeia de caracteres, retorno de chamada de função)

Executa o retorno de chamada com resposta de preferência do usuário passando o nome da preferência.

Tabela 15. Parâmetros

Nome	Tipo	Descrição
preferência	Cadeia de caracteres	Nome da preferência.
retorno de chamada	Função	Defina a função de retorno de chamada.

Tabela 16. Retornos

Tipo	Descrição
vazio

spUtil – getURL()

Retorna as informações de URL do portal de serviços atual.

Tabela 17. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 18. Retorna

Tipo	Descrição
Cadeia de caracteres	URL do portal de serviço atual.

spUtil - format (modelo de cadeia de caracteres, dados do objeto)

Formata uma cadeia de caracteres que contém variáveis.

Use este método como uma alternativa à concatenação de cadeia de caracteres.

Tabela 19. Parâmetros

Nome	Tipo	Descrição
modelo	Cadeia de caracteres	Modelo de cadeia de caracteres que contém valores para substituição de variável.
dados	Objeto	Objeto que contém os valores das variáveis definidas na cadeia de caracteres do modelo.

Tabela 20. Retornos

Tipo	Descrição
Cadeia de caracteres	Cadeia de caracteres que contém os valores de variáveis em vez da nomenclatura de variáveis.

spUtil.format('An error ocurred: {error} when loading {widget}', {error: '404', widget: 'sp-widget'})

Saída:

'An error occurred: 404 when loading sp-widget'

spUtil – isMobile()

Verifica se o cliente atual é um dispositivo móvel.

Tabela 21. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 22. Retorna

Tipo	Descrição
Booliano	Sinalizador que indica se o cliente atual é um dispositivo móvel. Valores válidos: verdadeiro: o cliente atual é um dispositivo móvel. falso: o cliente atual não é um dispositivo móvel.

spUtil - parseAttributes (atributos de cadeia de caracteres)

Analisa os atributos separados por vírgulas em uma cadeia de caracteres especificada.

Tabela 23. Parâmetros

Nome	Tipo	Descrição
atributos	Cadeia de caracteres	Cadeia de caracteres que contém atributos separados por vírgula, como o campo Atributos de um registro de dicionário.

Tabela 24. Retornos

Tipo	Descrição
Matriz	Matriz de objetos que contém os atributos analisados.

function getRefQualElements() {
  var refQualElements = [];
  if (field && field.attributes && field.attributes.indexOf('ref_qual_elements') > -1) {
    var attributes = spUtil.parseAttributes(field.attributes);
    refQualElements = attributes['ref_qual_elements'].split(';');
  }
  return refQualElements;
}

spUtil - recordWatch(Object $scope, Tabela de cadeia de caracteres, Filtro de cadeia de caracteres, Retorno de chamada de função)

Observa se há atualizações em uma tabela ou filtro e retorna o valor da função de retorno de chamada.

Permite que um desenvolvedor de widget responda a atualizações de tabela em tempo real. Por exemplo, usando recordWatch(), o widget de lista simples pode escutar mudanças em sua tabela de dados. Se registros forem adicionados, removidos ou atualizados, o widget será atualizado automaticamente.

Nota:

Ao passar o argumento $scope para a função recordWatch(), injete $scope nos parâmetros da função de client script.

Tabela 25. Parâmetros

Nome	Tipo	Descrição
$escopo	Objeto	Escopo do objeto de dados atualizado pela função de retorno de chamada.
tabela	Cadeia de caracteres	Tabela observada.
filtros	Cadeia de caracteres	Filtrar por campos a serem observados.
retorno de chamada	Função	Opcional. Parâmetro para definir a função de retorno de chamada.

Tabela 26. Retornos

Tipo	Descrição
Promessa	Valor de retorno da função de retorno de chamada.

//A simple recordWatch function.
spUtil.recordWatch($scope, "live_profile", "sys_id=" + liveProfileId);

//In a widget client script
function(spUtil, $scope) {
  /* widget controller */
  var c =this;

  // Registers a listener on the incident table with the filter active=true, 
  // meaning that whenever something changes on that table with that filter, 
  // the callback function is executed.    
  // The callback function takes a single parameter 'response', which contains 
  // the property 'data'. The 'data' property contains information about the changed record. 
  spUtil.recordWatch($scope, "incident", "active=true", function(response) {
        
    // Returns the data inserted or updated on the table 
    console.log(response.data);   
    
    });
}

spUtil - atualizar (objeto $escopo)

Chama o servidor e substitui as opções e os dados atuais pela resposta do servidor.

Chamar spUtil.refresh() é semelhante a chamar server.refresh(). No entanto, ao chamar spUtil.refresh(), você pode definir o objeto $scope.

Tabela 27. Parâmetros

Nome	Tipo	Descrição
$escopo	Objeto	Escopo definido para a atualização.

Tabela 28. Retornos

Tipo	Descrição
Objeto	Opções e objetos de dados atualizados.

spUtil – rollTo(seletor de cadeia de caracteres, tempo numérico)

Rola para o elemento com o seletor especificado, durante um período de tempo especificado.

Tabela 29. Parâmetros

Nome	Tipo	Descrição
seletor	Cadeia de caracteres	Seletor para o qual rolar.
hora	Número	Tempo necessário para rolar até o seletor especificado. Unidade: Milissegundos

Tabela 30. Retornos

Tipo	Descrição
vazio

spUtil – setBreadCrumb(Objeto $escopo, trilhas de matriz)

Atualiza as trilhas do cabeçalho.

Tabela 31. Parâmetros

Nome	Tipo	Descrição
$escopo	Objeto	Escopo definido para a tabela.
Trilhas	Matriz	Condições usadas para criar o filtro de trilhas.

Tabela 32. Retornos

Tipo	Descrição
vazio

spUtil – setPreference(cadeia de caracteres pref, valor de cadeia de caracteres)

Define uma preferência do usuário.

Tabela 33. Parâmetros

Nome	Tipo	Descrição
pref	Cadeia de caracteres	Nome de preferência
valor	Cadeia de caracteres	Valor de preferência

Tabela 34. Retornos

Tipo	Descrição
vazio

spUtil – setSearchPage(cadeia de caracteres searchPage)

Atualiza a página de pesquisa.

Tabela 35. Parâmetros

Nome	Tipo	Descrição
searchPage	Cadeia de caracteres	Nome da página de pesquisa.

Tabela 36. Retornos

Tipo	Descrição
vazio

spUtil - update(Object $scope)

Atualiza o objeto de dados no servidor dentro de um determinado escopo.

Este método é semelhante a server.update(), mas inclui um parâmetro $scope que define o escopo a ser passado.

Tabela 37. Parâmetros

Nome	Tipo	Descrição
$escopo	Objeto	Escopo definido para a atualização.

Tabela 38. Retornos

Tipo	Descrição
Objeto	Objeto de dados atualizado.

O exemplo a seguir inclui um widget P1 que observa mudanças no campo de estado e usa um filtro para observar todos os P1s ativos e permitir que a função de retorno de chamada determine se os dados devem ser atualizados. A propriedade data.changes contém uma matriz de todos os campos atualizados. Se o estado de qualquer campo tiver sido alterado, os dados serão atualizados no widget.

var q = "priority=1^active=true^EQ";
spUtil.recordWatch($scope, "incident", q, function(event, data) {
   if (data.changes.includes("state")) { // only update if state was updated.
      spUtil.update($scope);
   }
});