Display SDK/com.smartadserver.android.library.ui/SASAdView

SASAdView

abstract class SASAdView : FrameLayout, SCSViewabilityManagerListener, SCSCustomerFeedbackController.SCSCustomerFeedbackControllerListener

This abstract class is an Android View in charge of loading and displaying ads.

Inheritors

SASBannerView

Constructors

SASAdView

constructor(@NonNull context: Context)

Creates a SASAdView instance

constructor(@NonNull context: Context, @Nullable attributeSet: AttributeSet)

Constructor for creation in the XML layout file

Types

MessageHandler

interface MessageHandler

Interface definition for classes handling multi-purpose messages sent by SASAdView instances

NativeVideoStateListener

interface NativeVideoStateListener

Listener that is notified when the video is prepared and completed.

OnCrashListener

interface OnCrashListener

Interface for Objects handling fatal crashes that occurred on underlying WebViews of the passed SASAdView and caught by appropriate WebViewClient

StateChangeEvent

open class StateChangeEvent

Event fired by the SASAdView when its states changes.

VideoEvents

interface VideoEvents

Interface defining video events

Properties

closeButton

@NonNull

open val closeButton: SASCloseButton

EXPAND_ALIGN_CENTER

val EXPAND_ALIGN_CENTER: Int = 8

Bitmask constant specifying that this view should remain horizontally centered the expand method is called.

EXPAND_ALIGN_LEFT

val EXPAND_ALIGN_LEFT: Int = 4

Bitmask constant specifying that this view should remain aligned to its left border when the expand method is called.

EXPAND_ALIGN_RIGHT

val EXPAND_ALIGN_RIGHT: Int = 16

Bitmask constant specifying that the view should remain aligned to its right border when the expand method is called.

EXPAND_FROM_BOTTOM

val EXPAND_FROM_BOTTOM: Int = 2

Bitmask constant specifying that this view should expand upwards when the expand method is called.

EXPAND_FROM_TOP

val EXPAND_FROM_TOP: Int = 1

Bitmask constant specifying that this view should expand downwards when the expand method is called.

mBidderAdapter

@Nullable

open var mBidderAdapter: SASBidderAdapter

nativeVideoStateListener

@Nullable

@get:Nullable

open var nativeVideoStateListener: SASAdView.NativeVideoStateListener

onCrashListener

@Nullable

@get:Nullable

open var onCrashListener: SASAdView.OnCrashListener

Application set OnCrashListener to be notified when any of the internal webviews has crashed.

Functions

open fun close()

Closes this ad view (according to MRAID specifications)

collapse

open fun collapse()

Collapses this ad view, if was expanded,according to MRAID specifications.

dismissStickyMode

open fun dismissStickyMode(animate: Boolean)

deactivate sticky mode and disable it until this SASADView load a new ad

executeOnUIThread

open fun executeOnUIThread(@NonNull r: Runnable)

open fun executeOnUIThread(@NonNull r: Runnable, wait: Boolean)

Utility method to execute a runnable on the Android main thread (UI thread).

expand

open fun expand(width: Int, height: Int, lockOrientation: Boolean)

Expands this SASAdView to the specified size and locks activity orientation if specified

open fun expand(@Nullable url: String, width: Int, height: Int)

Expands this SASAdView to the specified size and opens url (if not null) in the internal browser

open fun expand(@Nullable url: String, width: Int, height: Int, lockOrientation: Boolean)

open fun expand(@Nullable url: String, width: Int, height: Int, lockOrientation: Boolean, @Nullable forceOrientation: String)

open fun expand(@Nullable url: String, width: Int, height: Int, offsetX: Int, offsetY: Int, useExpandPolicy: Boolean, allowOffscreen: Boolean, lockOrientation: Boolean, @Nullable forceOrientation: String, isModal: Boolean)

Expands this SASAdView to the specified size and opens url (if not null) in the internal browser, and locks activity orientation if specified

getCloseButtonBitmap

@Nullable

open fun getCloseButtonBitmap(): Bitmap

Returns the custom Bitmap used for the close button in all SASAdView instances

getCloseButtonDrawable

@Nullable

open fun getCloseButtonDrawable(): Drawable

Returns the custom Drawable used for the close button in all SASAdView instances

getCurrentAdElement

@Nullable

open fun getCurrentAdElement(): SASAdElement

Returns the current SASAdElement being displayed by this SASAdView

getCurrentAdPlacement

@Nullable

open fun getCurrentAdPlacement(): SASAdPlacement

Returns the current SASAdPlacement being displayed by this SASAdView

getCurrentBounds

@NonNull

open fun getCurrentBounds(): Rect

Returns the current bounds of this SASAdView with respect to its top container

getDefaultBounds

@NonNull

open fun getDefaultBounds(): Rect

Returns the default bounds of this SASAdView (when it is not expanded or resized) with respect to its top container

getExpandParentContainer

@Nullable

open fun getExpandParentContainer(): FrameLayout

Returns the FrameLayout parent container in which this SASAdView will place itself when switching to StateChangeEvent#VIEW_EXPANDED state.

getExpandPolicy

open fun getExpandPolicy(): Int

Returns the current anchor position when expanding this view (non full screen)

getExpectedFormatType

@NonNull

abstract fun getExpectedFormatType(): SASFormatType

Returns the SASFormatType expected by this SASAdView

getLoaderView

@Nullable

open fun getLoaderView(): View

Returns the View that is displayed on top of this ad view while the ad is being fetched

getMessageHandler

@Nullable

open fun getMessageHandler(): SASAdView.MessageHandler

Gets the MessageHandler instance on this SASAdView

getOptimalHeight

open fun getOptimalHeight(): Int

Given the current width of this SASAdView and the current creative loaded (if any), returns the recommended height (in pixels) for this SASAdView to respect the creative's ratio (portrait as well as landscape if different)

open fun getOptimalHeight(width: Int): Int

Given specified width in parameter and the current creative loaded (if any), returns the recommended height (in pixels) for this SASAdView to respect the creative's ratio (portrait as well as landscape if different)

getRatio

open fun getRatio(): Double

Returns the optimal ratio for this SASAdView to respect the creative ratio in the current screen orientation You can leverage this value to adapt the size of the SASAdView instance to fit the displayed creative

handleKeyUpEvent

open fun handleKeyUpEvent(keyCode: Int, @NonNull event: KeyEvent)

Handle hardware keys keyUp events.

installLoaderView

abstract fun installLoaderView(@NonNull loaderView: View)

Installs the specified loader view in the application.

isCloseOnclick

open fun isCloseOnclick(): Boolean

Returns whether an expanded ad should be closed when the ad is clicked.

isExpanded

open fun isExpanded(): Boolean

Returns whether this SASAdView is in expanded state

isFullScreenExpand

open fun isFullScreenExpand(): Boolean

isResized

open fun isResized(): Boolean

Returns whether this SASAdView is in resized state

isUnityModeEnabled

open fun isUnityModeEnabled(): Boolean

Returns whether the Unity compatibility mode is enabled.

isVideoViewZOrderOnTop

open fun isVideoViewZOrderOnTop(): Boolean

Wether the SDK activate or not zOrderOnTop value for internal VideoView

loadAd

open fun loadAd(@NonNull biddingAdResponse: SASBiddingAdResponse)

Loads the ad contained in the adElementWrapper of the given SASBiddingAdResponse.

open fun loadAd(@NonNull adPlacement: SASAdPlacement)

open fun loadAd(@NonNull adPlacement: SASAdPlacement, @Nullable securedTransactionToken: String)

Loads an ad in this SASAdView.

open fun loadAd(@NonNull adPlacement: SASAdPlacement, @Nullable bidderAdapter: SASBidderAdapter)

open fun loadAd(@NonNull adPlacement: SASAdPlacement, @Nullable bidderAdapter: SASBidderAdapter, @Nullable securedTransactionToken: String)

Loads an ad in this SASAdView using a bidder adapter.

onCustomerFeedbackDialogDismissed

open fun onCustomerFeedbackDialogDismissed(shouldCloseAd: Boolean)

onCustomerFeedbackDialogShow

open fun onCustomerFeedbackDialogShow()

onDestroy

open fun onDestroy()

This method must be called when the activity (that this view is attached to) is destroyed (typically in the onDestroy() method of the activity).

onKeyPreIme

open fun onKeyPreIme(keyCode: Int, @NonNull event: KeyEvent): Boolean

open

open fun open(@Nullable url: String)

Opens the specified URL in an internal WebView browser within the application

raiseError

open fun raiseError(@NonNull errorMessage: String, @NonNull javascriptEvent: String)

Raise an error which is forwarded to the mraid javascript bridge.

removeLoaderView

abstract fun removeLoaderView(@NonNull loaderView: View)

Removes the specified loader view from the application.

removeStateChangeListener

open fun removeStateChangeListener(@NonNull stateListener: SASAdView.OnStateChangeListener): Boolean

Removes a specified OnStateChangeListener from this view

reset

open fun reset()

Collapses this view and prepares it for a fresh loadAd call.

sendJavascriptEvent

open fun sendJavascriptEvent(@NonNull eventName: String, @Nullable parameters: ArrayList<String>)

Send javascript event to the bridge.

sendMessageToWebView

open fun sendMessageToWebView(@NonNull message: String)

Sends a message to the WebView.

setBackButtonHandlingEnabled

open fun setBackButtonHandlingEnabled(enabled: Boolean)

Allow or disallow the SASAdView to intercept Android back button action to close/collapse in full screen expand cases (instead of letting the host activity to decide) Default is true.

setCloseButtonBitmap