IPopupsProvider

Overview

The interface provides the ability to define your own way of loading popups (e.g. using Addresables). SDK out of the box contains ResourcesPopupsProvider class, which loads popups from Resources folder.

More information about popups here.

UnloadPopup

void UnloadPopup<TArgs>(IPopupBase<TArgs> popup)
    where TArgs : PopupArgs;

The method must be defined, because regardless of the number of supported popups, any of them must be able to be unloaded after use. The method must unload the popup that was passed as an argument popup.

LoadPopup

UniTask<IPopup<PopupArgs>> LoadPopup(string screenId, CancellationToken cancellationToken)

The method is used when processing campaigns that have CustomCreative. The method should load the creative by screenId (which comes with the creative) and return a reference to an already created popup on the stage.

LoadCreativeWithProductsPopup

UniTask<IPopupWithProducts<CreativePopup.Args>> LoadCreativeWithProductsPopup(string screenId, CancellationToken cancellationToken)

The method is used when processing campaigns that have CustomCreative but also have one or many products. The method should load the creative by screenId (which comes with the creative) and return a reference to an already created popup on the stage. The difference between this method and LoadPopup is that the popup loaded by this method must implement the IPopupWithProducts interface, thus indicating that it supports the display of products.

LoadSpinner

UniTask<IPopupBase<PopupArgs>> LoadSpinner(CancellationToken cancellationToken)

The method must load a spinner that can be used in processing some campaigns and obtaining some products.

LoadImagePopup

UniTask<IPopup<ImagePopup.Args>> LoadImagePopup(CancellationToken cancellationToken)

The method should load a popup that implements the IPopup<ImagePopup.Args> interface and return a reference to the created popup on the scene. IPopup<ImagePopup.Args> should be able to display an ImageCreative with a texture, which will be passed to the popup via ImagePopup.Args when it tries to show it.

LoadFullscreenPopup

UniTask<IPopup<ImagePopup.Args>> LoadFullscreenPopup(CancellationToken cancellationToken)

The method should load a popup that implements the IPopup<ImagePopup.Args> interface and return a reference to the created popup on the scene. IPopup<ImagePopup.Args> should be able to display an ImageCreative with a texture, which will be passed to the popup via ImagePopup.Args when it tries to show it. LoadFullscreenPopup differs from LoadImagePopup in that a popup loaded with LoadFullscreenPopup should display a full screen picture without frames, while LoadImagePopup is the opposite.

LoadRateReviewPopup

UniTask<IPopup<PopupArgs>> LoadRateReviewPopup(CancellationToken cancellationToken)

The method should load the popup to be used in Rate Review Campaign. The method should load a popup that implements the IPopup interface and return a reference to the created popup on the scene.

LoadInterPopupSplash

UniTask<IPopupBase<PopupArgs>> LoadInterPopupSplash(CancellationToken cancellationToken)

The method should load the popup to be used in Campaigns handling | Interstitial Campaign. The method should load a popup that implements the IPopupBase interface and return a reference to the created popup on the scene.

LoadErrorPopup

UniTask<IPopup<ErrorPopup.Args>> LoadErrorPopup(CancellationToken cancellationToken)

The method is not yet used inside the SDK. Will be added in future updates.