Estrutura de filtro - iOS

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 2 min. de leitura
  • A estrutura de filtro fornece a capacidade de configurar filtros que definem os dados a serem retornados nos resultados de retorno de uma consulta de endpoint REST.

    Filtro - init(critérios critériosLista: [Critérios], ordenarPor: [Classificar]? = nil, queryCategory: Cadeia de caracteres? = nil)

    Cria um filtro com base em um ou mais critérios de filtro que são OU juntos.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    critérios Matriz Condições de critérios de nível superior para agrupar com conectores OR.
    classificarPor Cadeia de caracteres Opcional. Ordem de classificação dos resultados retornados.
    Valores possíveis:
    • asc: crescente
    • desc: envio

    Padrão: asc

    queryCategory Cadeia de caracteres Opcional. Nome da categoria de consulta.

    Padrão: nenhum

    Tabela 2. Retorna
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra a criação de três critérios separados e, quando passados, se algum desses critérios for atendido, o registro será passado de volta nos resultados de retorno.

    // All of criteria1 conditions must be met
    let criteria1 = Criteria(conditions: …)
    
    // OR all of criteria2 conditions must be met
    let criteria2 = Criteria(conditions: …)
    
    // OR all of criteria3 conditions must be met
    let criteria3 = Criteria(conditions: …)
    
    let filter = Filter(criterias: [criteria1, criteria2, criteria3])

    Filtro - init(conditions: [QueryProviding], classificações: [Sort]? = nil)

    Cria um filtro com base em todas as condições especificadas (AND'd'd juntos)

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    condições ConsultaFornecer Condições para agrupar com um conector E.
    Valores possíveis:
    • booliano
    • data/hora
    • e-mail
    • InteiroEscolha
    • numérico
    • referência
    • Cadeia de caracteres
    • cadeia de caracteresEscolha
    classificações Cadeia de caracteres Opcional. Ordem de classificação dos resultados retornados.
    Valores possíveis:
    • asc: crescente
    • desc: envio

    Padrão: asc

    Tabela 4. Retorna
    Tipo Descrição
    Nenhum(a)

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

    // Where the record is active
    let condition1 = Condition.boolean(field: "active", .is(true))
    
    // AND the date value of the SLA due field is on "today" or any date after today.
    let condition2 = Condition.dateTime(field: "sla_due", .atOrAfter(0, .daysAgoStart))
    
    let filter = Filter(conditions: [condition1, condition2])

    Filtro - init(query: cadeia de caracteres, queryCategory: cadeia de caracteres? = nil)

    Cria um filtro usando uma consulta codificada especificada.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    consulta Cadeia de caracteres Consultacodificada Consulta codificada a ser usada para filtrar os registros a serem retornados da tabela.
    queryCategory Cadeia de caracteres Opcional. Nome da categoria de consulta a ser usada para a consulta.
    Tabela 6. Retorna
    Tipo Descrição
    Nenhum(a)

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

    let query = "active=true^short_descriptionLIKEbroken"
    let filter = Filter(query: query)

    Filtro - init(palavras-chave: cadeia de caracteres? = nil, condições: [Condição], classificarPor: [Sort]? = nil)

    Cria um filtro com base em palavras-chave e condições específicas que são combinadas com E.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    palavras-chave Cadeia de caracteres Opcional. Qualquer palavra ou frase específica a ser pesquisada.

    Padrão: nil - Nenhuma pesquisa de palavra específica.

    condições Cadeia de caracteres Condições para agrupar com um conector E.
    Valores possíveis:
    • booliano
    • data/hora
    • e-mail
    • InteiroEscolha
    • numérico
    • referência
    • Cadeia de caracteres
    • cadeia de caracteresEscolha
    classificarPor Cadeia de caracteres Opcional. Ordem de classificação dos resultados retornados.
    Valores possíveis:
    • asc: crescente
    • desc: envio

    Padrão: asc

    Tabela 8. Retorna
    Tipo Descrição
    Nenhum

    // Keyword that must be found in the record
    let searchTerm = "…"
    
    // AND the specified condition must be met
    let condition1 = Condition.email(field: "state", .changesFrom("4"))
    
    let filter = Filter(keywords: searchTerm, condition: condition1)