_ObjC_HeartbeatsPayload.swift 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. // Copyright 2021 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. import Foundation
  15. /// A model object representing a payload of heartbeat data intended for sending in network requests.
  16. @objc(FIRHeartbeatsPayload)
  17. public class _ObjC_HeartbeatsPayload: NSObject, HTTPHeaderRepresentable {
  18. /// The underlying Swift structure.
  19. private let heartbeatsPayload: HeartbeatsPayload
  20. /// Designated initializer.
  21. /// - Parameter heartbeatsPayload: A native-Swift heartbeats payload.
  22. public init(_ heartbeatsPayload: HeartbeatsPayload) {
  23. self.heartbeatsPayload = heartbeatsPayload
  24. }
  25. /// Returns a processed payload string intended for use in a HTTP header.
  26. /// - Returns: A string value from the heartbeats payload.
  27. @objc public func headerValue() -> String {
  28. heartbeatsPayload.headerValue()
  29. }
  30. /// A Boolean value indicating whether the payload is empty.
  31. @objc public var isEmpty: Bool {
  32. heartbeatsPayload.isEmpty
  33. }
  34. }