WrappingPaperMedia

@interface WrappingPaperMedia : ImageMedia

A WrappingPaperMedia contains the data to show a wrapping on an EnvelopeView.

  • The primary ribbon color that wraps around the WrappingPaperMedia.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable)
    NSString *wrappingRibbonColorHex;

    Swift

    var wrappingRibbonColorHex: String? { get set }

  • The secondary ribbon color that wraps around the WrappingPaperMedia.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable)
    NSString *wrappingRibbonColorHex2;

    Swift

    var wrappingRibbonColorHex2: String? { get set }

  • Internal id used to map WrappingPaperMedia‘s to their WrappingPaperCategory.

    Declaration

    Objective-C

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

    Swift

    var categoryId: String? { get }

  • The search text that is searched with Google Images for a WrappingPaperMedia.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable) NSString *searchText;

    Swift

    var searchText: String? { get set }

  • Default initializer for a WrappingPaperMedia.

    Declaration

    Objective-C

    + (nonnull WrappingPaperMedia *)wrappingPaperMediaFromDictionary:
    (nonnull NSDictionary *)dictionary;

    Swift

    /*not inherited*/ init(from dictionary: [AnyHashable : Any])

    Parameters

    dictionary

    - the dictionary of properties of a WrappingPaperMedia.

    Return Value

    Instance of WrappingPaperMedia.

  • Declaration

    Objective-C

    + (nonnull WrappingPaperMedia *)defaultWrappingPaperMedia;

    Swift

    class func `default`() -> WrappingPaperMedia

    Return Value

    a WrappingPaperMedia with imageData from default_wrapping_paper.png.

  • Converts a WrappingPaperMedia 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 WrappingPaperMedia.