Classe FieldReadConfiguration - Android

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 1 min. de leitura
  • A classe FieldReadConfiguration fornece a capacidade de definir quais campos serão retornados ou não em um registro de resposta.

    Tabela 1. Propriedades
    Nome Tipo Descrição
    includeFields Coleção<String> Campos a serem retornados na resposta.
    queryItems Mapa<String, String> Somente leitura. Coleção de itens de consulta que representam a configuração de leitura.
    queryParams QueryParams Estrutura iterável que contém pares de nome-valor de parâmetros de consulta de solicitação. Use esses parâmetros para criar uma solicitação.

    FieldReadConfiguration - FieldReadConfiguration(includeFields: coleção<String> = listOf(), opções de vararg: FieldReadConfiguration.Options)

    Define os campos a serem incluídos na resposta de retorno da tabela ServiceNow associada.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    includeFields Coleção<String> Lista de campos separados por vírgulas a serem retornados na resposta. Se a lista estiver vazia, todos os campos serão retornados.
    opções de vararg ConfiguraçãoDeLeituraDeCampo.Opções Opcional. Matriz de zero ou mais opções que definem o tipo de informações de campo a serem retornadas.
    Valores possíveis:
    • ACTUAL_VALUES: inclui o valor real do campo na resposta.
    • DISPLAY_VALUES: inclui o valor de exibição do campo na resposta.
    • EXCLUDE_REFERENCE_LINK: exclua os links da API da tabela para os campos de referência.

    O exemplo de código a seguir mostra como chamar esta função.

    val readConfiguration = FieldReadConfiguration(
      includeFields = listOf("sys_id", "sys_created_on", "short_description"),
      options = arrayOf(FieldReadConfiguration.Options.DISPLAY_VALUES)
    )
    val fetchConfiguration = FetchConfiguration(
      filter = Filter("active=true"),
      readConfiguration = readConfiguration
    )
    val response = nowTableService.records("incident", fetchConfiguration).execute()
    handleResponse(response)