id.frak.sdk.rewards
| Name | Summary |
|---|---|
| BestReward | class BestReward(val formatted: String, val payoutType: String, val minPurchaseAmount: String?, val minPurchaseValue: Double?, val lockupDurationDays: Double?, val isProductScoped: Boolean, val matchedProducts: List<ProductDetails>?) The single reward worth advertising, formatted server-side. formatted contains a non-breaking space (U+00A0) before the currency symbol; render as-is, do not reformat. |
| Campaign | class Campaign(val campaignId: String, val name: String, val interactionTypeKey: String, val referrer: EstimatedReward?, val referee: EstimatedReward?, val defaultLockupSeconds: Double?, val maxRewardsPerUser: Double?, val expiresAt: String?) One active campaign. Arrives sorted by priority descending; do not re-sort. |
| EstimatedReward | sealed class EstimatedReward What a campaign pays out. Percentage has no concrete amount so it’s suppressed from display. |
| RewardAudience | enum RewardAudience : Enum<RewardAudience> Who a reward is being estimated for: sharer (REFERRER) or arriving referee (REFEREE). |
| RewardRequest | class RewardRequest What to look a reward up for. Build with Builder, or RewardRequest { } from Kotlin. |
| RewardTier | sealed class RewardTier One band of a tiered reward. Null maxValue means no upper bound (not a sentinel). |
| TokenAmount | class TokenAmount(val amount: Double, val eurAmount: Double, val usdAmount: Double, val gbpAmount: Double) A reward amount in raw token units and each fiat currency the backend prices. |
Functions
Section titled “Functions”| Name | Summary |
|---|---|
| RewardRequest | fun RewardRequest(configure: RewardRequest.Builder.() -> Unit): RewardRequest Kotlin sugar over RewardRequest.Builder. |