CLASS

# RoomleCatalog

Contents

  • Properties
    • id
    • name
    • branded
    • hidden
    • featuredImageUrl
    • coverUrl
    • brandIconUrl
    • categories
    • items
    • debugDescription
public class RoomleCatalog : NSObject

Representation of a catalog with all available data like name, image, categories and items. 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 catalog, it is used to query additional information via our API if needed. It is not an identifier of this object.

# name

public private(set) var name : String

Name of this catalog.

# branded

public private(set) var branded : Bool

Indicates if this catalog is branded.

# hidden

public private(set) var hidden : Bool

Indicates if this catalog is hidden. This means that your tenant is allowed to see this catalog, but it should not be visible in some sort of catalog overview.

# featuredImageUrl

public private(set) var featuredImageUrl : String?

An url to the featured image of this catalog. If value is nil, then there is no image available.

# coverUrl

public private(set) var coverUrl : String?

An url to the cover of this catalog. If value is nil, then there is no image available.

# brandIconUrl

public private(set) var brandIconUrl : String?

An url to the brand icon of this catalog. If value is nil, then there is no image available.

# categories

public private(set) var categories : [RoomleCatalogCategory]

Associated categories for this catalog.

# items

public private(set) var items : [RoomleCatalogItem]

Associated items for this catalog.

# debugDescription

public override var debugDescription: String