diff options
author | Michael Lehenbauer <mikelehen@gmail.com> | 2018-07-10 16:58:56 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-07-10 16:58:56 -0700 |
commit | 25f8691970a9f765a87ab3125776598c92e02744 (patch) | |
tree | efdef14fd22c313411b9125d4804fd59aa114d5e /Firestore/Source/Public/FIRQuery.h | |
parent | 6466c35737eff21e9b48c3ce2353d42628f4bb77 (diff) |
Expose array transforms and array contains queries. (#1514)
Also remove test code that was combining multiple array contains
queries since those were disallowed in
https://github.com/firebase/firebase-ios-sdk/commit/0ec836f9ca71b27fa54a11ae9e07e60b8c5cc002
Diffstat (limited to 'Firestore/Source/Public/FIRQuery.h')
-rw-r--r-- | Firestore/Source/Public/FIRQuery.h | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/Firestore/Source/Public/FIRQuery.h b/Firestore/Source/Public/FIRQuery.h index 799abcc..2b02a3c 100644 --- a/Firestore/Source/Public/FIRQuery.h +++ b/Firestore/Source/Public/FIRQuery.h @@ -239,6 +239,38 @@ addSnapshotListenerWithIncludeMetadataChanges:(BOOL)includeMetadataChanges // clang-format on /** + * Creates and returns a new `FIRQuery` with the additional filter that documents must contain + * the specified field, it must be an array, and the array must contain the provided value. + * + * A query can have only one arrayContains filter. + * + * @param field The name of the field containing an array to search + * @param value The value that must be contained in the array + * + * @return The created `FIRQuery`. + */ +// clang-format off +- (FIRQuery *)queryWhereField:(NSString *)field + arrayContains:(id)value NS_SWIFT_NAME(whereField(_:arrayContains:)); +// clang-format on + +/** + * Creates and returns a new `FIRQuery` with the additional filter that documents must contain + * the specified field, it must be an array, and the array must contain the provided value. + * + * A query can have only one arrayContains filter. + * + * @param path The path of the field containing an array to search + * @param value The value that must be contained in the array + * + * @return The created `FIRQuery`. + */ +// clang-format off +- (FIRQuery *)queryWhereFieldPath:(FIRFieldPath *)path + arrayContains:(id)value NS_SWIFT_NAME(whereField(_:arrayContains:)); +// clang-format on + +/** * Creates and returns a new `FIRQuery` with the additional filter that documents must * satisfy the specified predicate. * |