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.

@interface MXOAction : NSObject
@property (nonatomic, copy, nullable, readonly) NSString *name;
@property (nonatomic, strong, nullable, readonly) MXOAsset *asset;
@property (nonatomic, strong, nullable, readonly) MXOProposition *proposition;
@end

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.

@interface MXOAsset : NSObject
@property (nonatomic, copy, nullable, readonly) NSString *markup;
@property (nonatomic, strong, nullable, readonly) NSArray<MXOAssetResponse *> *responses;
@property (nonatomic, assign, readonly) MXOMimeType mimeType;
@property (nonatomic, strong, nullable, readonly) NSString *contentUrl;
@end

MXOAssetResponse

MXO Asset response for tracking.

@interface MXOAssetResponse : NSObject
@property (nonatomic, strong, nullable, readonly) MXOResponseCode *code;
@property (nonatomic, assign, readonly) MXOAssetResponseSentiment sentiment;
@property (nonatomic, strong, nullable, readonly) NSString *label;
@property (nonatomic, strong, nullable, readonly) NSString *imageUrl;
@property (nonatomic, strong, nullable, readonly) NSString *targetUrl;
@property (nonatomic, assign, readonly) MXOAssetResponseTarget target;
@end

MXOAssetResponseSentiment

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

typedef NS_ENUM(NSInteger, MXOAssetResponseSentiment) {
    	MXOAssetResponseSentimentPositive,
    	MXOAssetResponseSentimentNeutral,
    	MXOAssetResponseSentimentNegative,
    	MXOAssetResponseSentimentUnknown
};

MXOAssetResponseTarget

The location of an MXO Asset response.

typedef NS_ENUM(NSInteger, MXOAssetResponseTarget) {
	MXOAssetResponseTargetInApp,
    	MXOAssetResponseTargetExternal,
    	MXOAssetResponseTargetContext,
    	MXOAssetResponseTargetUnknown
};

MXOCaptureActivityPoint

Capture user Activity when they interact with an MXO Interaction.

@interface MXOCaptureActivityPoint : NSObject
@property (nonatomic, copy, nullable, readonly) NSString *identifier;
@property (nonatomic, copy, nullable, readonly) NSString *path;
@end

MXOCaptureAttributePoint

Capture user Attribute when they interact with an MXO Interaction.

@interface MXOCaptureAttributePoint : NSObject
@property (nonatomic, copy, nullable, readonly) NSString *identifier;
@property (nonatomic, copy, nullable, readonly) NSString *path;
@property (nonatomic, assign, readonly) MXOCaptureElementType elementType;
@property (nonatomic, copy, nullable, readonly) NSString *elementName;
@property (nonatomic, copy, nullable, readonly) NSString *elementAttributeName;
@property (nonatomic, readonly) NSInteger captureDelay;
@property (nonatomic, assign, readonly) MXOCaptureType captureType;
@property (nonatomic, assign, readonly) MXOCapturePhase capturePhase;
@end

MXOCaptureElementType

The type of an element.

typedef NS_ENUM(NSInteger, MXOCaptureElementType) {
    	MXOCaptureElementTypeTextField,
    	MXOCaptureElementTypeCheckboxRadio,
    	MXOCaptureElementTypeDisplayElem,
    	MXOCaptureElementTypeDropDown,
    	MXOCaptureElementTypeUnknown
};

MXOCapturePhase

The phase in which to capture an Attribute.

typedef NS_ENUM(NSInteger, MXOCapturePhase) {
    	MXOCapturePhaseLoad,
    	MXOCapturePhaseOnClick,
    	MXOCapturePhaseParameter,
    	MXOCapturePhaseUnknown
};

MXOCaptureType

The type of value to capture from an element.

typedef NS_ENUM(NSInteger, MXOCaptureType) {
    	MXOCaptureTypeAttribute,
    	MXOCaptureTypeText,
    	MXOCaptureTypeValue,
    	MXOCaptureTypeCookie,
    	MXOCaptureTypeUnknown,
};

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.

@interface MXOInteraction : NSObject
@property (atomic, strong, readonly, nullable) NSURL *value;
@end

MXOIntractionRequest

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

@interface MXOInteractionRequest : MXORequest
@property (nonatomic, strong, readonly, nullable) MXOInteraction *interaction;
@property (nonatomic, strong, readonly, nullable) NSDictionary<NSString *, NSString *> *properties;
@property (nonatomic, copy, readonly, nullable) MXORequestOnErrorBlock onError;
@property (nonatomic, copy, readonly, nullable) MXORequestOnSuccessBlock onSuccess;
@end

Create an instance using the Builder as shown below:

MXOInteractionRequest *interactionRequest = [MXOInteractionRequest initWithBuilder:^(MXOInteractionRequestBuilder * _Nonnull builder) {
	builder.interaction = [MXOInteraction initWithString:@"/" error:&error];
	builder.properties = @{@"name": @"value"};
	builder.onError = ^(NSError *error) {
		// process error
	}
        builder.onSuccess = ^(MXOInteractionResponse *response) {
		// process response
	}
}];
sendinteraction

MXOIntractionResponse

MXO Interaction response data.

@interface MXOInteractionResponse : NSObject
@property (nonatomic, strong, nullable, readonly) MXOInteraction *interaction;
@property (nonatomic, copy, nullable, readonly) NSString *tid;
@property (nonatomic, strong, nullable, readonly) NSArray<MXOOptimizationPoint *> *optimizationPoints;
@property (nonatomic, strong, nullable, readonly) NSArray<MXOCaptureAttributePoint *> *captureAttributePoints;
@property (nonatomic, strong, nullable, readonly) NSArray<MXOCaptureActivityPoint *> *captureActivityPoints;
@end

MXOMimeType

Possible types of MXO Assets.

typedef NS_ENUM(NSInteger, MXOMimeType) {
    	MXOMimeTypeJSON,
    	MXOMimeTypeTXT,
    	MXOMimeTypeHTML,
    	MXOMimeTypeXML,
    	MXOMimeTypeExternal,
    	MXOMimeTypeUnknown
};

MXOOptimizationPoint

MXO Interaction response data.

@interface MXOOptimizationPoint : NSObject
@property (nonatomic, copy, nullable, readonly) NSString *path;
@property (nonatomic, strong, nullable, readonly) NSArray<MXOAction *> *actions;
@property (nonatomic, assign, readonly) MXOOptimizationPointDirectives directives;
@end

MXOOptimizationPointDirectives

The position to place an Optimization.

typedef NS_ENUM(NSInteger, MXOOptimizationPointDirectives) {
    	MXOOptimizationPointDirectiveReplace,
    	MXOOptimizationPointDirectiveBefore,
    	MXOOptimizationPointDirectiveAfter,
    	MXOOptimizationPointDirectiveUnknown
};

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.

@interface MXOProposition : NSObject
@property (nonatomic, copy, nullable, readonly) NSString *name;
@property (nonatomic, copy, nullable, readonly) NSString *code;
@property (nonatomic, assign, readonly) MXOPropositionType type;
@end

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.

typedef NS_ENUM(NSInteger, MXOPropositionType) {
    	MXOPropositionTypeProduct,
    	MXOPropositionTypeService
};

MXORequestOnErrorBlock

The MXO request sent on error.

typedef void (^MXORequestOnErrorBlock)(
	NSError *error
);

MXORequestOnSuccessBlock

The MXO request sent on success.

typedef void (^MXORequestOnSuccessBlock)(
	MXOInteractionResponse *response
);

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.

@interface MXOResponseCode : NSObject
@property (nonatomic, copy, nullable) NSString *value;
@end

MXOResponseCodeRequest

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

@interface MXOResponseCodeRequest : MXORequest
@property (nonatomic, strong, readonly, nullable) MXOInteraction *interaction;
@property (nonatomic, strong, readonly, nullable) MXOResponseCode *responseCode;
@property (nonatomic, copy, readonly, nullable) MXORequestOnErrorBlock onError;
@property (nonatomic, copy, readonly, nullable) MXORequestOnSuccessBlock onSuccess;
@end

Create an instance using the Builder as shown below:

MXOResponseCodeRequest *request = [MXOResponseCodeRequest initWithBuilder:^(MXOResponseCodeRequestBuilder * _Nonnull builder) {
        builder.interaction = [MXOInteraction initWithString:@"/" error:&error];
        builder.responseCode = [MXOResponseCode initWithResponseCode:responseCode error:nil];
        builder.onError = ^(NSError *error) {
		// process error
	}
       	builder.onSuccess = ^(MXOInteractionResponse *response) {
		// process response
	}
}];