Fluent builder for creating a recognition badge, extending the common recognition properties defined on AbstractRecognitionBuilder. Obtained from RecognitionManager.newBadgeBuilder, which binds it to the topic the badge belongs to. Chain the property methods to configure the badge, then call build to create and save it.

Group: Builders

Extends: AbstractRecognitionBuilder


Inherited from AbstractRecognitionBuilder

Methods

title(String s) · imageHash(String s) · colour(String s) · assetId(String s) · field1(String s) · field2(String s) · field3(String s) · pointsBucket(Reward s) · numPoints(Double s) · pointsTag(PointsTag pt) · pointsReason(String pointsReason) · pointsRuleTypeId(String s) · pointsRuleConfig(String s)

title(String s)

Returns: AbstractRecognitionBuilder

Sets the display title for the recognition being built.

ParameterDescription
sthe display title

imageHash(String s)

Returns: AbstractRecognitionBuilder

Sets the image hash for the recognition being built.

ParameterDescription
sthe image hash

colour(String s)

Returns: AbstractRecognitionBuilder

Sets the display colour for the recognition being built.

ParameterDescription
sthe colour

assetId(String s)

Returns: AbstractRecognitionBuilder

Sets the content asset id for the recognition being built.

ParameterDescription
sthe asset id

field1(String s)

Returns: AbstractRecognitionBuilder

Sets the free-form field1 value for the recognition being built.

ParameterDescription
sthe field1 value

field2(String s)

Returns: AbstractRecognitionBuilder

Sets the free-form field2 value for the recognition being built.

ParameterDescription
sthe field2 value

field3(String s)

Returns: AbstractRecognitionBuilder

Sets the free-form field3 value for the recognition being built.

ParameterDescription
sthe field3 value

pointsBucket(Reward s)

Returns: AbstractRecognitionBuilder

Sets the points bucket (reward) that points are credited to or debited from for the recognition being built.

ParameterDescription
sthe points bucket

numPoints(Double s)

Returns: AbstractRecognitionBuilder

Sets the fixed number of points awarded for the recognition being built, used when no points rule type is configured.

ParameterDescription
sthe number of points

pointsTag(PointsTag pt)

Returns: AbstractRecognitionBuilder

Sets the points tag recorded against points awarded for the recognition being built.

ParameterDescription
ptthe points tag

pointsReason(String pointsReason)

Returns: AbstractRecognitionBuilder

Sets the reason text recorded against points awarded for the recognition being built.

ParameterDescription
pointsReasonthe points reason

pointsRuleTypeId(String s)

Returns: AbstractRecognitionBuilder

Sets the id of the points rule type used to calculate points for the recognition being built, instead of a fixed amount.

ParameterDescription
sthe points rule type id

pointsRuleConfig(String s)

Returns: AbstractRecognitionBuilder

Sets the XML configuration for the points rule type set on the recognition being built.

ParameterDescription
sthe points rule configuration, as XML

Methods

build()

Returns: RecognitionBadge

Creates and saves the badge with the properties configured on this builder, under the topic the builder was created for.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.