AdResult (XAPP 4.0.0)

java.lang.Object
- xappmedia.sdk.model.AdResult

All Implemented Interfaces:

android.os.Parcelable
```
public class AdResult
extends java.lang.Object
implements android.os.Parcelable
```
An AdResult contains all the events that occurred during the execution of an ad.

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type Field and Description

static android.os.Parcelable.Creator<AdResult> CREATOR
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static android.os.Parcelable.Creator<AdResult>`	`CREATOR`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`describeContents()`
`AdAction`	`getAction()` Returns the `AdAction` that was matched and performed during ad playback
`java.lang.String`	`getActionPhrase()` Get the action phrase for the recognized action.
`ActionType`	`getActionType()` Returns the action type set for this ad or null if there is not one.
`SpeechResult[]`	`getActionUtterances()` Returns the array of action utterances for the AdResult
`CallType`	`getCallType()` Returns the callType of the adResult, either "userInitiated or "serverInitiated"
`java.lang.String`	`getCancellationDetails()` Get details on how the ad was cancelled.
`java.lang.String`	`getCancellationMethod()` Returns a string for how the ad was cancelled
`java.lang.String`	`getCustomActionMetadata()` Get the metadata associated with the custom action that was recognized.
`java.lang.String`	`getEmail()`
`int`	`getErrorCode()` Get the error code of the error that occurred during advertisement playback
`java.lang.String`	`getErrorMessage()` Returns the error message for the AdResult.
`java.lang.String`	`getHomePhone()`
`java.lang.String`	`getMobilePhone()`
`SpeechResult[]`	`getMoreInfoUtterances()` Returns the array of moreInfoUtterances for the AdResult
`long`	`getTimeActionWasCaught()` Get the time that the time in which an action was caught.
`float`	`getTouchLocationX()` Last x position set for the touch location.
`float`	`getTouchLocationY()` Last y position set for the touch location.
`boolean`	`hasError()` Returns true if there is an error message and/or error code.
`boolean`	`isCanceled()` Returns if the ad was cancelled during the playback
`boolean`	`isMoreInfoUttered()` Returns `true` if moreInfo has already been uttered and recognized, false otherwise
`boolean`	`isSuccess()` Returns true if the ad ran successfully, false otherwise.
`boolean`	`isTouchClicked()` Returns if a touch clicked occurred on the ad view.
`boolean`	`wasActionInBackground()` Returns whether or not the action was performed in the background.
`boolean`	`wasCustomActionRecognized()` Check if a custom action was recognized during ad playback.
`boolean`	`wasImageDismissed()`
`boolean`	`wasInBackgroundAtEnd()` Returns whether or not the ad ended in the background.
`boolean`	`wasInBackgroundAtStart()` Returns whether or not the ad started in the background.
`boolean`	`wasVoiceActionTaken()` True if the voice action was taken OR if the user uttered the "more info" action.
`void`	`writeToParcel(android.os.Parcel out, int flags)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CREATOR
```
public static final android.os.Parcelable.Creator<AdResult> CREATOR
```
- Method Detail
  - describeContents
```
public int describeContents()
```
    Specified by:
    
    describeContents in interface android.os.Parcelable
  - writeToParcel
```
public void writeToParcel(android.os.Parcel out,
                          int flags)
```
    Specified by:
    
    writeToParcel in interface android.os.Parcelable
  - getAction
```
public AdAction getAction()
```
    Returns the AdAction that was matched and performed during ad playback
    
    Returns:
    
    The most recent action completed
  - getActionType
```
public ActionType getActionType()
```
    Returns the action type set for this ad or null if there is not one.
    
    Returns:
    
    Action type for this action.
  - getTimeActionWasCaught
```
public long getTimeActionWasCaught()
```
    Get the time that the time in which an action was caught. Will be less than 0 if there is no item caught.
  - wasActionInBackground
```
public boolean wasActionInBackground()
```
    Returns whether or not the action was performed in the background. This will always return false if getAction() returns null (i.e., no caught action yet).
    
    Returns:
    
    True if the action was performed in the background.
  - wasInBackgroundAtStart
```
public boolean wasInBackgroundAtStart()
```
    Returns whether or not the ad started in the background.
  - wasInBackgroundAtEnd
```
public boolean wasInBackgroundAtEnd()
```
    Returns whether or not the ad ended in the background.
  - getActionUtterances
```
public SpeechResult[] getActionUtterances()
```
    Returns the array of action utterances for the AdResult
    
    Returns:
    
    A String array of utterances that occurred for recognizing an action.
  - getCallType
```
public CallType getCallType()
```
    Returns the callType of the adResult, either "userInitiated or "serverInitiated"
    
    Returns:
    
    String that denotes the call type
  - getMoreInfoUtterances
```
public SpeechResult[] getMoreInfoUtterances()
```
    Returns the array of moreInfoUtterances for the AdResult
    
    Returns:
    
    An array of strings that represent the possible utterances during the first recognition period
  - isMoreInfoUttered
```
public boolean isMoreInfoUttered()
```
    Returns true if moreInfo has already been uttered and recognized, false otherwise
  - isSuccess
```
public boolean isSuccess()
```
    Returns true if the ad ran successfully, false otherwise. If false, check the getErrorCode() and getErrorMessage().
    
    Returns:
    
    True if there was an error presented or false otherwise.
    
    See Also:
    
    Error}
  - isCanceled
```
public boolean isCanceled()
```
    Returns if the ad was cancelled during the playback
    
    Returns:
    
    true if ad was canceled
  - getCancellationMethod
```
public java.lang.String getCancellationMethod()
```
    Returns a string for how the ad was cancelled
    
    Returns:
    
    Returns a String on how ad was canceled
  - getCancellationDetails
```
public java.lang.String getCancellationDetails()
```
    Get details on how the ad was cancelled.
    
    Returns:
    
    String with details on how the ad was canceled
  - isTouchClicked
```
public boolean isTouchClicked()
```
    Returns if a touch clicked occurred on the ad view.
    
    Returns:
    
    true if touch click happened
  - getTouchLocationX
```
public float getTouchLocationX()
```
    Last x position set for the touch location.
  - getTouchLocationY
```
public float getTouchLocationY()
```
    Last y position set for the touch location.
  - hasError
```
public boolean hasError()
```
    Returns true if there is an error message and/or error code. If this returns true, then the error can be retrieved by getErrorCode() or getErrorMessage().
  - getErrorCode
```
public int getErrorCode()
```
    Get the error code of the error that occurred during advertisement playback
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Returns the error message for the AdResult. Null if there was no error presented.
  - getCustomActionMetadata
```
public java.lang.String getCustomActionMetadata()
```
    Get the metadata associated with the custom action that was recognized. See AdAction for more details on custom actions.
    
    Returns:
    
    Returns a String of the metadata or null if no custom action was
    
    See Also:
    
    AdAction
  - wasCustomActionRecognized
```
public boolean wasCustomActionRecognized()
```
    Check if a custom action was recognized during ad playback. See AdAction for more details on custom actions.
    
    Returns:
    
    Returns true if the custom action was recognized, false if not
    
    See Also:
    
    AdAction
  - getActionPhrase
```
public java.lang.String getActionPhrase()
```
    Get the action phrase for the recognized action.
    
    Returns:
    
    A String representing the phrase that was matched during recognition, if nothing was recognized it will return null
  - wasVoiceActionTaken
```
public boolean wasVoiceActionTaken()
```
    True if the voice action was taken OR if the user uttered the "more info" action.
  - wasImageDismissed
```
public boolean wasImageDismissed()
```
  - getEmail
```
public java.lang.String getEmail()
```
  - getMobilePhone
```
public java.lang.String getMobilePhone()
```
  - getHomePhone
```
public java.lang.String getHomePhone()
```

Class AdResult

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATOR

Method Detail

describeContents

writeToParcel

getAction

getActionType

getTimeActionWasCaught

wasActionInBackground

wasInBackgroundAtStart

wasInBackgroundAtEnd

getActionUtterances

getCallType

getMoreInfoUtterances

isMoreInfoUttered

isSuccess

isCanceled

getCancellationMethod

getCancellationDetails

isTouchClicked

getTouchLocationX

getTouchLocationY

hasError

getErrorCode

getErrorMessage

getCustomActionMetadata

wasCustomActionRecognized

getActionPhrase

wasVoiceActionTaken

wasImageDismissed

getEmail

getMobilePhone

getHomePhone