Automatic API

Get or set the current automatic Interaction tracking configuration using the following:

@property (class, nonatomic, nullable) MXOAutomaticInteractionTrackingConfiguration *automaticInteractionTrackingConfiguration;

To retrieve an automatic Interaction, use the function below:

+ (nullable MXOInteraction *) getAutomaticInteraction:
	(UIViewController *)viewController
);

Automatic Interaction assignment API

Assign an automatic Interaction to a View to be used instead of using the automatic path using the following:

+ (BOOL)assignAutomaticInteraction:
	(MXOAutomaticInteractionAssignment *)assignInteraction
	error:(NSError *__autoreleasing _Nullable * _Nullable)error
);

Automatic Interaction exclusion API

Exclude a View from automatically being tracked as an Interaction using the following:

+ (BOOL)excludeAutomaticInteraction:(MXOAutomaticInteractionExclusion *)excludeInteration
	error:(NSError *__autoreleasing _Nullable * _Nullable)error
);

Automatic Interaction subscription API

Subscribe to automatic Interaction request responses using the following:

@protocol MXOAutomaticInteractionSubscription;

Use the convenience function to subscribe to automatic Interaction tracking:

+ (nullable id<MXOAutomaticInteractionSubscription>)subscribeToAutomaticInteraction:(MXOAutomaticInteractionSubscriber *)subscriber
	error:(NSError *__autoreleasing _Nullable * _Nullable)error
);

Configuration API

Get or set the MXO SDK configuration using the following:

@property (class, nonatomic, nullable) MXOConfiguration *configuration;

Identity APIs

Retrieve the TID of the current user using the following:

+ (nullable NSString *)getTid;

Clear the current user's TID from the SDK using the following:

+ (void)clearTid;

This feature enables the SDK to notify MXO when multiple user's may access the same app on the same device.

Identity Transfer API

Programmatic API to process a deep link to an app that has had the MXO Orchestration Plugin disabled or has had the identity transfer disabled therefore preventing the automatic sending of deep link parameters to MXO.

Get or set the MXO SDK identity transfer configuration using the following:

@property (class, nonatomic, nullable) MXOIdentityTransferConfiguration *identityTransferConfiguration;

Process a URL deep link using the function below:

+ (BOOL)processDeepLink:(NSURL *)url
                  error:(NSError *__autoreleasing _Nullable * _Nullable)error
);

Generate a URL with a tid query parameter using the function below:

+ (nullable NSURL *)generateIdentityTransferUrl:(NSURL *)url
                                          error:(NSError *__autoreleasing _Nullable * _Nullable)error;

Interaction APIs

Send Interactions to MXO using the following:

+ (BOOL)sendInteraction:(MXOInteractionRequest *)request
                  error:(NSError *__autoreleasing _Nullable * _Nullable)error
);

Send Properties to MXO using the following:

+ (BOOL)sendProperties:(MXOInteractionRequest *)request
                 error:(NSError *__autoreleasing _Nullable * _Nullable)error
);

Send response code to MXO using the following:

+ (BOOL)sendInteractionResponseCode:(MXOResponseCodeRequest *)request
                              error:(NSError *__autoreleasing _Nullable * _Nullable)error
);

Generate a URL for outbound link tracking using the function below:

+ (BOOL)sendInteractionForOutboundLink:(NSURL *)link
                                 error:(NSError *__autoreleasing _Nullable * _Nullable)error
);

Process the response returned from sending an Interaction using the following:

+ (BOOL)processResponse:(MXOInteractionResponse *)response
                  error:(NSError *__autoreleasing _Nullable * _Nullable)error
);

Location API

Inform the MXO SDK about location details using the following:

+ (BOOL)processLocation:(CLLocation *)location
                  error:(NSError *__autoreleasing _Nullable * _Nullable)error
);

Logging API

Get or set the MXO SDK logging configuration using the following:

@property (class, nonatomic, nullable) MXOLoggingConfiguration *loggingConfiguration;

MXOErrorCode

An MXO SDK Runtime exception.

typedef NS_ERROR_ENUM(MXOErrorDomain, MXOErrorCode) {
    	MXOErrorSDKError = 9000,
    	MXOErrorAPIError,
    	MXOErrorInvalidRequestError,
    	MXOErrorInvalidParamError,
    	MXOErrorInvalidSubscriberError
};

Opt Out API

Get or set the optout settings for compliance with a user's will to be tracked or not using the following:

open class var optOutConfiguration: MXOOptOutConfiguration?

Version API

+ (NSString *)getVersion;