MXOAction

Actions are the objects, or containers, that hold the messages, marketing content, agent scripts, app alerts, and so on that you want to present to visitors to customers to your Touchpoints. Actions are the things that MXO does in order to affect the customer's experience. MXO provides both online and offline Actions.

import com.medallia.mxo.interactions.MXOAsset;
import com.medallia.mxo.interactions.MXOProposition;

public class MXOAction {
    	private String name;
    	private MXOAsset asset;
    	private MXOProposition proposition;

	public MXOAction(String name, MXOAsset asset, MXOProposition proposition) {
		this.name = name;
		this.asset = asset;
		this.proposition = proposition;
	}
}

MXOAsset

Assets are the content, or bundles of content, that are delivered to the customer via an MXO Action. Assets can be graphics, HTML files, XML, text, or external Assets that are available for display.

import com.medallia.mxo.interactions.MXOAssetResponse;
import com.medallia.mxo.interactions.MXOMimeType;
import java.net.URI;

public class MXOAsset {
    	private String markup;
    	private Set<MXOAssetResponse> response;
    	private MXOMimeType mimeType;
	private URI contentUrl;

	public MXOAsset(String markup, Set<MXOAssetResponse> response, MXOMimeType mimeType, URI contentUri) {
		this.markup = markup;
		this.response = response;
		this.mimeType = mimeType;
		this.contentUrl = contentUrl;
	}
}

MXOAssetResponse

MXO Asset response for tracking.

import com.medallia.mxo.interactions.MXOAssetResponseCode;
import com.medallia.mxo.interactions.MXOAssetResponseSentiment;
import com.medallia.mxo.interactions.MXOAssetResponseLabel;
import com.medallia.mxo.interactions.MXOAssetResponseTarget;
import java.net.URI;

public class MXOAssetResponse {
    	private MXOResponseCode code;
    	private MXOAssetResponseSentiment sentiment;
    	private MXOAssetResponseLabel label;
	private URI imageUrl;
	private URI targetUrl;
	private MXOAssetResponseTarget target;

	public MXOAsset(MXOResponseCode code, MXOAssetResponseSentiment sentiment, MXOAssetResponseLabel label, URI imageUrl, URI targetUrl, MXOAssetResponseTarget target) {
		this.code = code;
		this.label = label;
		this.imageUrl = imageUrl;
		this.targetUrl = targetUrl;
		this.target = target;
	}
}

MXOAssetResponseLabel

Optional Label to display for an asset response.

public class MXOAssetResponseLabel {
    	private String value;
    	
	public MXOAssetResponseLabel(String label) {
		this.label = label;
	}
}

MXOAssetResponseSentiment

This is how a user responded to an MXO Asset response.

public enum MXOAssetResponseSentiment {
	POSITIVE, 
	NEUTRAL, 
	NEGATIVE, 
	UNKNOWN,
}

MXOAssetResponseTarget

The location of an MXO Asset response.

public enum MXOAssetResponseTarget {
    	IN_APP, 
	EXTERNAL, 
	CONTEXT, 
	UNKNOWN,
}

MXOCaptureActivityPoint

Capture user Activity when they interact with an MXO Interaction.

public class MXOCaptureActivityPoint {
    	private String id;
	private String path;
    	
	public MXOCaptureActivityPoint(String id, String path) {
		this.id = id;
		this.path = path;
	}
}

MXOCaptureAttributePoint

Capture user Attribute when they interact with an MXO Interaction.

import com.medallia.mxo.interactions.MXOCaptureElementType;
import com.medallia.mxo.interactions.MXOCaptureType;
import com.medallia.mxo.interactions.MXOCapturePhase;

public class MXOCaptureAttributePoint {
    	private String id;
    	private String path;
    	private MXOCaptureElementType elementType;
	private String elementName;
	private String elementAttributeName;
	private Int captureDelay;
	private MXOCaptureType captureType;
	private MXOCapturePhase capturePhase;

	public MXOCaptureAttributePoint(String id, String path, MXOCaptureElementType elementType, String elementName, String elementAttributeName, Int captureDelay, MXOCaptureType captureType, MXOCapturePhase capturePhase) {
		this.id = id;
		this.path = path;
		this.elementType = elementType;
		this.elementName = elementName;
		this.elementAttributeName = elementAttributeName;
		this.captureDelay = captureDelay;
		this.captureType = captureType;
		this.capturePhase = capturePhase;
	}
}

MXOCaptureElementType

The type of an element.

public enum MXOCaptureElementType {
    	TEXT_FIELD,
    	CHECKBOX_RADIO,
    	DISPLAY_ELEM,
    	DROP_DOWN,
}

MXOCapturePhase

The phase in which to capture an Attribute.

public enum MXOCapturePhase {
    	LOAD,
	ON_CLICK,
    	PARAMETER,
}

MXOCaptureType

The type of value to capture from an element.

public enum MXOCaptureType {
    	ATTRIBUTE,
    	TEXT,
    	VALUE,
    	COOKIE,
}

MXOInteraction

Interactions are the key elements of the customer experience, representing the ongoing conversation between your customer and your organization at any of your Touchpoints. Interaction Points let you to capture customer Activity, capture customer input, and return optimized content to your customer during those interactions.

In a mobile app, an Interaction Point represents an individual screen or context.

import java.net.URI;

public class MXOInteraction {
	private URI value;

	public MXOInteraction(URI value) {
		this.value = value;
	}
}

MXOInteractionRequest

The Interaction request object for sending interaction data from the MXO SDK.

import com.medallia.mxo.interactions.MXOInteraction

public class MXOInteractionRequest {
    	private MXOInteraction interaction;
    	private Map<String, String> properties;

    	public MXOInteractionRequest(MXOInteraction interaction, Map<String, String> properties) {
        	this.interaction = interaction;
        	this.properties = properties;
    	}
}

Create an instance using the Builder as shown below:

final MXOIntractionRequest request = new MXOIntractionRequest.Builder()
	.interaction(URI.create("/yourInteractionPath"))
	.properties(yourProperties)
	.build()

MXOInteractionResponse

MXO Interaction response data.

import com.medallia.mxo.interactions.MXOInteraction;
import com.medallia.mxo.interactions.MXOOptimizationPoint;
import com.medallia.mxo.interactions.MXOCaptureActivityPoint;
import com.medallia.mxo.interactions.MXOCaptureAttributePoint;

public class MXOInteractionResponse {
    	private MXOInteraction interaction;
    	private String tid;
	private Boolean isSuccess;
	private Set<MXOOptimizationPoint> optimizationPoints;
	private Set<MXOCaptureActivityPoint> captureActivityPoints;
	private Set<MXOCaptureAttributePoint> captureAttributePoints;

    	public MXOInteractionResponse(MXOInteraction interaction, String tid, Boolean isSuccess, Set<MXOOptimizationPoint> optimizationPoints, Set<MXOCaptureActivityPoint> captureActivityPoints, Set<MXOCaptureAttributePoint> captureAttributePoints) {
        	this.interaction = interaction;
        	this.tid = tid;
		this.isSuccess = isSuccess;
		this.optimizationPoints = optimizationPoints;
		this.captureActivityPoints = captureActivityPoints;
		this.captureAttributePoints = captureAttributePoints;
    	}
}

MXOMimeType

Possible types of MXO Assets.

public enum MXOMimeType {
    	JSON, 
	TXT, 
	HTML, 
	XML, 
	EXTERNAL, 
	UNKNOWN,
}

MXOOptimizationPoint

MXO Interaction response data.

import com.medallia.mxo.interactions.MXOAction;
import com.medallia.mxo.interactions.MXOOptimizationPointDirectives;

public class MXOOptimizationPoint {
    	private String path;
	private Set<MXOAction> actions;
	private MXOOptimizationPointDirectives directives;

    	public MXOOptimizationPoint(String path, Set<MXOAction> actions, MXOOptimizationPointDirectives directives) {
        	this.path = path;
        	this.actions = actions;
		this.directives = directives;
	}
}

MXOOptimizationPointDirectives

The position to place an Optimization.

public enum MXOOptimizationPointDirectives {
    	REPLACE, 
	BEFORE, 
	AFTER,
}

MXOProposition

Propositions are the products or services that you want to promote to customers. For example, a 0% balance transfer offer on credit cards.

Use Propositions to set up the long-term and short-term campaigns, offers, invitations, and parent-child hierarchies to use for your marketing initiatives.

import com.medallia.mxo.interactions.MXOPropositionType;

public class MXOProposition {
    	private String name;
	private String code;
	private MXOPropositionType type;

    	public MXOProposition(String name, String code, MXOPropositionType type) {
        	this.name = name;
        	this.code = code;
		this.type = type;
	}
}

MXOPropositionType

The type of a proposition.

Products are typically items you can see and touch, such as computers, cars (or any of the parts of a car), credit cards, car insurance, mobile phones, and so on.

Services are typically provided for you by other people, such as customer service, support, and so on.

Products and services can have parent-child relationships. For example, a product such as a credit card might have other products nested below it, such as different credit card types like platinum, gold, silver, and prepaid.

public enum MXOPropositionType {
    	PRODUCT, 
	SERVICE,
}

MXOResponseCode

The response code object containing the response code value. This is used as part of the MXOResponseCodeRequest object. Response code values is sent to the MXO API as a property value.

public class MXOResponseCode {
    	private String value;

    	public MXOResponseCode(String value) {
        	this.value = value;
	}
}

MXOResponseCodeRequest

The response code request object for sending the response code to the MXO SDK.

import com.medallia.mxo.interactions.MXOInteraction;
import com.medallia.mxo.interactions.MXOResponseCode;

public class MXOResponseCodeRequest {
    	private MXOInteraction interaction;
	private MXOResponseCode responseCode;

    	public MXOResponseCodeRequest(MXOInteraction interaction, MXOResponseCode responseCode) {
        	this.interaction = interaction;
        	this.responseCode = responseCode;
	}
}

Create an instance using the Builder as shown below:

final MXOResponseCodeRequest request = new MXOResponseCodeRequest.Builder()
	.interaction(URI.create("/yourInteractionPath"))
	.responseCode(yourResponseCode)
	.build()