LimitedTimeOfferBase

Overview

The main purpose of this class is to provide a simple and basic format for working with offers. Based on it you can write your own implementations, or inherit from this class and extend its logic.

To start working with this class you can create your own inheritor, or use a LimitedTimeOffer class. Then you must add this script to your game object and configure serializable fields. The SDK itself does not create instances with this component when adding offers, so you must either add them manually or with code. Once the object has been configured and Awake called for it, this class will independently follow changes in the state of the offer and update its content.

The following will often use the word view, in this context it represents the visual of the offer. At the moment, depending on the LTO configuration, it can be texture or asset bundle.

Serialize fields

_content

[SerializeField] private GameObject _content;

Store a reference to all of the content of the offer. This object will be activated at the time of configuring the offer if there is an available view.

_ltoContainer

[SerializeField] private Transform _ltoContainer;

Store a reference to the parent object in which the view will be placed.

_offerSpot

[SerializeField] private string _offerSpot;

Must store the name of the spot which this offer is using.

_title

[SerializeField] private TextMeshProUGUI _title;

Stores a reference to where you the title or timer of this offer might be set.

_button

[SerializeField] private Button _button;

A button that will be used to track player interaction with the offer when clicked OnButtonClick will be called.

Properties

Offer

LtoInfo Offer { get; }

Provides access to the current LtoInfo instance. With this you can access all main information about the current offer.

IsDefaultView

protected bool IsDefaultView { get; }

Reflects whether the default view for the current LTO has been used.

OfferSpot

string OfferSpot { get; protected set; }

Provides access to the current _offerSpot value.

OfferTimeLeft

TimeSpan OfferTimeLeft { get; }

Reflects the amount of time left before the offer expires.

Unity lifecycle

Awake

protected virtual void Awake()

By default, this method calls the initialization of the offer. When overriding this method, you should call base.Awake() to initialize correctly.

OnDestroy

protected virtual void OnDestroy()

This method frees data from RAM by default, and unsubscribes from SDK calbacks. When overriding this method, you should call base.OnDestroy() to cleanup correctly.

Update

protected virtual void Update()

By default, the current LTO state is processed and updated in this method. The LTO text and timer will be updated here, and the view may also be updated. When overriding this method, you can call base.Update() if you need.

Methods

CanUpdateDefaultView

protected virtual bool CanUpdateDefaultView()

This method should return true if it is possible to update the default view to some other view at this point in time. By default, this method always returns false. This method makes sense only if the default view was used during initialization of the offer and then some other view value became available during the application and you want to replace it.

OnButtonClick

protected abstract void OnButtonClick()

This method is called when _button was clicked.

GetFormattedTitle

protected virtual string GetFormattedTitle()

The method returns the title of the given offer. By default it returns Offer.BadgeCreative.LabelText.

GetFormattedTimer

protected virtual string GetFormattedTimer()

The method returns the timer of the given offer. By default it uses formatted OfferTimeLeft with format hours:minutes:seconds.

OfferAdded

protected virtual void OfferAdded(LtoInfo ltoInfo)

This method is called when SDK notifies that an offer with such a OfferSpot has been started/added. By default, this method calls the setup of the current offer, which includes setting the view, title, timer, and other details.

OfferUpdated

protected virtual void OfferUpdated(LtoInfo ltoInfo)

This method is called when SDK notifies that an offer with such a OfferSpot has been updated. By default, this method updates all values that may have changed, the work done is similar to calling OfferAdded.

OfferRemoved

protected virtual void OfferRemoved(LtoInfo ltoInfo)

This method is called when SDK notifies that an offer with such a OfferSpot has been removed. This method causes the data of the offer to be cleaned using the CleanUp.

CleanUp

protected virtual void CleanUp()

This method should clean up all data after an offer is finished, such as when it is finished or removed.