Structure du filtre : iOS

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 2 minutes de lecture
  • La structure de filtre permet de configurer des filtres qui définissent les données à renvoyer dans les résultats renvoyés d’une requête de point de terminaison REST.

    Filtre : init(criteria criteriaList : [Criteria], sortBy : [Sort] ? = nil, queryCategory : String ? = nil)

    Crée un filtre en fonction d’un ou de plusieurs critères de filtre qui sont OU ensemble.

    Tableau 1. Paramètres
    Nom Type Description
    critères Tableau Conditions de critères de niveau supérieur à regrouper avec des connecteurs OR .
    trier par Chaîne Facultatif. Ordre de tri des résultats renvoyés.
    Valeurs possibles :
    • asc : Ascendant
    • desc : Envoi en cours

    Par défaut : asc

    requête en catégorie Chaîne Facultatif. Nom de la catégorie de requête.

    Par défaut : Aucun

    Tableau 2. Renvoie
    Type Description
    Aucun

    L’exemple suivant montre la création de trois critères distincts et, lorsqu’ils sont transmis, si l’un de ces critères est rempli, l’enregistrement est renvoyé dans les résultats de retour.

    // 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])

    Filtre : init(conditions : [QueryProviding], sorts : [Sort] ? = nil)

    Crée un filtre basé sur toutes les conditions spécifiées (ET ensemble)

    Tableau 3. Paramètres
    Nom Type Description
    conditions QueryProviding (en anglais seulement) Conditions de regroupement à l’aide d’un connecteur ET .
    Valeurs possibles :
    • booléen
    • DateHeure
    • E-mail
    • choix entier
    • numérique
    • référence
    • chaîne
    • Choix de chaîne
    Sortes Chaîne Facultatif. Ordre de tri des résultats renvoyés.
    Valeurs possibles :
    • asc : Ascendant
    • desc : Envoi en cours

    Par défaut : asc

    Tableau 4. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction.

    // 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])

    Filtre : init(query : String, queryCategory : String ? = nil)

    Crée un filtre à l’aide d’une requête codée spécifiée.

    Tableau 5. Paramètres
    Nom Type Description
    requête Chaîne Requête codéeRequête codée à utiliser pour filtrer les enregistrements à renvoyer de la table.
    requête en catégorie Chaîne Facultatif. Nom de la catégorie de requête à utiliser pour la requête.
    Tableau 6. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette fonction.

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

    Filtre - init(mots-clés : chaîne ? = nil, conditions : [Condition], trier : [Trier] ? = néant)

    Crée un filtre basé sur des mots clés et des conditions spécifiques qui sont ensemble ET.

    Tableau 7. Paramètres
    Nom Type Description
    Mots clés Chaîne Facultatif. N’importe quel mot ou expression spécifique à rechercher.

    Par défaut : néant : pas de recherche de mot spécifique.

    conditions Chaîne Conditions de regroupement à l’aide d’un connecteur ET .
    Valeurs possibles :
    • booléen
    • DateHeure
    • E-mail
    • choix entier
    • numérique
    • référence
    • chaîne
    • Choix de chaîne
    trier par Chaîne Facultatif. Ordre de tri des résultats renvoyés.
    Valeurs possibles :
    • asc : Ascendant
    • desc : Envoi en cours

    Par défaut : asc

    Tableau 8. Renvoie
    Type Description
    Aucun

    // 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)