フィルター構造:iOS

フィルター構造は、REST エンドポイントクエリの結果を返すデータを定義するフィルターを構成する機能を提供します。

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

OR 結合された 1 つ以上のフィルター基準に基づいてフィルターを作成します。

表 : 1. パラメーター

名前	タイプ	説明
条件	アレイ	OR コネクタでグループ化するトップレベルの基準条件。
sortBy	文字列	オプション。返される結果のソート順。 可能な値： asc:昇順 desc:送信解除 デフォルト値:asc
クエリカテゴリ	文字列	オプション。クエリカテゴリの名前。 デフォルト：なし

表 : 2. 返される内容

タイプ	説明
なし

次の例は、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])

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

指定されたすべての条件 (AND を組み合わせたもの) に基づいてフィルターを作成します

表 : 3. パラメーター

名前	タイプ	説明
条件	クエリの提供	AND コネクタでグループ化する条件。 可能な値： ブール dateTime メール integerChoice numeric 参照 文字列 stringChoice
種類	文字列	オプション。返される結果のソート順。 可能な値： asc:昇順 desc:送信解除 デフォルト値:asc

表 : 4. 戻り値

タイプ	説明
なし

次のコード例は、この関数を呼び出す方法を示しています。

// 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: String, queryCategory: String? = nil)

指定されたエンコードクエリを使用してフィルターを作成します。

表 : 5. パラメーター

名前	タイプ	説明
クエリ	文字列	エンコードクエリ テーブルから返すレコードをフィルタリングするために使用するエンコードクエリ。
クエリカテゴリ	文字列	オプション。クエリに使用するクエリカテゴリの名前。

表 : 6. 戻り値

タイプ	説明
なし

次のコード例は、この関数を呼び出す方法を示しています。

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

Filter - init(キーワード: String? = nil, conditions: [Condition], sortBy: [Sort]? = nil)

AND で結合された特定のキーワードと条件に基づいてフィルターを作成します。

表 : 7. パラメーター

名前	タイプ	説明
キーワード	文字列	オプション。検索する特定の単語またはフレーズ。 デフォルト:nil - 特定の単語検索は行いません。
条件	文字列	AND コネクタでグループ化する条件。 可能な値： ブール dateTime メール integerChoice numeric 参照 文字列 stringChoice
sortBy	文字列	オプション。返される結果のソート順。 可能な値： asc:昇順 desc:送信解除 デフォルト値:asc

表 : 8. 戻り値

タイプ	説明
なし

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