CBImpression (Chartboost API)

java.lang.Object
- com.chartboost.sdk.Model.CBImpression

public class CBImpression
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`AdTypeTraits`	`adTypeTraits`
`AdUnit`	`adUnit`
`boolean`	`animatingIn`
`ImpressionCallback`	`callback`
`boolean`	`clicked`
`CBRequest`	`clickRequest`
`boolean`	`closed`
`FileCache`	`fileCache`
`boolean`	`isPaused`
`boolean`	`isShowProcessed` Use this to indicate if the fact that tasks that must be run upon showing and impression have been processed.
`java.lang.String`	`location`
`int`	`mediaType`
`CBNetworkService`	`networkService`
`PopupImpressionView`	`parentView`
`boolean`	`playbackDidComplete`
`boolean`	`playbackDidStart`
`RequestBodyFields`	`requestBodyFields`
`SharedPreferences`	`sharedPreferences`
`int`	`state`
`java.lang.String`	`templateHtml`
`CBTrack`	`track`
`Handler`	`uiHandler`
`CBUIManager`	`uiManager`
`CBURLOpener`	`urlOpener`
`CBViewController`	`viewController`
`CBWebImageCache`	`webImageCache`

Constructor Summary

Constructors
Constructor and Description
`CBImpression(AdUnit adUnit, ImpressionCallback callback, FileCache fileCache, CBNetworkService networkService, RequestBodyFields requestBodyFields, SharedPreferences sharedPreferences, CBTrack track, Handler uiHandler, CBUIManager uiManager, CBURLOpener urlOpener, CBViewController viewController, CBWebImageCache webImageCache, AdTypeTraits adTypeTraits, java.lang.String location, java.lang.String templateHtml, RelativeLayout externalView, PrivacyPresenter privacyPresenter)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanUpViews()` destroy just the impression's views, not associated data
`void`	`destroy()` destroy impression's view and view data
`java.lang.String`	`getAdID()`
`RelativeLayout`	`getHostView()`
`java.lang.Boolean`	`getShouldDisplayOnHostView()`
`CBViewProtocol.CBViewBase`	`getView()`
`CBViewProtocol`	`getViewProtocol()`
`void`	`notifyDidCompleteAd()`
`void`	`onAnimateInBegin()`
`void`	`onAnimateInFinish()`
`boolean`	`onBackPressed()` return true if we should swallow the back button event
`boolean`	`onClick(JSONObject clickCoordinates)`
`void`	`onClickExchange(java.lang.String url, JSONObject clickCoordinates)`
`void`	`onClose()`
`void`	`onDisplay()`
`void`	`onFailure(CBError.CBImpressionError error)`
`void`	`onHide()`
`void`	`onHideAll()`
`void`	`onPause()`
`void`	`onPlaybackCompleted()`
`void`	`onPlaybackStarted()`
`void`	`onResume()`
`void`	`onShow()`
`void`	`onShowAll()`
`void`	`onStart()`
`boolean`	`prepare()`
`boolean`	`reinitialize()` call this to attempt to recreate the view of a previously shown impression.
`void`	`sendVideoCompleteRequest()`
`void`	`setOnShowTask(java.lang.Runnable task)`
`boolean`	`shouldDismissAfterClick()`
`void`	`shownFully()` for an impression that needs to show some UI elements before fully shown (eg a rewarded view that can be declined), call this to indicate when it has definitely been fully shown.
`CBError.CBImpressionError`	`tryCreatingView(RelativeLayout hostView)` Attempt to create the view associated with this view protocol's impression.
`boolean`	`wasClosed()`

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

Field Detail

mediaType
```
public int mediaType
```

state
```
public int state
```

adTypeTraits
```
public final AdTypeTraits adTypeTraits
```

fileCache
```
public final FileCache fileCache
```

networkService

public final CBNetworkService networkService

requestBodyFields

public final RequestBodyFields requestBodyFields

track
```
public final CBTrack track
```

uiHandler
```
public final Handler uiHandler
```

uiManager
```
public final CBUIManager uiManager
```

urlOpener
```
public final CBURLOpener urlOpener
```

viewController

public final CBViewController viewController

webImageCache

public final CBWebImageCache webImageCache

callback

public final ImpressionCallback callback

location
```
public final java.lang.String location
```

templateHtml

public final java.lang.String templateHtml

adUnit
```
public final AdUnit adUnit
```

sharedPreferences

public final SharedPreferences sharedPreferences

clickRequest
```
public CBRequest clickRequest
```

parentView
```
public PopupImpressionView parentView
```

isShowProcessed
```
public boolean isShowProcessed
```
Use this to indicate if the fact that tasks that must be run upon showing and impression have been processed. Use this to avoid, for example, notifying the server twice.

animatingIn
```
public boolean animatingIn
```

playbackDidComplete
```
public boolean playbackDidComplete
```

playbackDidStart
```
public boolean playbackDidStart
```

clicked
```
public boolean clicked
```

isPaused
```
public boolean isPaused
```

closed
```
public boolean closed
```

Constructor Detail

CBImpression

public CBImpression(AdUnit adUnit,
                    ImpressionCallback callback,
                    FileCache fileCache,
                    CBNetworkService networkService,
                    RequestBodyFields requestBodyFields,
                    SharedPreferences sharedPreferences,
                    CBTrack track,
                    Handler uiHandler,
                    CBUIManager uiManager,
                    CBURLOpener urlOpener,
                    CBViewController viewController,
                    CBWebImageCache webImageCache,
                    AdTypeTraits adTypeTraits,
                    java.lang.String location,
                    java.lang.String templateHtml,
                    RelativeLayout externalView,
                    PrivacyPresenter privacyPresenter)

Method Detail
- prepare
```
public boolean prepare()
```
- shouldDismissAfterClick
```
public boolean shouldDismissAfterClick()
```
- onClose
```
public void onClose()
```
- onDisplay
```
public void onDisplay()
```
- onClickExchange
```
public void onClickExchange(java.lang.String url,
                            JSONObject clickCoordinates)
```
- onClick
```
public boolean onClick(JSONObject clickCoordinates)
```
- onFailure
```
public void onFailure(CBError.CBImpressionError error)
```
- onPlaybackCompleted
```
public void onPlaybackCompleted()
```
- notifyDidCompleteAd
```
public void notifyDidCompleteAd()
```
- onPlaybackStarted
```
public void onPlaybackStarted()
```
- reinitialize
```
public boolean reinitialize()
```
  call this to attempt to recreate the view of a previously shown impression. Returns true if successful. If the assets are still loading, it will return false, and the view will still be created once the assets finish loading.
- destroy
```
public void destroy()
```
  destroy impression's view and view data
- cleanUpViews
```
public void cleanUpViews()
```
  destroy just the impression's views, not associated data
- tryCreatingView
```
public CBError.CBImpressionError tryCreatingView(RelativeLayout hostView)
```
  Attempt to create the view associated with this view protocol's impression. Fails if it is not time to create the view, or there was an error trying to create the view (no current activity, for example).
  
  Parameters:
  
  hostView - if this is present, the impression will be added to the hostView instead of the fullscreen activity
  
  Returns:
  
  An error status code if unsuccessful, otherwise null.
- getView
```
public CBViewProtocol.CBViewBase getView()
```
- onShow
```
public void onShow()
```
- onHide
```
public void onHide()
```
- onShowAll
```
public void onShowAll()
```
- onHideAll
```
public void onHideAll()
```
- setOnShowTask
```
public void setOnShowTask(java.lang.Runnable task)
```
- onAnimateInBegin
```
public void onAnimateInBegin()
```
- onAnimateInFinish
```
public void onAnimateInFinish()
```
- getAdID
```
public java.lang.String getAdID()
```
- shownFully
```
public void shownFully()
```
  for an impression that needs to show some UI elements before fully shown (eg a rewarded view that can be declined), call this to indicate when it has definitely been fully shown. feel free to call more than once, subsequent calls will have no effect.
- onBackPressed
```
public boolean onBackPressed()
```
  return true if we should swallow the back button event
- onResume
```
public void onResume()
```
- onStart
```
public void onStart()
```
- onPause
```
public void onPause()
```
- getViewProtocol
```
public CBViewProtocol getViewProtocol()
```
- wasClosed
```
public boolean wasClosed()
```
- sendVideoCompleteRequest
```
public void sendVideoCompleteRequest()
```
- getHostView
```
public RelativeLayout getHostView()
```
- getShouldDisplayOnHostView
```
public java.lang.Boolean getShouldDisplayOnHostView()
```

Class CBImpression

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mediaType

state

adTypeTraits

fileCache

networkService

requestBodyFields

track

uiHandler

uiManager

urlOpener

viewController

webImageCache

callback

location

templateHtml

adUnit

sharedPreferences

clickRequest

parentView

isShowProcessed

animatingIn

playbackDidComplete

playbackDidStart

clicked

isPaused

closed

Constructor Detail

CBImpression

Method Detail

prepare

shouldDismissAfterClick

onClose

onDisplay

onClickExchange

onClick

onFailure

onPlaybackCompleted

notifyDidCompleteAd

onPlaybackStarted

reinitialize

destroy

cleanUpViews

tryCreatingView

getView

onShow

onHide

onShowAll

onHideAll

setOnShowTask

onAnimateInBegin

onAnimateInFinish

getAdID

shownFully

onBackPressed

onResume

onStart

onPause

getViewProtocol

wasClosed

sendVideoCompleteRequest

getHostView

getShouldDisplayOnHostView