NCMBQuery

public struct NCMBQuery<T> where T : NCMBBase

データストアの検索を行うクラスです。

  • オブジェクト取得時の並び順です。 フィールド名(文字列)の配列として設定し、降順の場合はフィールド名の先頭に-(マイナス)をつけてください。

    Declaration

    Swift

    public var order: [String]
  • オブジェクト取得時の開始位置です。

    Declaration

    Swift

    public var skip: Int?
  • オブジェクト取得時の取得件数です。

    Declaration

    Swift

    public var limit: Int?
  • データストア用の検索条件クラスを生成します。

    Declaration

    Swift

    public static func getQuery(className: String) -> NCMBQuery<NCMBObject>

    Parameters

    className

    検索対象のクラス名

    Return Value

    検索条件クラス

  • 検索を同期処理にて行います。

    Declaration

    Swift

    public func find() -> NCMBResult<[T]>

    Return Value

    リクエストが成功した場合は .success<[T]> 、 失敗した場合は .failure<Error>

  • 検索を非同期処理にて行います。

    Declaration

    Swift

    public func findInBackground(callback: @escaping NCMBHandler<[T]> ) -> Void

    Parameters

    callback

    レスポンス取得後に実行されるコールバックです。

  • 条件を満たすオブジェクトの数を同期処理にて検索し、返します。

    Declaration

    Swift

    public func count() -> NCMBResult<Int>

    Return Value

    リクエストが成功した場合は .success<Int> 、 失敗した場合は .failure<Error>

  • 条件を満たすオブジェクトの数を非同期処理にて検索し、返します。

    Declaration

    Swift

    public func countInBackground(callback: @escaping NCMBHandler<Int> ) -> Void

    Parameters

    callback

    レスポンス取得後に実行されるコールバックです。

  • 「フィールドの値が指定された値と一致するオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, equalTo value: Any)

    Parameters

    field

    対象のフィールド名

    value

    対応する値

  • 「フィールドの値が指定された値と一致しないオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, notEqualTo value: Any)

    Parameters

    field

    対象のフィールド名

    value

    対応する値

  • 「フィールドの値が指定された値より少ないオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, lessThan value: Any)

    Parameters

    field

    対象のフィールド名

    value

    対応する値

  • 「フィールドの値が指定された値より多いオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, greaterThan value: Any)

    Parameters

    field

    対象のフィールド名

    value

    対応する値

  • 「フィールドの値が指定された値より少ないか一致するオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, lessThanOrEqualTo value: Any)

    Parameters

    field

    対象のフィールド名

    value

    対応する値

  • 「フィールドの値が指定された値より多いか一致するオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, greaterThanOrEqualTo value: Any)

    Parameters

    field

    対象のフィールド名

    value

    対応する値

  • 「フィールドの値が指定された配列に含まれるオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, containedIn value: [Any])

    Parameters

    field

    対象のフィールド名

    value

    対応する配列

  • 「フィールドの値が指定された配列に含まれないオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, notContainedIn value: [Any])

    Parameters

    field

    対象のフィールド名

    value

    対応する配列

  • 「フィールドの値が指定された値を持つオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, exists value: Any)

    Parameters

    field

    対象のフィールド名

    value

    対応する値

  • 「フィールドの値が指定されたパターンを満たすオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, toMatchPattern value: String)

    Parameters

    field

    対象のフィールド名

    value

    対応するパターン

  • 「フィールドの持つ配列が指定された配列にいずれかが含まれるオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, containedInArrayTo value: [Any])

    Parameters

    field

    対象のフィールド名

    value

    対応する配列

  • 「フィールドの持つ配列が指定された配列にいずれも含まれないオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, notContainedInArrayTo value: [Any])

    Parameters

    field

    対象のフィールド名

    value

    対応する配列

  • 「フィールドの持つ配列が指定された配列にすべて含まれるオブジェクト」となる検索条件を追加します。

    Declaration

    Swift

    public mutating func `where`(field: String, containsAllObjectsInArrayTo value: [Any])

    Parameters

    field

    対象のフィールド名

    value

    対応する配列

  • 指定された条件から、いずれかを満たす条件を生成します。

    Declaration

    Swift

    public static func orQuery(_ mainQuery: NCMBQuery, _ subQueries: NCMBQuery...) -> NCMBQuery

    Parameters

    mainQuery

    条件

    subQueries

    条件

    callback

    レスポンス取得後に実行されるコールバックです。

    Return Value

    指定された条件について、いずれかを満たす条件