com.elevatix.unity.dialog v2.3.1

Elevatix Dialog

!!! Important note: Dialog is not supported for SDK version SDK v2.0.0

Elevatix Dialog is package that provides basic customizable dialog UI as reaction to recommendations from SDK

Table of contents

• Preconditions
  • Install Elevatix SDK
  • Initialize Elevatix
• Setup
  • Install Elevatix Dialog
  • Extract DialogAssets
  • Add Dialog Manager to the scene
  • Implement IEltxPriceGetter
  • Add purchases requests listener
• Additional Features
  • onOpen/onClose events
  • closeAfterPurchaseRequest param
  • Products images
  • automatic and manual show modes
  • pre-cache images remote images
  • WaitUntilIdle
  • ErrorHandling
• Complete EltxDialogManager API

Preconditions

Install Elevatix SDK

See SDK documentation about steps how to do it: https://www.npmjs.com/package/com.elevatix.unity.sdk

Initialize Elevatix

SDK could be initialized without recommendations handler - 'AnalyticsClient.OnRecommendationReady'.

All this package is about - handle SDK recommendation for the game

Setup

Install Elevatix Dialog

• Open Unity editor

• Navigate to Window -> Package Manager

• Select Elevatix Dialog and hit install

Assumption: scoped registry is configured during SDK installation.

If scoped registry isn't configured follow SDK docs to configure

Extract DialogAssets

Add Dialog Manager to the scene

Add dialog manager to the scene after "loading" stage. Note that dialog manager kept alive after scene switch

Implement IEltxPriceGetter

Interface that needs to be implemented:

    interface IEltxPriceGetter
    {
        public string GetPrice(string productId);
    }

Implementation of this interface has to be attached to the DialogManager

Add purchases requests listener

EltxDialogManager emits onPurchaseRequest event every time player hits primary(buy) button. Dialog manager invokes passed handler with Recommendation object(see structure in SDK documentation)

Additional Features

onOpen/onClose events

EltxDialogManager emits onOpen/onClose events when dialog changes its state. These events might be used to mute sound, pause the game and etc.

closeAfterPurchaseRequest param

Dialog can be closed right after user clicked on the primary(buy button with the price) button.

!Important: If this option is set to false - game needs to call eltxDialogManager.CloseDialog after successful purchase to close dialog

Products images

There are two options how product images might be loaded to the elevatix dialogs

Loaded from the server

To associate product with image - use web application to upload it

Taken from built in resources

Game should associate each product ID with some image from built in resources in the following way:

automatic and manual show modes

Modes description: When game tracks some event via elevatix SDK - certain personal offer recommendation could be provided.

When eltxDialogManager.autoShow is set to true(which is default) - dialog could be shown automatically right away after event is tracked.

When eltxDialogManager.autoShow is set to false - recommendations queued in the eltxDialogManager(after ) and shown one by one after game calls EltxDialogManager.ShowPendingOffers

pre-cache images remote images

EltxDialogManager.CacheImages - will load over the network all of the images that could be used in the PO dialogs

WaitUntilIdle

Executes coroutine after dialog(s) are closed

ErrorHandling

If error occured during purchase processing - there is a method to hide spinner and give user another chance.

Call eltxDialogManager.ToggleSpinner to hide blocking spinner.

Complete EltxDialogManager API