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.

public data class MXOAction(
    	public val name: String? = null,
    	public val asset: MXOAsset? = null,
    	public val proposition: MXOProposition? = null,
)

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.

public data class MXOAsset(
    	public val markup: String? = null,
   	public val responses: Set<MXOAssetResponse> = emptySet(),
    	public val mimeType: MXOMimeType = MXOMimeType.UNKNOWN,
    	public val contentUrl: URI? = null,
)

MXOAssetResponse

MXO Asset response for tracking.

public data class MXOAssetResponse(
    	public val code: MXOResponseCode? = null,
    	public val sentiment: MXOAssetResponseSentiment = MXOAssetResponseSentiment.UNKNOWN,
    	public val label: MXOAssetResponseLabel? = null,
    	public val imageUrl: URI? = null,
    	public val targetUrl: URI? = null,
    	public val target: MXOAssetResponseTarget? = null,
)

MXOAssetResponseLabel

Optional Label to display for an asset response.

public data class MXOAssetResponseLabel(
	public val value: String,
)

MXOAssetResponseSentiment

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

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

MXOAssetResponseTarget

The location of an MXO Asset response.

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

MXOCaptureActivityPoint

Capture user Activity when they interact with an MXO Interaction.

public data class MXOCaptureActivityPoint(
    	public val id: String? = null,
    	public val path: String? = null,
)

MXOCaptureAttributePoint

Capture user Attribute when they interact with an MXO Interaction.

public data class MXOCaptureAttributePoint(
    	public val id: String? = null,
    	public val path: String? = null,
    	public val elementType: MXOCaptureElementType? = null,
    	public val elementName: String? = null,
    	public val elementAttributeName: String? = null,
    	public val captureDelay: Int = 0,
    	public val captureType: MXOCaptureType? = null,
    	public val capturePhase: MXOCapturePhase? = null,
)

MXOCaptureElementType

The type of an element.

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

MXOCapturePhase

The phase in which to capture an Attribute.

public enum class MXOCapturePhase {
    	LOAD,
	ON_CLICK,
    	PARAMETER,
}

MXOCaptureType

The type of value to capture from an element.

public enum class 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.

public data class MXOInteraction(
    	public val value: URI,
)

MXOIntractionRequest

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

public data class MXOInteractionRequest(
	public val interaction: MXOInteraction = MXOInteraction(URI.create("/")),
	public val properties: Map<String, String>? = mapOf(),
)

Create an instance using the Builder as shown below:

@JvmSynthetic
public inline fun mxoInteractionRequest(
	initializer: MXOIntractionRequest.Builder.() -> Unit = { },
): MXOInteractionRequest

MXOIntractionResponse

MXO Interaction response data.

public data class MXOInteractionResponse(
    	public val interaction: MXOInteraction = MXOInteraction(URI.create("")),
    	public val tid: String? = null,
){
	public val isSuccess: Boolean = true,
	public val optimizationPoints: Set<MXOOptimizationPoint> = null,
	public val captureActivityPoints: Set<MXOCaptureActivityPoint> = null,
	public val captureAttributePoints: Set<MXOCaptureAttributePoint> = null,
}

MXOMimeType

Possible types of MXO Assets.

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

MXOOptimizationPoint

MXO Interaction response data.

public data class MXOOptimizationPoint(
    	public val path: String? = null,
    	public val actions: Set<MXOAction> = emptySet(),
    	public val directives: MXOOptimizationPointDirectives? = null,
)

MXOOptimizationPointDirectives

The position to place an Optimization.

public enum class 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.

public data class MXOProposition(
    	public val name: String? = null,
    	public val code: String? = null,
    	public val type: MXOPropositionType = MXOPropositionType.PRODUCT,
)

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 class 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 data class MXOResponseCode(
	public val value: String,
)

MXOResponseCodeRequest

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

public data class MXOResponseCodeRequest(
	public val interaction: MXOInteraction = MXOInteraction(URI.create("")),
    	public val responseCode: MXOResponseCode = MXOResponseCode(""),
)

Create an instance using the Builder as shown below:

@JvmSynthetic
public inline fun mxoResponseCodeRequest(
	initializer: MXOResponseCodeRequest.Builder.() -> Unit = { },
): MXOResponseCodeRequest