C8yObject

public protocol C8yObject : Equatable

Protocol identifying common features for all cumulocity assets managed via a C8yManagedObject

Currently only CyGroup and C8yDevice have been defined

  • id

    iOS id attributed for loca use/indexing

    Declaration

    Swift

    var id: String { get }
  • c8yId Default implementation

    Cumulocity assigned id for existing objects or nil if it doesn’t yet exist

    Default Implementation

    Declaration

    Swift

    var c8yId: String? { get }
  • name Default implementation

    Undocumented

    Default Implementation

    Undocumented

    Declaration

    Swift

    var name: String { get }

  • Undocumented

    Declaration

    Swift

    var groupCategory: C8yGroupCategory { get }
  • orgCategory Default implementation

    Undocumented

    Default Implementation

    Undocumented

    Declaration

    Swift

    var orgCategory: C8yOrganisationCategory { get }
  • deviceCategory Default implementation

    Undocumented

    Default Implementation

    Undocumented

    Declaration

    Swift

    var deviceCategory: C8yDevice.DeviceCategory { get }
  • operationalLevel Default implementation

    Undocumented

    Default Implementation

    Undocumented

    Declaration

    Swift

    var operationalLevel: C8yOperationLevel { get }
  • status Default implementation

    Undocumented

    Default Implementation

    Undocumented

    Declaration

    Swift

    var status: C8yManagedObject.AvailabilityStatus { get }

  • Undocumented

    Declaration

    Swift

    var hierachy: String? { get }
  • hasChildren Default implementation

    Undocumented

    Default Implementation

    Undocumented

    Declaration

    Swift

    var hasChildren: Bool { get }
  • deviceCount Default implementation

    Undocumented

    Default Implementation

    Undocumented

    Declaration

    Swift

    var deviceCount: Int { get }
  • onlineCount Default implementation

    Only applicable if hasChildren > 0

    Default Implementation

    Declaration

    Swift

    var onlineCount: Int { get }
  • offlineCount Default implementation

    Only applicable if hasChildren > 0

    Default Implementation

    Returns number of child devices that are unavailable

    Declaration

    Swift

    var offlineCount: Int { get }
  • alarmsCount Default implementation

    Undocumented

    Default Implementation

    Undocumented

    Declaration

    Swift

    var alarmsCount: Int { get }

  • Undocumented

    Declaration

    Swift

    var wrappedManagedObject: C8yManagedObject { get set }

  • Undocumented

    Declaration

    Swift

    var children: [AnyC8yObject] { get }

  • Undocumented

    Declaration

    Swift

    var externalIds: [String : C8yExternalId] { get set }
  • notes Default implementation

    Undocumented

    Default Implementation

    Undocumented

    Declaration

    Swift

    var notes: String? { get set }

  • Undocumented

    Declaration

    Swift

    func defaultIdAndType() -> String

  • Undocumented

    Declaration

    Swift

    func match(forExternalId id: String, type: String?) -> Bool
  • setExternalIds(_:) Extension method

    Undocumented

    Declaration

    Swift

    public mutating func setExternalIds(_ ids: [C8yExternalId])
  • isNew Extension method

    Undocumented

    Declaration

    Swift

    public var isNew: Bool { get }
  • type Extension method

    Undocumented

    Declaration

    Swift

    public var type: String? { get }
  • position Extension method

    Undocumented

    Declaration

    Swift

    public var position: C8yManagedObject.Position? { get set }

  • Undocumented

    Declaration

    Swift

    public func generateQRCodeImage(forType type: String?) throws -> UIImage