mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-09 22:36:01 +05:45
Gil
3a2077f1e4
* Annotate Transaction and WriteBatch methods as discardable These methods exist to allow chaining if that's useful but chaining isn't expected or required. Note that Objective-C methods in these types are implicitly @discardableResult and don't need any extra help. * No need to explicitly discard results * Fix typos in FIRCollectionReference docs * Add support for CollectionReference.addDocument(from:)
40 lines
1.7 KiB
Swift
40 lines
1.7 KiB
Swift
/*
|
|
* Copyright 2019 Google LLC
|
|
*
|
|
* 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
|
|
import FirebaseFirestore
|
|
|
|
extension CollectionReference {
|
|
/// Encodes an instance of `Encodable` and adds a new document to this collection
|
|
/// with the encoded data, assigning it a document ID automatically.
|
|
///
|
|
/// See `Firestore.Encoder` for more details about the encoding process.
|
|
///
|
|
/// - Parameters:
|
|
/// - value: An instance of `Encodable` to be encoded to a document.
|
|
/// - encoder: An encoder instance to use to run the encoding.
|
|
/// - completion: A block to execute once the document has been successfully
|
|
/// written to the server. This block will not be called while
|
|
/// the client is offline, though local changes will be visible
|
|
/// immediately.
|
|
/// - Returns: A `DocumentReference` pointing to the newly created document.
|
|
public func addDocument<T: Encodable>(from value: T,
|
|
encoder: Firestore.Encoder = Firestore.Encoder(),
|
|
completion: ((Error?) -> Void)? = nil) throws -> DocumentReference {
|
|
return addDocument(data: try encoder.encode(value), completion: completion)
|
|
}
|
|
}
|