# Campaign

class Campaign(val campaignId: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), val name: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), val interactionTypeKey: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), val referrer: [EstimatedReward](/developers/references/android/id-frak-sdk-rewards/estimatedreward/)?, val referee: [EstimatedReward](/developers/references/android/id-frak-sdk-rewards/estimatedreward/)?, val defaultLockupSeconds: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?, val maxRewardsPerUser: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?, val expiresAt: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?)

One active campaign. Arrives sorted by priority descending; do not re-sort.

## Constructors

| | |
|---|---|
| [Campaign](/developers/references/android/id-frak-sdk-rewards/campaign/campaign/) | constructor(campaignId: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), name: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), interactionTypeKey: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), referrer: [EstimatedReward](/developers/references/android/id-frak-sdk-rewards/estimatedreward/)?, referee: [EstimatedReward](/developers/references/android/id-frak-sdk-rewards/estimatedreward/)?, defaultLockupSeconds: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?, maxRewardsPerUser: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?, expiresAt: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?) |

## Properties

| Name | Summary |
|---|---|
| [campaignId](/developers/references/android/id-frak-sdk-rewards/campaign/campaignid/) | val [campaignId](/developers/references/android/id-frak-sdk-rewards/campaign/campaignid/): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) |
| [defaultLockupSeconds](/developers/references/android/id-frak-sdk-rewards/campaign/defaultlockupseconds/) | val [defaultLockupSeconds](/developers/references/android/id-frak-sdk-rewards/campaign/defaultlockupseconds/): [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)?<br>Whole days a reward is locked before it can be claimed, when configured. |
| [expiresAt](/developers/references/android/id-frak-sdk-rewards/campaign/expiresat/) | val [expiresAt](/developers/references/android/id-frak-sdk-rewards/campaign/expiresat/): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?<br>ISO-8601 expiry, or null for a campaign that never expires. |
| [interactionTypeKey](/developers/references/android/id-frak-sdk-rewards/campaign/interactiontypekey/) | val [interactionTypeKey](/developers/references/android/id-frak-sdk-rewards/campaign/interactiontypekey/): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)<br>The interaction that triggers this campaign, e.g. `purchase`. Open on the wire. |
| [maxRewardsPerUser](/developers/references/android/id-frak-sdk-rewards/campaign/maxrewardsperuser/) | val [maxRewardsPerUser](/developers/references/android/id-frak-sdk-rewards/campaign/maxrewardsperuser/): [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)? |
| [name](/developers/references/android/id-frak-sdk-rewards/campaign/name/) | val [name](/developers/references/android/id-frak-sdk-rewards/campaign/name/): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) |
| [referee](/developers/references/android/id-frak-sdk-rewards/campaign/referee/) | val [referee](/developers/references/android/id-frak-sdk-rewards/campaign/referee/): [EstimatedReward](/developers/references/android/id-frak-sdk-rewards/estimatedreward/)?<br>What the person arriving through the link earns. |
| [referrer](/developers/references/android/id-frak-sdk-rewards/campaign/referrer/) | val [referrer](/developers/references/android/id-frak-sdk-rewards/campaign/referrer/): [EstimatedReward](/developers/references/android/id-frak-sdk-rewards/estimatedreward/)?<br>What the sharer earns. Absent when the campaign rewards only the referee. |

## Functions

| Name | Summary |
|---|---|
| equals | open operator override fun equals(other: [Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) |
| hashCode | open override fun hashCode(): [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) |
| toString | open override fun toString(): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) |