CLASS

# RoomleCatalogItem

Contents

  • Properties
    • id
    • name
    • itemDescription
    • perspectiveImageUrl
    • topImageUrl
    • attributes
    • additionalContents
    • configuration
    • layer
    • width
    • height
    • depth
    • type
    • detailType
    • orderable
    • scaleable
    • flipable
    • file3dUrl
  • Methods
    • isConfigurable()
    • similarItems()
    • perfectFitItems()
    • updateConfiguration(_:for:)
public class RoomleCatalogItem : NSObject

Representation of an item with all available data like name, images, etc. This object is only data transfer object (DTO), therefore you can't execute any additional functions like searches or something similar. It is only meant to provide information.

All informations are readonly. If an object like this is queried twice via a RoomleDataManager instance, then it is possible that there are two different instance which contains same information.

# Properties

# id

public private(set) var id : String

Identifier of this item. It is not an identifiers of this object.

# name

public private(set) var name : String

Name of this item

# itemDescription

public private(set) var itemDescription : String

Description of this item

# perspectiveImageUrl

public private(set) var perspectiveImageUrl : String

Url to perspective image of this item. If a HD version of this image is available, it will be preferred

# topImageUrl

public private(set) var topImageUrl : String

Url to top image of this item.

# attributes

public private(set) var attributes : [RoomleCatalogItemAttribute]

Possible attributes for this item.

# additionalContents

public private(set) var additionalContents : [RoomleCatalogItemAdditionalContent]

Possible additional contents for this item.

# configuration

public private(set) var configuration : String

Configuration for configurable items, empty instead

# layer

public private(set) var layer : Int

Describes the layer where items belongs to

# width

public private(set) var width : Int

Width of this item in millimetres

# height

public private(set) var height : Int

Height of this item in millimetres

# depth

public private(set) var depth : Int

Depth of this item in millimetres

# type

public private(set) var type : String

Type of this item. example: seating

# detailType

public private(set) var detailType : String

Detail type of this item. example: chair

# orderable

public private(set) var orderable : Bool

Indicates if the item is orderable

# scaleable

public private(set) var scaleable : Bool

Indicates if the item is scaleable

# flipable

public private(set) var flipable : Bool

Indicates if the item is flipable

# file3dUrl

public private(set) var file3dUrl : String

Url to 3d file for this item.

# Methods

# isConfigurable()

public func isConfigurable() -> Bool

# similarItems()

public func similarItems() -> [RoomleCatalogItem]?

Loads similar items from RAPI for this item. This call connects to the network and returns the requested data. The result is not stored in the database. When no connection is available zero items are returned.

# perfectFitItems()

public func perfectFitItems() -> [RoomleCatalogItem]?

Loads items from RAPI for this item which have similar size as the current one. This call connects to the network and returns the requested data. The result is not stored in the database. When no connection is available zero items are returned.

# updateConfiguration(_:for:)

public func updateConfiguration(_ configuration: String, for hash: String)