Skip to content

RewardsApi

class RewardsApi

Campaigns and reward selection. Obtained from FrakClient.rewards.

NameSummary
bestsuspend fun best(request: RewardRequest): BestReward?
Reward worth advertising, formatted server-side; null when nothing matches.
suspend fun best(request: RewardRequest, forceRefresh: Boolean): BestReward?
bestAsyncfun bestAsync(request: RewardRequest): CompletableFuture<BestReward?>
fun bestAsync(request: RewardRequest, forceRefresh: Boolean): CompletableFuture<BestReward?>
best for Java.
campaignssuspend fun campaigns(): List<Campaign>
Active campaigns for this merchant, highest priority first.
suspend fun campaigns(forceRefresh: Boolean): List<Campaign>
campaignsAsyncfun campaignsAsync(): CompletableFuture<List<Campaign>>
fun campaignsAsync(forceRefresh: Boolean): CompletableFuture<List<Campaign>>
campaigns for Java.