フィルター構造 : iOS
フィルター構造では、REST エンドポイントクエリの戻り結果で返すデータを定義するフィルターを構成できます。
フィルター:init(criteria criteriaList: [Criteria], sortBy: [Sort]? = nil, queryCategory: String? = nil)
OR で結合された 1 つ以上のフィルター基準に基づいてフィルターを作成します。
| 名前 | タイプ | 説明 |
|---|---|---|
| クライテリア | アレイ | OR コネクタでグループ化するトップレベルの基準条件。 |
| sortBy | 文字列 | オプション。返される結果のソート順。 可能な値:
デフォルト:asc |
| queryCategory | 文字列 | オプション。クエリカテゴリの名前。 デフォルト:なし |
| タイプ | 説明 |
|---|---|
| なし |
次の例は、3 つの個別の基準を作成し、渡されたときにそれらの基準のいずれかが満たされると、レコードが返される結果に戻されることを示しています。
// 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])
フィルター - init(conditions: [QueryProviding], sorts: [Sort]? = nil)
指定されたすべての条件に基づいてフィルターを作成します (ANDを一緒に使用)
| 名前 | タイプ | 説明 |
|---|---|---|
| 条件 | クエリ提供 | AND コネクタでグループ化する条件。可能な値:
|
| ソート | 文字列 | オプション。返される結果のソート順。 可能な値:
デフォルト:asc |
| タイプ | 説明 |
|---|---|
| なし |
次のコード例は、この関数を呼び出す方法を示しています。
// 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])
フィルター:init(query: String, queryCategory: String? = nil)
フィルター:init(キーワード: String?= nil, conditions: [Condition], sortBy: [Sort]?= nil)
AND で結合された特定のキーワードと条件に基づいてフィルターを作成します。
| 名前 | タイプ | 説明 |
|---|---|---|
| キーワード | 文字列 | オプション。検索する特定の単語またはフレーズ。 デフォルト:nil - 特定の単語検索はありません。 |
| 条件 | 文字列 | AND コネクタでグループ化する条件。可能な値:
|
| sortBy | 文字列 | オプション。返される結果のソート順。 可能な値:
デフォルト:asc |
| タイプ | 説明 |
|---|---|
| なし |
// 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)