blob: 8eafd4bc7f102dce18ec53b81350b23477c05a00 (
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
/*
* 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 "Firestore/Source/Core/FSTTypes.h"
#import "Firestore/Source/Core/FSTViewSnapshot.h"
#import "Firestore/Source/Remote/FSTRemoteStore.h"
@class FSTQuery;
@class FSTSyncEngine;
NS_ASSUME_NONNULL_BEGIN
#pragma mark - FSTListenOptions
@interface FSTListenOptions : NSObject
+ (instancetype)defaultOptions;
- (instancetype)initWithIncludeQueryMetadataChanges:(BOOL)includeQueryMetadataChanges
includeDocumentMetadataChanges:(BOOL)includeDocumentMetadataChanges
waitForSyncWhenOnline:(BOOL)waitForSyncWhenOnline
NS_DESIGNATED_INITIALIZER;
- (instancetype)init NS_UNAVAILABLE;
@property(nonatomic, assign, readonly) BOOL includeQueryMetadataChanges;
@property(nonatomic, assign, readonly) BOOL includeDocumentMetadataChanges;
@property(nonatomic, assign, readonly) BOOL waitForSyncWhenOnline;
@end
#pragma mark - FSTQueryListener
/**
* FSTQueryListener takes a series of internal view snapshots and determines when to raise
* user-facing events.
*/
@interface FSTQueryListener : NSObject
- (instancetype)initWithQuery:(FSTQuery *)query
options:(FSTListenOptions *)options
viewSnapshotHandler:(FSTViewSnapshotHandler)viewSnapshotHandler NS_DESIGNATED_INITIALIZER;
- (instancetype)init NS_UNAVAILABLE;
- (void)queryDidChangeViewSnapshot:(FSTViewSnapshot *)snapshot;
- (void)queryDidError:(NSError *)error;
- (void)applyChangedOnlineState:(FSTOnlineState)onlineState;
@property(nonatomic, strong, readonly) FSTQuery *query;
@end
#pragma mark - FSTEventManager
/**
* EventManager is responsible for mapping queries to query event emitters. It handles "fan-out."
* (Identical queries will re-use the same watch on the backend.)
*/
@interface FSTEventManager : NSObject <FSTOnlineStateDelegate>
+ (instancetype)eventManagerWithSyncEngine:(FSTSyncEngine *)syncEngine;
- (instancetype)init __attribute__((unavailable("Use static constructor method.")));
- (FSTTargetID)addListener:(FSTQueryListener *)listener;
- (void)removeListener:(FSTQueryListener *)listener;
@end
NS_ASSUME_NONNULL_END
|
