Filterstruktur: iOS

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 2 Minuten Lesedauer
  • Die Filterstruktur bietet die Möglichkeit, Filter zu konfigurieren, die die Daten definieren, die in den zurückgegebenen Ergebnissen einer REST-Endpunktabfrage zurückgegeben werden sollen.

    Filter – init(criteria Kriterienliste: [Kriterien], sortBy: [Sort]? = nil, queryCategory: Zeichenfolge? = nil)

    Erstellt einen Filter basierend auf einem oder mehreren Filterkriterien, die ODER-verknüpft sind.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Kriterien Array Kriterienbedingungen der obersten Ebene für die Gruppierung mit ODER- Connectors.
    sortBy Zeichenfolge Optional. Sortierreihenfolge der zurückgegebenen Ergebnisse.
    Mögliche Werte:
    • asc: Aufsteigend
    • desc: Wird abgerufen

    Standard: asc

    Abfragekategorie Zeichenfolge Optional. Name der Abfragekategorie.

    Standard: Keine

    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie drei separate Kriterien erstellt werden. Wenn eines dieser Kriterien erfüllt wird, wird der Datensatz bei der Übergabe an die zurückgegebenen Ergebnisse zurückgegeben.

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

    Filter – init(conditions: [Query Bereitstellung], sorts: [Sort]? = nil)

    Erstellt einen Filter basierend auf allen angegebenen Bedingungen (UND-Verknüpfungen)

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Bedingungen Abfragebereitstellung Mit einem AND- Connector zu gruppierende Bedingungen
    Mögliche Werte:
    • boolean
    • dateTime
    • E-Mail
    • Ganzzahlauswahl
    • numerisch
    • Referenz
    • Zeichenfolge
    • Zeichenfolgenauswahl
    Sortierungen Zeichenfolge Optional. Sortierreihenfolge der zurückgegebenen Ergebnisse.
    Mögliche Werte:
    • asc: Aufsteigend
    • desc: Wird abgerufen

    Standard: asc

    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

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

    Filter – init(query: Zeichenfolge, queryCategory: Zeichenfolge? = nil)

    Erstellt einen Filter anhand einer angegebenen codierten Abfrage.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    query Zeichenfolge Codierte AbfrageCodierte Abfrage zum Filtern der aus der Tabelle zurückzugebenden Datensätze.
    Abfragekategorie Zeichenfolge Optional. Name der Abfragekategorie, die für die Abfrage verwendet werden soll.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

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

    Filter – init(Stichwörter: Zeichenfolge? = Null, Bedingungen: [Bedingung], sortBy: [Sort]? = Null)

    Erstellt einen Filter basierend auf bestimmten Schlüsselwörtern und Bedingungen, die UND-verknüpft sind.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Stichwörter Zeichenfolge Optional. Ein bestimmtes Wort oder ein bestimmter Ausdruck, nach dem gesucht werden soll.

    Standard: nil – Keine spezifische Wortsuche.

    Bedingungen Zeichenfolge Mit einem AND- Connector zu gruppierende Bedingungen
    Mögliche Werte:
    • boolean
    • dateTime
    • E-Mail
    • Ganzzahlauswahl
    • numerisch
    • Referenz
    • Zeichenfolge
    • Zeichenfolgenauswahl
    sortBy Zeichenfolge Optional. Sortierreihenfolge der zurückgegebenen Ergebnisse.
    Mögliche Werte:
    • asc: Aufsteigend
    • desc: Wird abgerufen

    Standard: asc

    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Keine

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