Files
firebase-ios-sdk/Firestore/Source/Public/FIRSnapshotMetadata.h
T
Ryan Wilson 7386f00178 Replacing FIR_SWIFT_NAME macro with NS_SWIFT_NAME. (#476)
* Replacing FIR_SWIFT_NAME macro with NS_SWIFT_NAME.

This pushes the minimum Xcode version to 7.3, as NS_SWIFT_NAME was
limited before that version (which is why the macro was introduced in
the first place).

* Fixed FIRMessaging header
2017-11-28 06:59:07 -08:00

46 lines
1.7 KiB
Objective-C

/*
* 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>
NS_ASSUME_NONNULL_BEGIN
/** Metadata about a snapshot, describing the state of the snapshot. */
NS_SWIFT_NAME(SnapshotMetadata)
@interface FIRSnapshotMetadata : NSObject
- (instancetype)init NS_UNAVAILABLE;
/**
* Returns YES if the snapshot contains the result of local writes (e.g. set() or update() calls)
* that have not yet been committed to the backend. If your listener has opted into metadata updates
* (via `FIRDocumentListenOptions` or `FIRQueryListenOptions`) you will receive another snapshot
* with `hasPendingWrites` equal to NO once the writes have been committed to the backend.
*/
@property(nonatomic, assign, readonly, getter=hasPendingWrites) BOOL pendingWrites;
/**
* Returns YES if the snapshot was created from cached data rather than guaranteed up-to-date server
* data. If your listener has opted into metadata updates (via `FIRDocumentListenOptions` or
* `FIRQueryListenOptions`) you will receive another snapshot with `isFromCache` equal to NO once
* the client has received up-to-date data from the backend.
*/
@property(nonatomic, assign, readonly, getter=isFromCache) BOOL fromCache;
@end
NS_ASSUME_NONNULL_END