WrappingPaperCategory

@interface WrappingPaperCategory : NSObject

WrappingPaperCategory is the model for representing a collection of like WrappingPapers.

  • A list of WrappingPapers for this category.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
    NSArray<WrappingPaperMedia *> *wrappingPapers;

    Swift

    var wrappingPapers: [WrappingPaperMedia]? { get set }

  • A list of images that can be turned into WrappingPapers if selected.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
    NSArray<ImageMedia *> *imageResults;

    Swift

    var imageResults: [ImageMedia]? { get set }

  • A title for the category that will be shown at the top of the WrappingViewController.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSString *title;

    Swift

    var title: String? { get }

  • The text that is searched on google if no WrappingPapers are provided.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSString *searchText;

    Swift

    var searchText: String? { get }

  • The carousel image that is shown in the carousel of the WrappingViewController.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSString *imageUrl;

    Swift

    var imageUrl: String? { get }

  • A round version of the carousel image that is shown in the carousel of the WrappingViewController.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSString *roundImageUrl;

    Swift

    var roundImageUrl: String? { get }

  • The type of WrappingPaperCategory.

    Declaration

    Objective-C

    @property (readonly, nonatomic) WrappingPaperCategoryType type;

    Swift

    var type: WrappingPaperCategoryType { get }

  • The order this category should show up in the WrappingViewController.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSInteger order;

    Swift

    var order: Int { get }

  • An internal referenceId to associated WrappingPapers.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nullable) NSString *categoryId;

    Swift

    var categoryId: String? { get }

  • Default Initializer for a WrappingPaperCategory from a dictionary from the server.

    Declaration

    Objective-C

    + (nonnull instancetype)wrappingPaperCategoryFromDictionary:
    (nonnull NSDictionary *)dictionary;

    Swift

    convenience init(from dictionary: [AnyHashable : Any])

    Parameters

    dictionary

    - The dictionary form of the WrappingPaperCategory.

    Return Value

    Instance of WrappingPaperCategory.

  • Converts a WrappingPaperCategory to an NSDictionary that can be used for caching or sending to the server.

    Declaration

    Objective-C

    - (nonnull NSDictionary *)dictionaryRepresentation;

    Swift

    func dictionaryRepresentation() -> [AnyHashable : Any]

    Return Value

    dictionary - Dictionary form of a WrappingPaperCategory.

  • Returns the ImageMedia or WrappingPaper (whichever is set) at the provided index. If the index is out of bounds, nil will be returned.

    Declaration

    Objective-C

    - (nonnull id)getObjectAtIndex:(NSInteger)index;

    Swift

    func getObjectAt(_ index: Int) -> Any

    Parameters

    index

    - The index of the imageResult / wrappingPaper.

    Return Value

    an ImageMedia or WrappingPaper at the provided index.