To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| pointsAllocationSources | List | ||
| promotionMechanicTypes | List | ||
| allRewards | List | Returns all promotions and points buckets | |
| allPromotions | List | ||
| pointsBuckets | List |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| createPromotion ( promoId, promoTitle, website, promoType ) | Reward | ||
| newPromotionBuilder ( id, title, website, promoType ) | PromotionBuilder | ||
| findPointsAllocationSource ( name ) | PointsAllocationSource | ||
| findPromotionMechanicType ( name ) | PromotionMechanicType | Find an PromotionMechanicType by name | |
| findRewardEntry ( id ) | RewardEntry | ||
| findRewardEntries ( user, promo ) | List | ||
| findPromotionsAfter ( dt ) | List | Find all promotions after the given date | |
| findPointsBucket ( id ) | Reward | ||
| findPointsBucket ( name ) | Reward | ||
| findPromotion ( name ) | Reward | ||
| findPromotionById ( id ) | Reward | ||
| promotions ( open, now ) | PromotionsList | ||
| availablePromotions ( ) | PromotionsList | ||
| availablePromotions ( now, curUser ) | PromotionsList | ||
| availablePromotions ( now, curUser, open ) | PromotionsList | ||
| isMatchingPromoCode ( code, promotion ) | boolean | ||
| isElligbleUser ( user, promotion ) | boolean | ||
| isElligbleParticipant ( participant, promotion ) | boolean | ||
| isActive ( promotion ) | boolean | The reward is active if it is between its start and finish dates, or they are empty | |
| isStarted ( promotion ) | boolean | Returns true if the promotion is active and has passed its started date. Remains true after the finish date. Equivalent to promotion.isViewable(now) | |
| promotionDetails ( reward ) | PromotionBean | ||
| numEntries ( promo ) | long | ||
| findAnswerKeys ( reward ) | List | ||
| newRewardEntryBuilder ( reward, enteredProfile ) | RewardEntryBuilder | ||
| submitEntry ( b ) | RewardEntry | ||
| findParticipants ( promo ) | Collection | ||
| participantSelectors ( promo ) | List | ||
| findParticipants ( promo, orgs ) | Collection | ||
| findRewardEntriesForUser ( reward, user ) | List | ||
| findUserAttachmentHash ( reward, user ) | String | If the current user has uploaded a file as part of entering this reward, return a hash identifying the file. This can be used with /_hashes/files/{hash} to display the file | |
| findPromotionTerm ( reward ) | String |
© 2025 Kademi Ltd