Structure du filtre - iOS

La structure Filter 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 basé sur un ou 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 : Croissant desc : Envoi en cours Valeur par défaut : asc
catégorie de requête	Chaîne	Facultatif. Nom de la catégorie de requête. Par défaut : Aucun

Tableau 2. Renvoie

Type	Description
Néant

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 (AND’d ensemble)

Tableau 3. Paramètres

Nom	Type	Description
conditions	QueryProviding	Conditions à regrouper avec un connecteur ET . Valeurs possibles : booléen Datetime E-mail Choix entier Numérique référence chaîne stringChoice
Sortes	Chaîne	Facultatif. Ordre de tri des résultats renvoyés. Valeurs possibles : asc : Croissant desc : Envoi en cours Valeur par défaut : asc

Tableau 4. Renvoie

Type	Description
Néant

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
query	Chaîne	Requête codéeRequête codée à utiliser pour filtrer les enregistrements à renvoyer à partir de la table.
catégorie de requête	Chaîne	Facultatif. Nom de la catégorie de requête à utiliser pour la requête.

Tableau 6. Renvoie

Type	Description
Néant

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

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

Filter - init(keywords : String ? = nil, conditions : [Condition], sortBy : [Sort] ? = nil)

Crée un filtre basé sur des mots clés et des conditions spécifiques qui sont associés à 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 : nil : pas de recherche de mot spécifique.
conditions	Chaîne	Conditions à regrouper avec un connecteur ET . Valeurs possibles : booléen Datetime E-mail Choix entier Numérique référence chaîne stringChoice
trier par	Chaîne	Facultatif. Ordre de tri des résultats renvoyés. Valeurs possibles : asc : Croissant desc : Envoi en cours Valeur par défaut : asc

Tableau 8. Renvoie

Type	Description
Néant

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