Skip to content

Add GetOptions for controlling offline get behaviour #655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jan 19, 2018
Merged

Add GetOptions for controlling offline get behaviour #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
80a40bd
GetOptions for controlling offline behaviour.
rsgowman Jan 10, 2018
6d29de2
GetOptions for controlling offline behaviour (pt2)
rsgowman Jan 11, 2018
30a513f
Address (easy) review feedback.
rsgowman Jan 16, 2018
c2395cc
Remove mistaken changes to unittests.
rsgowman Jan 12, 2018
76d0ae8
Prevent clang-format from breaking file
rsgowman Jan 16, 2018
2a32091
Run style.sh
rsgowman Jan 16, 2018
ec55882
Ensure swift bindings are correct
rsgowman Jan 16, 2018
61876ad
Alter getDocumentsFromLocalCache to be more like FSTSyncEngine.listen…
rsgowman Jan 17, 2018
f5024fb
Fix error messages.
rsgowman Jan 18, 2018
3abd449
Fix doc comments.
rsgowman Jan 18, 2018
d7b9e60
FIRSource -> FIRGetSource
rsgowman Jan 18, 2018
893e56a
Review feedback
rsgowman Jan 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Firestore/Example/Firestore.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
6003F5B1195388D20070C39A /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 6003F58D195388D20070C39A /* Foundation.framework */; };
6003F5B2195388D20070C39A /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 6003F591195388D20070C39A /* UIKit.framework */; };
6003F5BA195388D20070C39A /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = 6003F5B8195388D20070C39A /* InfoPlist.strings */; };
61CC13FA2007D0C90021F5BF /* FIRGetOptionsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 61CC13F82007D0C20021F5BF /* FIRGetOptionsTests.m */; };
61E1D8B11FCF6C5700753285 /* StringViewTests.mm in Sources */ = {isa = PBXBuildFile; fileRef = 61E1D8AF1FCF6AF500753285 /* StringViewTests.mm */; };
6ED54761B845349D43DB6B78 /* Pods_Firestore_Example.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 75A6FE51C1A02DF38F62FAAD /* Pods_Firestore_Example.framework */; };
71719F9F1E33DC2100824A3D /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 71719F9D1E33DC2100824A3D /* LaunchScreen.storyboard */; };
Expand Down Expand Up @@ -235,6 +236,7 @@
6003F5AF195388D20070C39A /* XCTest.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = XCTest.framework; path = Library/Frameworks/XCTest.framework; sourceTree = DEVELOPER_DIR; };
6003F5B7195388D20070C39A /* Tests-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = "Tests-Info.plist"; sourceTree = "<group>"; };
6003F5B9195388D20070C39A /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/InfoPlist.strings; sourceTree = "<group>"; };
61CC13F82007D0C20021F5BF /* FIRGetOptionsTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = FIRGetOptionsTests.m; sourceTree = "<group>"; };
61E1D8AF1FCF6AF500753285 /* StringViewTests.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = StringViewTests.mm; sourceTree = "<group>"; };
69F6A10DBD6187489481CD76 /* Pods_Firestore_Tests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Firestore_Tests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
71719F9E1E33DC2100824A3D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = "<group>"; };
Expand Down Expand Up @@ -723,6 +725,7 @@
DE51B1BC1F0D48AC0013853F /* API */ = {
isa = PBXGroup;
children = (
61CC13F82007D0C20021F5BF /* FIRGetOptionsTests.m */,
DE51B1BD1F0D48AC0013853F /* FIRCursorTests.m */,
DE51B1BE1F0D48AC0013853F /* FIRDatabaseTests.m */,
DE51B1BF1F0D48AC0013853F /* FIRFieldsTests.m */,
Expand Down Expand Up @@ -1281,6 +1284,7 @@
54E928251F33953400C1953E /* FSTEventAccumulator.m in Sources */,
DE03B2ED1F214BA200A30B9C /* FSTSmokeTests.m in Sources */,
DE03B2F31F214BAA00A30B9C /* FIRQueryTests.m in Sources */,
61CC13FA2007D0C90021F5BF /* FIRGetOptionsTests.m in Sources */,
DE03B35E1F21586C00A30B9C /* FSTHelpers.m in Sources */,
DE03B2F51F214BAA00A30B9C /* FIRTypeTests.m in Sources */,
DE03B2EF1F214BAA00A30B9C /* FIRCursorTests.m in Sources */,
Expand Down
24 changes: 24 additions & 0 deletions Firestore/Example/SwiftBuildTest/main.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,10 @@ func main() {
addDocument(to: collectionRef);

readDocument(at: documentRef);
readDocumentWithOptions(at: documentRef);

readDocuments(matching: query);
readDocumentsWithOptions(matching: query);

listenToDocument(at: documentRef);

Expand Down Expand Up @@ -223,6 +225,17 @@ func readDocument(at docRef: DocumentReference) {
}
}

func readDocumentWithOptions(at docRef: DocumentReference) {
docRef.getDocument(options:GetOptions.defaultOptions()) { document, error in
}
docRef.getDocument(options:GetOptions(source:GetSource.default)) { document, error in
}
docRef.getDocument(options:GetOptions(source:.server)) { document, error in
}
docRef.getDocument(options:GetOptions(source:GetSource.cache)) { document, error in
}
}

func readDocuments(matching query: Query) {
query.getDocuments() { querySnapshot, error in
// TODO(mikelehen): Figure out how to make "for..in" syntax work
Expand All @@ -233,6 +246,17 @@ func readDocuments(matching query: Query) {
}
}

func readDocumentsWithOptions(matching query: Query) {
query.getDocuments(options:GetOptions.defaultOptions()) { querySnapshot, error in
}
query.getDocuments(options:GetOptions.init(source:GetSource.default)) { querySnapshot, error in
}
query.getDocuments(options:GetOptions.init(source:GetSource.server)) { querySnapshot, error in
}
query.getDocuments(options:GetOptions.init(source:GetSource.cache)) { querySnapshot, error in
}
}

func listenToDocument(at docRef: DocumentReference) {

let listener = docRef.addSnapshotListener() { document, error in
Expand Down
Loading