BPKRatingTextDefinition

@interface BPKRatingTextDefinition : NSObject

An object that represents the text displayed inside the rating component.

  • The text to display when the rating value is greather than or equal to 8

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull highRatingText;

    Swift

    var highRatingText: String { get set }

  • The text to display when the rating value is greather than or equal to 6 and less than 8

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull mediumRatingText;

    Swift

    var mediumRatingText: String { get set }

  • The text to display when the rating value is less than 6

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull lowRatingText;

    Swift

    var lowRatingText: String { get set }

  • Create a BPKRatingTextDefinition with the given text for the rating values.

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithHighRatingText:(nonnull NSString *)highRatingText
          mediumRatingText:(nonnull NSString *)mediumRatingText
             lowRatingText:(nonnull NSString *)lowRatingText;

    Swift

    init(highRatingText: String, mediumRatingText: String, lowRatingText: String)

    Parameters

    highRatingText

    The text used in the rating component when it has a high rating value
    mediumRatingText

    The text used in the rating component when it has a medium rating value
    lowRatingText

    The text used in the rating component when it has a low rating value

    Return Value

    BPKRatingTextDefinition instance.