blob: b80eda73dbde03d9fcbfc8e7e62045476d5a9800 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
/*
* Copyright 2017 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import <Foundation/Foundation.h>
#import "FIRFirestoreSwiftNameSupport.h"
NS_ASSUME_NONNULL_BEGIN
/**
* A `FieldPath` refers to a field in a document. The path may consist of a single field name
* (referring to a top level field in the document), or a list of field names (referring to a nested
* field in the document).
*/
FIR_SWIFT_NAME(FieldPath)
@interface FIRFieldPath : NSObject <NSCopying>
- (instancetype)init NS_UNAVAILABLE;
/**
* Creates a `FieldPath` from the provided field names. If more than one field name is provided, the
* path will point to a nested field in a document.
*
* @param fieldNames A list of field names.
* @return A `FieldPath` that points to a field location in a document.
*/
- (instancetype)initWithFields:(NSArray<NSString *> *)fieldNames FIR_SWIFT_NAME(init(_:));
/**
* A special sentinel `FieldPath` to refer to the ID of a document. It can be used in queries to
* sort or filter by the document ID.
*/
+ (instancetype)documentID;
@end
NS_ASSUME_NONNULL_END
|