Interface IPromoData
Contains the IEntityData associated with a certain IPromo.
Namespace: IdleKit.Gameplay
Assembly: cs.temp.dll.dll
Syntax
public interface IPromoData : IEntityData, ISavedDataProvider, IData, IPurchasableProperties
ABResourceKey
A key to the object inside the A/B testing resource, which is associated with this promo.
Declaration
string ABResourceKey { get; }Property Value
| Type | Description |
|---|---|
| String |
ABResourceUID
A resource ID used in the campaign to A/B test this promo.
Declaration
string ABResourceUID { get; }Property Value
| Type | Description |
|---|---|
| String |
ABResourceValue
The value of the object inside the A/B testing resource that this promo expects to become active.
Declaration
string ABResourceValue { get; }Property Value
| Type | Description |
|---|---|
| String |
Description
A description for the associated IPromo.
Declaration
string Description { get; }Property Value
| Type | Description |
|---|---|
| String |
DescriptionLocalizationString
A localization string for the description of the associated IPromo.
Declaration
string DescriptionLocalizationString { get; }Property Value
| Type | Description |
|---|---|
| String |
DollarValue
A dollar value for the associated IPromo.
Declaration
double DollarValue { get; }Property Value
| Type | Description |
|---|---|
| Double |
Duration
The duration in milliseconds that the promo should be activated for, beginning when the promo becomes ready (all triggers completed).
Declaration
long Duration { get; }Property Value
| Type | Description |
|---|---|
| Int64 |
Enabled
Whether or not the associated IPromo is enabled. If this is 'false' the IPromo will never be activated unless ForceShow is true.
Declaration
bool Enabled { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
EndDate
The date the associated IPromo should become inactive.
Declaration
DateTime EndDate { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
ForceShow
Declaration
bool ForceShow { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
HeroImageUrl
A url for the hero image to be used in the presentation of this IPromo.
Declaration
string HeroImageUrl { get; }Property Value
| Type | Description |
|---|---|
| String |
Location
Where the associated IPromo should appear. For example, 'store' or 'homescreen'.
Declaration
string Location { get; }Property Value
| Type | Description |
|---|---|
| String |
MaxStage
The last stage the associated IPromo should be active (inclusive).
Declaration
int MaxStage { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
MinStage
The first stage that the associated IPromo should become active.
Declaration
int MinStage { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Platform
The platform the associated IPromo is meant for. For example, android or ios.
Declaration
string Platform { get; }Property Value
| Type | Description |
|---|---|
| String |
PopupColorHex
A hex color value to theme the associated IPromo.
Declaration
string PopupColorHex { get; }Property Value
| Type | Description |
|---|---|
| String |
StartDate
The date the associated IPromo should become active.
Declaration
DateTime StartDate { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
Title
The title of the associated IPromo
Declaration
string Title { get; }Property Value
| Type | Description |
|---|---|
| String |
TitleLocalizationString
A localization string for the title of the associated IPromo.
Declaration
string TitleLocalizationString { get; }Property Value
| Type | Description |
|---|---|
| String |
TriggerIds
The IDs for the ITrigger that the associated IPromo require to become ready. If this list is left empty the promo is considered ready when it becomes active.
Declaration
string[] TriggerIds { get; }Property Value
| Type | Description |
|---|---|
| String[] |