firebase-ios-sdk/Firestore/Swift/Source/Codable/DocumentReference+WriteEncodable.swift

/*
 * Copyright 2019 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
import FirebaseFirestore

public extension DocumentReference {
  /// Encodes an instance of `Encodable` and overwrites the encoded data
  /// to the document referred by this `DocumentReference`. If no document exists,
  /// it is created. If a document already exists, it is overwritten.
  ///
  /// 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 closure to execute once the document has been successfully
  ///                 written to the server. This closure will not be called while
  ///                 the client is offline, though local changes will be visible
  ///                 immediately.
  func setData<T: Encodable>(from value: T,
                             encoder: Firestore.Encoder = Firestore.Encoder(),
                             completion: ((Error?) -> Void)? = nil) throws {
    setData(try encoder.encode(value), completion: completion)
  }

  /// Encodes an instance of `Encodable` and overwrites the encoded data
  /// to the document referred by this `DocumentReference`. If no document exists,
  /// it is created. If a document already exists, it is overwritten.  If you pass
  /// merge:true, the provided `Encodable` will be merged into any existing document.
  ///
  /// See `Firestore.Encoder` for more details about the encoding process.
  ///
  /// - Parameters:
  ///   - value: An instance of `Encodable` to be encoded to a document.
  ///   - merge: Whether to merge the provided `Encodable` into any existing
  ///            document.
  ///   - encoder: An encoder instance to use to run the encoding.
  ///   - completion: A closure to execute once the document has been successfully
  ///                 written to the server. This closure will not be called while
  ///                 the client is offline, though local changes will be visible
  ///                 immediately.
  func setData<T: Encodable>(from value: T,
                             merge: Bool,
                             encoder: Firestore.Encoder = Firestore.Encoder(),
                             completion: ((Error?) -> Void)? = nil) throws {
    setData(try encoder.encode(value), merge: merge, completion: completion)
  }

  /// Encodes an instance of `Encodable` and writes the encoded data to the document referred
  /// by this `DocumentReference` by only replacing the fields specified under `mergeFields`.
  /// Any field that is not specified in mergeFields is ignored and remains untouched. If the
  /// document doesn’t yet exist, this method creates it and then sets the data.
  ///
  /// It is an error to include a field in `mergeFields` that does not have a corresponding
  /// field in the `Encodable`.
  ///
  /// See `Firestore.Encoder` for more details about the encoding process.
  ///
  /// - Parameters:
  ///   - value: An instance of `Encodable` to be encoded to a document.
  ///   - mergeFields: Array of `String` or `FieldPath` elements specifying which fields to
  ///                  merge. Fields can contain dots to reference nested fields within the
  ///                  document.
  ///   - encoder: An encoder instance to use to run the encoding.
  ///   - completion: A closure to execute once the document has been successfully
  ///                 written to the server. This closure will not be called while
  ///                 the client is offline, though local changes will be visible
  ///                 immediately.
  func setData<T: Encodable>(from value: T,
                             mergeFields: [Any],
                             encoder: Firestore.Encoder = Firestore.Encoder(),
                             completion: ((Error?) -> Void)? = nil) throws {
    setData(try encoder.encode(value), mergeFields: mergeFields, completion: completion)
  }
}