com.medallia.digital.mobilesdk

Class MedalliaDigital

java.lang.Object

com.medallia.digital.mobilesdk.MedalliaDigital

public class MedalliaDigital
extends java.lang.Object

MedalliaDigital is the main component for the Medallia sdk.
It includes the complete set of tools required in order to work with Medallia sdk.

Calling init(Application, String, MDResultCallback) is mandatory before accessing any other method in this API.

Constructor Summary

Constructors

Constructor and Description
MedalliaDigital()

Method Summary

Modifier and Type	Method and Description
static void	closeEngagement(MDResultCallback listener) Close Engagement API will close sdk engagement if it's open.
static void	customInterceptTrigger(java.lang.String engagementId, MDInterceptActionType actionType, MDFailureCallback listener) Setting a callback in order to update the sdk of action type trigger by the app.
static void	disableIntercept() Permits app developers to suppress/disable feedback intercepts (and their respective targeting) from being prompted to the user, usually called in critical flows.
static void	enableIntercept() Permits app developers to suppress/disable feedback intercepts (and their respective targeting) from being prompted to the user, usually called in critical flows.
static MDCustomFormData	getCustomFormData(java.lang.String formId) Get Custom Form data by Form ID.
static void	handleNotification(java.lang.String formId, MDResultCallback listener) Enables the app to launch forms directly from push notifications.
static void	init(Application application, java.lang.String token, MDResultCallback listener) This method initializes the SDK and by doing so authenticates the app, and retrieves configuration elements from Medallia Digital.
static void	revertStopSDK() Revert Stop SDK API will revive the SDK functionality (if it is stopped).
static void	setActivity(Activity activity) Set hosting app current activity (for hybrid frameworks).
static void	setCustomAppearance(MDAppearanceMode appearance) Set custom appearance for native components multi-themes support (if feature is enabled for this property)
static void	setCustomFormListener(MDCustomFormListener customFormListener) Setting a callback in order to receive custom form information.
static void	setCustomInterceptListener(MDCustomInterceptListener customInterceptListener) Setting a callback in order to update the hosted app when custom intercept is ready to be shown.
static void	setCustomParameter(java.lang.String name, java.lang.Object value) The SDK enables the app to set custom parameters of several types.
static void	setCustomParameters(java.util.HashMap<java.lang.String,java.lang.Object> customParameters) The SDK enables the app to set custom parameters of several types.
static void	setDebugForm(boolean debug) Set the SDK to download a debug form.
static void	setFeedbackListener(MDFeedbackListener feedbackListener) Setting a callback in order to receive feedback payload.
static void	setFormListener(MDFormListener formListener) Setting a callback in order to receive form displayed information.
static void	setInterceptListener(MDInterceptListener interceptListener) Setting a callback in order to receive intercept information (an intercept can be androidx.appcompat.app.AlertDialog or Banner displayed asking the user whether he/she wants to open form/app rating/ any other engagement type object)
static void	setLogLevel(MDLogLevel logLevel) This API method allows the hosting app to see the SDK logs in the console.
static void	setSdkFramework(MDSdkFrameworkType mdSdkFrameworkType) Set hosting app framework (for hybrid frameworks).
static void	setUserId(java.lang.String userId) Set User ID From version 4.1.0 forward the SDK will support the use of customer identifiers on survey forms.
static void	showForm(java.lang.String formId, MDResultCallback listener) Displaying a form on demand, usually a "Feedback" button in app menu.
static void	stopSDK(boolean clearData) Stop SDK API will stop the SDK functionality.
static void	updateCustomLocale(java.lang.String locale, MDCallback listener) Set custom locale for form multi-language support (if feature is enabled for this property)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MedalliaDigital

public MedalliaDigital()

Method Detail

init

public static void init(Application application,
                        java.lang.String token,
                        MDResultCallback listener)

This method initializes the SDK and by doing so authenticates the app, and retrieves configuration elements from Medallia Digital.
This method is mandatory in order to start Medallia SDK
All the following vars are mandatory for init to run.

Parameters:

application - your Application

token - Medallia Digital developer token (can be found in the account section of your Medallia Digital dashboard). Note that this key is assigned per application.

listener - listen to important events reported by the Medallia Digital mobile SDK during the initialization phase.

setActivity

public static void setActivity(Activity activity)

Set hosting app current activity (for hybrid frameworks).
This method is not mandatory
Calling this methods only if you are using Cordova/React-native plugin

Parameters:

activity - Activity

setUserId

public static void setUserId(java.lang.String userId)

Set User ID From version 4.1.0 forward the SDK will support the use of customer identifiers on survey forms. This will be implemented via an API (call api to add customer id). This is a shared field to identify individual users across the Medallia instance so that we have a picture of what interactions this individual has had e.g. Email, Digital.

Parameters:

userId - customer identifier

setDebugForm

public static void setDebugForm(boolean debug)

Set the SDK to download a debug form.
This method is only for debugging not for production
This method is not mandatory

Parameters:

debug - Boolean

setSdkFramework

public static void setSdkFramework(MDSdkFrameworkType mdSdkFrameworkType)

Set hosting app framework (for hybrid frameworks).
This method is not mandatory
Calling this methods only if you are using Cordova/React-native plugin

Parameters:

mdSdkFrameworkType - MDSdkFrameworkType

setCustomParameter

public static void setCustomParameter(java.lang.String name,
                                      java.lang.Object value)

The SDK enables the app to set custom parameters of several types. Define specific parameter to add to the submitted feedback and targeting. * If the name specified already exists, it will be overridden.

Parameters:

name - custom parameter name

value - custom parameter value
The SDK supports the following types: String, Integer(or int), Long(or long), Double(or double), Float(or float), Boolean(or bool)
In case the value is not one of these primitive types, custom parameter won't be saved.
value can't be null.

setCustomParameters

public static void setCustomParameters(java.util.HashMap<java.lang.String,java.lang.Object> customParameters)

The SDK enables the app to set custom parameters of several types. Define multiple parameters to add to the submitted feedback and targeting. * If the name specified already exists, it will be overridden.

Parameters:

customParameters - map of 'name'(of type String) and 'value'(of a primitive type).
For more information, go to : setCustomParameter(String, Object)

showForm

public static void showForm(java.lang.String formId,
                            MDResultCallback listener)

Displaying a form on demand, usually a "Feedback" button in app menu. The SDK must be initialized for form to be displayed. The 'ShowForm' API can be called in parallel with the init API.

Parameters:

formId - form id to determine which form should be shown.

listener - success or failure in showing a form.

handleNotification

public static void handleNotification(java.lang.String formId,
                                      MDResultCallback listener)

Enables the app to launch forms directly from push notifications. Using this API, forms are properly opened once the pushed notification is selected.

Parameters:

formId - form id to determine which form should be shown.

listener - success or failure in showing a form.

setFormListener

public static void setFormListener(MDFormListener formListener)

Setting a callback in order to receive form displayed information. This API method allows listening to form related events, e.g. form was submitted.

Parameters:

formListener - MDFormListener

setCustomFormListener

public static void setCustomFormListener(MDCustomFormListener customFormListener)

Setting a callback in order to receive custom form information. This API method allows listening to custom form related events.

Parameters:

customFormListener - MDCustomFormListener

getCustomFormData

public static MDCustomFormData getCustomFormData(java.lang.String formId)

Get Custom Form data by Form ID.

Parameters:

formId - The requested form ID

Returns:

The requested Form data. If not available, null will be returned.

setFeedbackListener

public static void setFeedbackListener(MDFeedbackListener feedbackListener)

Setting a callback in order to receive feedback payload. This API method allows listening to in-form feedback content submitted by user.

Parameters:

feedbackListener - MDFeedbackListener

customInterceptTrigger

public static void customInterceptTrigger(java.lang.String engagementId,
                                          MDInterceptActionType actionType,
                                          MDFailureCallback listener)

Setting a callback in order to update the sdk of action type trigger by the app. Using this API, forms are properly opened once the accept/skip action type selected.

Parameters:

engagementId - engagementId id to determine which form should be shown.

actionType - action type that selected in the hosted app. MDInterceptActionType

listener - failure in showing a form. MDFailureCallback

setCustomInterceptListener

public static void setCustomInterceptListener(MDCustomInterceptListener customInterceptListener)

Setting a callback in order to update the hosted app when custom intercept is ready to be shown.

Parameters:

customInterceptListener - MDCustomInterceptListener

enableIntercept

public static void enableIntercept()

Permits app developers to suppress/disable feedback intercepts (and their respective targeting) from being prompted to the user, usually called in critical flows.
This method is always bundled together with disableIntercept() as one method disables the intercept and the other re-enables it.
* This API will not effect showForm API functionality.
Customers may consider using this functionality during critical flows such as payment, live support chats, phone calls etc.
Intercept is enabled by default.
When called, these operations store the values in the application memory i.e. the setting remains available as long as the application is alive.
Important note - this API will not affect the showForm functionality

disableIntercept

public static void disableIntercept()

Permits app developers to suppress/disable feedback intercepts (and their respective targeting) from being prompted to the user, usually called in critical flows.
This method is always bundled together with enableIntercept() as one method disables the intercept and the other re-enables it.
* This API will not effect showForm API functionality.
For resuming intercept functionality, go to enableIntercept()
Upon every new init(Application, String, MDResultCallback), the intercept mechanism will be enabled(ergo - enabled by default).

setLogLevel

public static void setLogLevel(MDLogLevel logLevel)

This API method allows the hosting app to see the SDK logs in the console.
The log level can be set to: off, fatal, error, warn, info, debug.

Parameters:

logLevel - MDLogLevel

THIS METHOD IS ONLY TO BE USED DURING APP INTEGRATION STAGES. IT IS FORBIDDEN TO LAUNCH APP WITH THIS METHOD INTEGRATED!

Since:

v3.2.0

setInterceptListener

public static void setInterceptListener(MDInterceptListener interceptListener)

Setting a callback in order to receive intercept information (an intercept can be androidx.appcompat.app.AlertDialog or Banner displayed asking the user whether he/she wants to open form/app rating/ any other engagement type object)

Parameters:

interceptListener - MDInterceptListener

stopSDK

public static void stopSDK(boolean clearData)

Stop SDK API will stop the SDK functionality. In case the API is been called with #clearData parameter true, personalized SDK data will be cleared.

Parameters:

clearData - boolean - clear data determines if the personalized data should be cleared in addition to stopping the SDK

Since:

v3.3.0

revertStopSDK

public static void revertStopSDK()

Revert Stop SDK API will revive the SDK functionality (if it is stopped). In the next session the SDK functionality will start working as expected.

Since:

v3.3.0

updateCustomLocale

public static void updateCustomLocale(java.lang.String locale,
                                      MDCallback listener)

Set custom locale for form multi-language support (if feature is enabled for this property)

Parameters:

locale - String Custom locale with format of - XX-XX, XX, XX_XX, XX-XXX, XX_XXX, XXX, XXX-XX, XXX_XX, XXX-XXX, XXX_XXX

listener - MDCallback

Since:

v3.5.0

setCustomAppearance

public static void setCustomAppearance(MDAppearanceMode appearance)

Set custom appearance for native components multi-themes support (if feature is enabled for this property)

Parameters:

appearance - String Custom appearance

closeEngagement

public static void closeEngagement(MDResultCallback listener)

Close Engagement API will close sdk engagement if it's open.

Since:

v4.0.0