XAResult Class Reference

Inherits from NSObject
Conforms to NSCoding
NSCopying
Declared in XAResult.h

Overview

The XAAdResult provides detailed information about the playback of an advertisement.

Advertisement Information

  adID

The ID of the advertisement that was played

@property (nonnull, nonatomic, retain) NSString *adID

Discussion

The ID of the advertisement that was played

Declared In

XAResult.h

  requestKey

The request key that was used to retrieve the ad

@property (nonnull, nonatomic, retain) NSString *requestKey

Discussion

The request key that was used to retrieve the ad

Declared In

XAResult.h

  sessionKey

The session key for the current active listening session

@property (nonnull, nonatomic, retain) NSString *sessionKey

Discussion

The session key for the current active listening session

Declared In

XAResult.h

  server

The URL for where the advertisement originated.

@property (nonnull, nonatomic, retain) NSURL *server

Discussion

The URL for where the advertisement originated.

Declared In

XAResult.h

Playback Information

  startPlay

Advertisement start time as an ISO-8601 string

@property (nonnull, nonatomic, retain) NSString *startPlay

Discussion

Advertisement start time as an ISO-8601 string

Declared In

XAResult.h

  endPlay

Advertisement end time as an ISO-8601 string

@property (nonnull, nonatomic, retain) NSString *endPlay

Discussion

Advertisement end time as an ISO-8601 string

Declared In

XAResult.h

  success

The ad playback was succesful, if NO then look for an error

@property (nonatomic, assign) BOOL success

Discussion

The ad playback was succesful, if NO then look for an error

Declared In

XAResult.h

  error

The error, if one did occur, for the advertisement playback.

@property (nullable, nonatomic, retain) NSError *error

Discussion

The error, if one did occur, for the advertisement playback.

Declared In

XAResult.h

  voiceClick

Boolean for if the user responded by voice to an action

@property (nonatomic, assign) BOOL voiceClick

Availability

3.11.0

Discussion

Boolean for if the user responded by voice to an action

Declared In

XAResult.h

  recognizedAction

The recognized action, nil if no action was recognized.

@property (nullable, nonatomic, retain) XAAction *recognizedAction

Discussion

The recognized action, nil if no action was recognized.

Declared In

XAResult.h

  audioAction

If an audio action was triggered.

@property BOOL audioAction

Discussion

If an audio action was triggered.

Declared In

XAResult.h

  touchClick

Boolean for if the ad image was touched by the user.

@property (nonatomic, assign) BOOL touchClick

Availability

3.11.0

Discussion

Boolean for if the ad image was touched by the user.

Declared In

XAResult.h

  touchClickLocation

Coordinates for where the user touched the screen. The last touch is reported and earlier touches are overwritten.

@property (nonatomic, assign) CGPoint touchClickLocation

Availability

3.11.0

Discussion

Coordinates for where the user touched the screen. The last touch is reported and earlier touches are overwritten.

Declared In

XAResult.h

  touchAction

The action the was completed when the complementary companion was touched.

@property (nullable, nonatomic, retain) XAAction *touchAction

Discussion

The action the was completed when the complementary companion was touched.

Declared In

XAResult.h

  deferredAction

Completion of the action will be deferred until the application moves back to the foreground.

@property (nullable, nonatomic, retain) XAAction *deferredAction

Discussion

Completion of the action will be deferred until the application moves back to the foreground.

Declared In

XAResult.h

  cancelled

If the advertisement was cancelled by either programmatically or the user clicked the ‘X’. See cancellationType for more information on the cancellation.

@property (nonatomic, assign) BOOL cancelled

Discussion

If the advertisement was cancelled by either programmatically or the user clicked the ‘X’. See cancellationType for more information on the cancellation.

See Also

Declared In

XAResult.h

  cancellationTypeString

Describes method of cancellation, either XAAdResultCancellationTypeStringProgrammatic, XAAdResultCancellationTypeStringCancelTouched, XAAdResultCancellationTypeStringRemoteControlEvent. See cancelled to check if the ad was cancelled.

@property (nullable, nonatomic, retain) NSString *cancellationTypeString

Discussion

Describes method of cancellation, either XAAdResultCancellationTypeStringProgrammatic, XAAdResultCancellationTypeStringCancelTouched, XAAdResultCancellationTypeStringRemoteControlEvent. See cancelled to check if the ad was cancelled.

See Also

Declared In

XAResult.h

  cancellationType

How the ad was cancelled

@property XAResultCancellationType cancellationType

Availability

3.7.0

Discussion

How the ad was cancelled

See Also

Declared In

XAResult.h

+ cancellationTypeToString:

Convenience method for converting the cancellationType to a human readable string, can be used for debugging.

+ (nullable NSString *)cancellationTypeToString:(XAResultCancellationType)cancellationType

Parameters

cancellationType

Cancellation type observed during ad playback

Return Value

String representing the cancellationType

Availability

3.7.0

Discussion

Convenience method for converting the cancellationType to a human readable string, can be used for debugging.

See Also

Declared In

XAResult.h

  cancellationTime

If the ad was cancelled, the cancellation time is the amount into audio playback that the ad was cancelled.

@property (nonatomic, assign) NSTimeInterval cancellationTime

Discussion

If the ad was cancelled, the cancellation time is the amount into audio playback that the ad was cancelled.

See Also

Declared In

XAResult.h

  interstitialSkipped

The image was dismissed through the close button.

@property (nonatomic, assign) BOOL interstitialSkipped

Discussion

The image was dismissed through the close button.

Declared In

XAResult.h

Resource Load Diagnostic Information

  recognitionTime

Time to complete voice recognition

@property (nonatomic) NSTimeInterval recognitionTime

Discussion

Time to complete voice recognition

Declared In

XAResult.h

  linearLoadTime

Time to complete loading of the linear creative

@property (nonatomic) NSTimeInterval linearLoadTime

Discussion

Time to complete loading of the linear creative

Declared In

XAResult.h

  companionLoadTime

Time to complete loading of the companion creative.

@property (nonatomic) NSTimeInterval companionLoadTime

Discussion

Time to complete loading of the companion creative.

Declared In

XAResult.h

Diagnostic Information

  audioRoute

The Audio Route used during playback

@property (nonnull, nonatomic, retain) NSString *audioRoute

Discussion

The Audio Route used during playback

Declared In

XAResult.h

  audioRouteName

The more specific audio route name used during playback

@property (nonnull, nonatomic, retain) NSString *audioRouteName

Discussion

The more specific audio route name used during playback

Declared In

XAResult.h

  connectionType

The connection type at the start of the ad

@property (nonnull, nonatomic, retain) NSString *connectionType

Discussion

The connection type at the start of the ad

Declared In

XAResult.h

  deviceCharging

If the device was charging.

@property BOOL deviceCharging

Discussion

If the device was charging.

Declared In

XAResult.h

  backgroundedAtStart

If the app was in the background at the start of playback.

@property BOOL backgroundedAtStart

Discussion

If the app was in the background at the start of playback.

Declared In

XAResult.h

  backgroundedAtVoiceRecognition

If the app was in the background when voice recognition occured.

@property BOOL backgroundedAtVoiceRecognition

Discussion

If the app was in the background when voice recognition occured.

Declared In

XAResult.h

  backgrounded

If the app was in the background at the end of playback.

@property BOOL backgrounded

Discussion

If the app was in the background at the end of playback.

Declared In

XAResult.h

  email

The email address to use for the action. Necessary for BUY and EMAIL action types

@property (nonnull, nonatomic, retain) NSString *email

Discussion

The email address to use for the action. Necessary for BUY and EMAIL action types

Declared In

XAResult.h