Documentation

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:)

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

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

# name

Name of this item

# itemDescription

Description of this item

# perspectiveImageUrl

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

# topImageUrl

Url to top image of this item.

# attributes

Possible attributes for this item.

# additionalContents

Possible additional contents for this item.

# configuration

Configuration for configurable items, empty instead

# layer

Describes the layer where items belongs to

# width

Width of this item in millimetres

# height

Height of this item in millimetres

# depth

Depth of this item in millimetres

# type

Type of this item. example: seating

# detailType

Detail type of this item. example: chair

# orderable

Indicates if the item is orderable

# scaleable

Indicates if the item is scaleable

# flipable

Indicates if the item is flipable

# file3dUrl

Url to 3d file for this item.

# Methods

# isConfigurable()

# similarItems()

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()

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:)