Identity Transfer APIs

MXOIdentityTransferConfiguration

The configuration object for MXO SDK identity transfer.

@interface MXOIdentityTransferConfiguration : NSObject
@property (nonatomic, readonly) BOOL disableIdentityTransfer;
@property (atomic, strong, readonly, nullable) NSArray<MXOIdentityTransferUriMatcher *> *includeList;
@property (atomic, strong, readonly, nullable) NSArray<MXOIdentityTransferUriMatcher *> *excludeList;
@end


Property	Type	Description
disableIdentityTransfer	BOOL	Set to true to disable transfer of identity to outbound locations.
includeList	NSArray<MXOIdentityTransferUriMatcher *>	The list of allowed URIs for identity transfer.
excludeList	NSArray<MXOIdentityTransferUriMatcher *>	The list of denied URIs for identity transfer.

Create an instance using the Builder as shown below:

MXOIdentityTransferConfigurationBuilder *identityConfiguration = MedalliaMXO.identityTransferConfiguration.builder;
builder.disableIdentityTransfer = NO;
builder.includeList = includeList;
builder.excludeList = excludeList;

Note: For more information, see how to disable/enable automatic identity transfer, or include or exclude an Interaction from tracking.

MXOIdentityTransferUriMatcher

Represents the different ways the MXO SDK will attempt to include or exclude URIs from having a tid query parameter and value appended, IE identity transfer.

@interface MXOIdentityTransferUriMatcher : NSObject
@property (atomic, strong, readonly) id _Nullable value;
@end


Property	Type	Description
value	id	The value of the URI matcher.

If used in either excludeList or includeList, then only exact values (as strings) will be compared.

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


Property	Type	Description
url	NSURL	The URL to match.
error	NSError	Used to handle errors.

Note: For more information, see how to use the exact Uri matcher when including or excluding links from tracking.

If used in either excludeList or includeList, then the URI values will be matched to the regex provided.

+ (nullable instancetype)initWithRegex:(nullable NSRegularExpression *)regex
                                 error:(NSError *__autoreleasing _Nullable * _Nullable)error
);


Property	Type	Description
regex	NSRegularExpression	The regex to match against the string representation of the URL.
error	NSError	Used to handle errors.

Note: For more information, see how to use the regex Uri matcher when including or excluding links from tracking.