Edit

Launching an Overlay Placement

The Rokt SDK for Android can be used to display an overlay placement overtop of your app’s content. These instructions assume that the Rokt SDK for Android has already been integrated into your application by following steps 1 to 4 here.

Step 5: Execute the Rokt Android SDK

Execute the SDK in your desired Activity/Fragment, passing any appropriate consumer attributes and the placement mapping. The example code uses onCreate to launch the placement

The Rokt widget view displays after a short delay, configurable via the Rokt platform. The SDK provides optional callback events for when the view loads and unloads.

Your app dictates which consumer attributes are passed through to Rokt. More information on the data fields that are able to be passed through the SDK can be found under the Attributes section. You can add additional code lines into the below sections containing consumer attributes in order to build up the data package that will be sent through to Rokt.

Kotlin

import com.rokt.roktsdk.Rokt
 
class ConfirmationActivity : Activity() {   
    override fun onCreate(savedInstanceState: Bundle?) {       
        super.onCreate(savedInstanceState)       
        ...    
 
        // Include any appropriate consumer attributes       
        val attributes = hashMapOf(               
                Pair("email", "j.smith@example.com"),
                Pair("firstname", "Jenny"),
                Pair("lastname", "Smith"),
                Pair("mobile", "(323) 867-5309"),
                Pair("postcode", "90210"),
                Pair("country", "US"))
 
        Rokt.execute("RoktExperience",               
            attributes,               
            object : Rokt.RoktCallback {                   
                override fun onUnload(reason: Rokt.UnloadReasons) {                               
                }                   
                override fun onLoad() {                            
                }                   
                override fun onShouldHideLoadingIndicator() {                          
                }                   
                override fun onShouldShowLoadingIndicator() {                       
                }               
            }       
        )  
        ...
    }    

Java

import com.rokt.roktsdk.Rokt;
 
class ConfirmationActivity : Activity() {   
    override fun onCreate(savedInstanceState: Bundle?) {       
        super.onCreate(savedInstanceState)       
        ...     
 
        Map<String,String> attributes = new HashMap<String, String>();
 
        attributes.put("email", "j.smith@example.com");
        attributes.put("firstname", "Jenny");
        attributes.put("lastname", "Smith");
        attributes.put("mobile", "(323) 867-5309");
        attributes.put("postcode", "90210");
        attributes.put("country", "US");
 
        Rokt.INSTANCE.execute("RoktExperience",               
            attributes,               
            new Rokt.RoktCallback() {
                @Override
                public void onLoad() {
                }
                @Override
                public void onUnload(Rokt.UnloadReasons unloadReasons) {
                }
                @Override
                public void onShouldHideLoadingIndicator() {
                }
                @Override
                public void onShouldShowLoadingIndicator() {
                }
            }      
        )  
        ...
    }
}

Step 6: Build & Run