Class POBBannerView
-
- All Implemented Interfaces:
-
android.graphics.drawable.Drawable.Callback,android.view.KeyEvent.Callback,android.view.ViewManager,android.view.ViewParent,android.view.accessibility.AccessibilityEventSource,com.pubmatic.sdk.openwrap.core.POBBidEvent
@MainThread() public class POBBannerView extends FrameLayout implements POBBidEvent
The view class that displays the banner ad.
It renders a banner ad from either the ad server SDK or open wrap partner whichever gets a chance in the auction.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classPOBBannerView.POBBannerViewListenerStatic member class for interaction with the POBBannerView. All methods are guaranteed to occur on the main thread.
-
Field Summary
Fields Modifier and Type Field Description public final static intFOCUS_AFTER_DESCENDANTSpublic final static intFOCUS_BEFORE_DESCENDANTSpublic final static intFOCUS_BLOCK_DESCENDANTSpublic final static intLAYOUT_MODE_CLIP_BOUNDSpublic final static intLAYOUT_MODE_OPTICAL_BOUNDSpublic final static intPERSISTENT_ALL_CACHESpublic final static intPERSISTENT_ANIMATION_CACHEpublic final static intPERSISTENT_NO_CACHEpublic final static intPERSISTENT_SCROLLING_CACHEpublic final static intACCESSIBILITY_DATA_SENSITIVE_AUTOpublic final static intACCESSIBILITY_DATA_SENSITIVE_NOpublic final static intACCESSIBILITY_DATA_SENSITIVE_YESpublic final static intACCESSIBILITY_LIVE_REGION_ASSERTIVEpublic final static intACCESSIBILITY_LIVE_REGION_NONEpublic final static intACCESSIBILITY_LIVE_REGION_POLITEpublic final static Property<View, Float>ALPHApublic final static intAUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWSpublic final static StringAUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATEpublic final static StringAUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAYpublic final static StringAUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTHpublic final static StringAUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEARpublic final static StringAUTOFILL_HINT_CREDIT_CARD_NUMBERpublic final static StringAUTOFILL_HINT_CREDIT_CARD_SECURITY_CODEpublic final static StringAUTOFILL_HINT_EMAIL_ADDRESSpublic final static StringAUTOFILL_HINT_NAMEpublic final static StringAUTOFILL_HINT_PASSWORDpublic final static StringAUTOFILL_HINT_PHONEpublic final static StringAUTOFILL_HINT_POSTAL_ADDRESSpublic final static StringAUTOFILL_HINT_POSTAL_CODEpublic final static StringAUTOFILL_HINT_USERNAMEpublic final static intAUTOFILL_TYPE_DATEpublic final static intAUTOFILL_TYPE_LISTpublic final static intAUTOFILL_TYPE_NONEpublic final static intAUTOFILL_TYPE_TEXTpublic final static intAUTOFILL_TYPE_TOGGLEpublic final static intDRAG_FLAG_ACCESSIBILITY_ACTIONpublic final static intDRAG_FLAG_GLOBALpublic final static intDRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSIONpublic final static intDRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSIONpublic final static intDRAG_FLAG_GLOBAL_URI_READpublic final static intDRAG_FLAG_GLOBAL_URI_WRITEpublic final static intDRAG_FLAG_OPAQUEpublic final static intDRAWING_CACHE_QUALITY_AUTOpublic final static intDRAWING_CACHE_QUALITY_HIGHpublic final static intDRAWING_CACHE_QUALITY_LOWpublic final static intFIND_VIEWS_WITH_CONTENT_DESCRIPTIONpublic final static intFIND_VIEWS_WITH_TEXTpublic final static intFOCUSABLEpublic final static intFOCUSABLES_ALLpublic final static intFOCUSABLES_TOUCH_MODEpublic final static intFOCUSABLE_AUTOpublic final static intFOCUS_BACKWARDpublic final static intFOCUS_DOWNpublic final static intFOCUS_FORWARDpublic final static intFOCUS_LEFTpublic final static intFOCUS_RIGHTpublic final static intFOCUS_UPpublic final static intGONEpublic final static intHAPTIC_FEEDBACK_ENABLEDpublic final static intIMPORTANT_FOR_ACCESSIBILITY_AUTOpublic final static intIMPORTANT_FOR_ACCESSIBILITY_NOpublic final static intIMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTSpublic final static intIMPORTANT_FOR_ACCESSIBILITY_YESpublic final static intIMPORTANT_FOR_AUTOFILL_AUTOpublic final static intIMPORTANT_FOR_AUTOFILL_NOpublic final static intIMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTSpublic final static intIMPORTANT_FOR_AUTOFILL_YESpublic final static intIMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTSpublic final static intIMPORTANT_FOR_CONTENT_CAPTURE_AUTOpublic final static intIMPORTANT_FOR_CONTENT_CAPTURE_NOpublic final static intIMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTSpublic final static intIMPORTANT_FOR_CONTENT_CAPTURE_YESpublic final static intIMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTSpublic final static intINVISIBLEpublic final static intKEEP_SCREEN_ONpublic final static intLAYER_TYPE_HARDWAREpublic final static intLAYER_TYPE_NONEpublic final static intLAYER_TYPE_SOFTWAREpublic final static intLAYOUT_DIRECTION_INHERITpublic final static intLAYOUT_DIRECTION_LOCALEpublic final static intLAYOUT_DIRECTION_LTRpublic final static intLAYOUT_DIRECTION_RTLpublic final static intMEASURED_HEIGHT_STATE_SHIFTpublic final static intMEASURED_SIZE_MASKpublic final static intMEASURED_STATE_MASKpublic final static intMEASURED_STATE_TOO_SMALLpublic final static intNOT_FOCUSABLEpublic final static intNO_IDpublic final static intOVER_SCROLL_ALWAYSpublic final static intOVER_SCROLL_IF_CONTENT_SCROLLSpublic final static intOVER_SCROLL_NEVERpublic final static Property<View, Float>ROTATIONpublic final static Property<View, Float>ROTATION_Xpublic final static Property<View, Float>ROTATION_Ypublic final static Property<View, Float>SCALE_Xpublic final static Property<View, Float>SCALE_Ypublic final static intSCREEN_STATE_OFFpublic final static intSCREEN_STATE_ONpublic final static intSCROLLBARS_INSIDE_INSETpublic final static intSCROLLBARS_INSIDE_OVERLAYpublic final static intSCROLLBARS_OUTSIDE_INSETpublic final static intSCROLLBARS_OUTSIDE_OVERLAYpublic final static intSCROLLBAR_POSITION_DEFAULTpublic final static intSCROLLBAR_POSITION_LEFTpublic final static intSCROLLBAR_POSITION_RIGHTpublic final static intSCROLL_AXIS_HORIZONTALpublic final static intSCROLL_AXIS_NONEpublic final static intSCROLL_AXIS_VERTICALpublic final static intSCROLL_CAPTURE_HINT_AUTOpublic final static intSCROLL_CAPTURE_HINT_EXCLUDEpublic final static intSCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTSpublic final static intSCROLL_CAPTURE_HINT_INCLUDEpublic final static intSCROLL_INDICATOR_BOTTOMpublic final static intSCROLL_INDICATOR_ENDpublic final static intSCROLL_INDICATOR_LEFTpublic final static intSCROLL_INDICATOR_RIGHTpublic final static intSCROLL_INDICATOR_STARTpublic final static intSCROLL_INDICATOR_TOPpublic final static intSOUND_EFFECTS_ENABLEDpublic final static intSTATUS_BAR_HIDDENpublic final static intSTATUS_BAR_VISIBLEpublic final static intSYSTEM_UI_FLAG_FULLSCREENpublic final static intSYSTEM_UI_FLAG_HIDE_NAVIGATIONpublic final static intSYSTEM_UI_FLAG_IMMERSIVEpublic final static intSYSTEM_UI_FLAG_IMMERSIVE_STICKYpublic final static intSYSTEM_UI_FLAG_LAYOUT_FULLSCREENpublic final static intSYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATIONpublic final static intSYSTEM_UI_FLAG_LAYOUT_STABLEpublic final static intSYSTEM_UI_FLAG_LIGHT_NAVIGATION_BARpublic final static intSYSTEM_UI_FLAG_LIGHT_STATUS_BARpublic final static intSYSTEM_UI_FLAG_LOW_PROFILEpublic final static intSYSTEM_UI_FLAG_VISIBLEpublic final static intSYSTEM_UI_LAYOUT_FLAGSpublic final static intTEXT_ALIGNMENT_CENTERpublic final static intTEXT_ALIGNMENT_GRAVITYpublic final static intTEXT_ALIGNMENT_INHERITpublic final static intTEXT_ALIGNMENT_TEXT_ENDpublic final static intTEXT_ALIGNMENT_TEXT_STARTpublic final static intTEXT_ALIGNMENT_VIEW_ENDpublic final static intTEXT_ALIGNMENT_VIEW_STARTpublic final static intTEXT_DIRECTION_ANY_RTLpublic final static intTEXT_DIRECTION_FIRST_STRONGpublic final static intTEXT_DIRECTION_FIRST_STRONG_LTRpublic final static intTEXT_DIRECTION_FIRST_STRONG_RTLpublic final static intTEXT_DIRECTION_INHERITpublic final static intTEXT_DIRECTION_LOCALEpublic final static intTEXT_DIRECTION_LTRpublic final static intTEXT_DIRECTION_RTLpublic final static Property<View, Float>TRANSLATION_Xpublic final static Property<View, Float>TRANSLATION_Ypublic final static Property<View, Float>TRANSLATION_Zpublic final static intVISIBLEpublic final static Property<View, Float>Xpublic final static Property<View, Float>Ypublic final static Property<View, Float>Z
-
Constructor Summary
Constructors Constructor Description POBBannerView(Context context)Used to create instances when placed in XML layouts. POBBannerView(Context context, AttributeSet attrs)Used to create instances when placed in XML layouts. POBBannerView(Context context, AttributeSet attrs, int defStyle)Used to create instances when placed in XML layouts with default style. POBBannerView(Context context, String publisherId, int profileId, String adUnitId, Array<POBAdSize> adSizes)Constructor Initializes and returns a newly allocated banner view object for supporting 'No Ad Server Configuration' Publisher should create object of POBBannerView using this constructor when instantiating from code. POBBannerView(Context context, String publisherId, int profileId, String adUnitId, POBBannerEvent event)Constructor Initializes and returns a newly allocated banner view object Publisher should create object of POBBannerView using this constructor when instantiating from java code.
-
Method Summary
Modifier and Type Method Description voidinit(@NonNull() String publisherId, int profileId, @NonNull() String adUnitId, @NonNull() POBBannerEvent event)Initializes newly allocated banner view object. voiddestroy()Invoke this method when your activity/fragment is about to destroy. voidpauseAutoRefresh()Pauses the auto refresh, By default, banner refreshes automatically as per configured refresh interval on OpenWrap portal. voidresumeAutoRefresh()Resumes the auto-refresh as per configured refresh interval on OpenWrap portal, call this method only if you have previously paused auto-refresh using `pauseAutoRefresh()`. voidinit(@NonNull() String publisherId, int profileId, @NonNull() String adUnitId, @NonNull() Array<POBAdSize> adSizes)Initializes newly allocated banner view object for supporting 'No Ad Server Configuration' Invoke this method only if POBBannerView is inflated via xml resource. voidloadAd()Initiate the loading of a banner ad, if the POBRequest is available then it proceeds with further execution else it will log error voidloadAd(@NonNull() String bidResponse)Initiates the loading of a banner ad with oRTB bid response. booleanforceRefresh()Cancels existing ad requests and initiates new ad request. POBImpressiongetImpression()Returns an instance of impression object created internally. POBRequestgetAdRequest()Returns an Object representing OpenWrap ad request. voidsetListener(@Nullable() POBBannerView.POBBannerViewListener listener)Sets instance of POBBannerViewListener for the Banner view. booleanproceedToLoadAd()voidproceedOnError(@NonNull() POBBidEvent.BidEventError error, @NonNull() String errorMessage)POBBidgetBid()Get bid POBAdSizegetCreativeSize()Returns the Size of the rendered ad creative voidsetBidEventListener(@Nullable() POBBidEventListener bidEventListener)Sets the BidEventListener for the ad view Note: Proper reference management practices should be observed when using this listener -
Methods inherited from class android.widget.FrameLayout
generateLayoutParams, getAccessibilityClassName, getConsiderGoneChildrenWhenMeasuring, getMeasureAllChildren, setForegroundGravity, setMeasureAllChildren, shouldDelayChildPressedState -
Methods inherited from class android.view.ViewGroup
addChildrenForAccessibility, addExtraDataToAccessibilityNodeInfo, addFocusables, addKeyboardNavigationClusters, addStatesFromChildren, addTouchables, addView, bringChildToFront, childDrawableStateChanged, childHasTransientStateChanged, clearChildFocus, clearDisappearingChildren, clearFocus, dispatchApplyWindowInsets, dispatchCapturedPointerEvent, dispatchConfigurationChanged, dispatchCreateViewTranslationRequest, dispatchDisplayHint, dispatchDragEvent, dispatchDrawableHotspotChanged, dispatchFinishTemporaryDetach, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchPointerCaptureChanged, dispatchProvideAutofillStructure, dispatchProvideStructure, dispatchScrollCaptureSearch, dispatchSetActivated, dispatchSetSelected, dispatchStartTemporaryDetach, dispatchSystemUiVisibilityChanged, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchWindowFocusChanged, dispatchWindowInsetsAnimationEnd, dispatchWindowInsetsAnimationPrepare, dispatchWindowInsetsAnimationProgress, dispatchWindowInsetsAnimationStart, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, endViewTransition, findFocus, findOnBackInvokedDispatcherForChild, findViewsWithText, focusSearch, focusableViewAvailable, gatherTransparentRegion, getChildAt, getChildCount, getChildMeasureSpec, getChildVisibleRect, getClipChildren, getClipToPadding, getDescendantFocusability, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getLayoutMode, getLayoutTransition, getNestedScrollAxes, getOverlay, getPersistentDrawingCache, getTouchscreenBlocksFocus, hasFocus, hasTransientState, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isLayoutSuppressed, isMotionEventSplittingEnabled, isTransitionGroup, jumpDrawablesToCurrentState, layout, notifySubtreeAccessibilityStateChanged, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onDescendantInvalidated, onInterceptHoverEvent, onInterceptTouchEvent, onNestedFling, onNestedPreFling, onNestedPrePerformAccessibilityAction, onNestedPreScroll, onNestedScroll, onNestedScrollAccepted, onRequestSendAccessibilityEvent, onResolvePointerIcon, onStartNestedScroll, onStopNestedScroll, onViewAdded, onViewRemoved, recomputeViewAttributes, removeAllViews, removeAllViewsInLayout, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestChildFocus, requestChildRectangleOnScreen, requestDisallowInterceptTouchEvent, requestFocus, requestSendAccessibilityEvent, requestTransparentRegion, restoreDefaultFocus, scheduleLayoutAnimation, setAddStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setClipChildren, setClipToPadding, setDescendantFocusability, setLayoutAnimation, setLayoutAnimationListener, setLayoutMode, setLayoutTransition, setMotionEventSplittingEnabled, setOnHierarchyChangeListener, setPersistentDrawingCache, setTouchscreenBlocksFocus, setTransitionGroup, setWindowInsetsAnimationCallback, showContextMenuForChild, startActionModeForChild, startLayoutAnimation, startViewTransition, suppressLayout, updateViewLayout -
Methods inherited from class android.view.View
addOnAttachStateChangeListener, addOnLayoutChangeListener, addOnUnhandledKeyEventListener, animate, announceForAccessibility, autofill, bringToFront, buildDrawingCache, buildLayer, callOnClick, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, cancelDragAndDrop, cancelLongPress, cancelPendingInputEvents, checkInputConnectionProxy, clearAnimation, clearViewTranslationCallback, combineMeasuredStates, computeScroll, computeSystemWindowInsets, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchGenericMotionEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPopulateAccessibilityEvent, draw, drawableHotspotChanged, findOnBackInvokedDispatcher, findViewById, findViewWithTag, forceHasOverlappingRendering, forceLayout, generateDisplayHash, generateViewId, getAccessibilityDelegate, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityPaneTitle, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAllowedHandwritingDelegatePackageName, getAllowedHandwritingDelegatorPackageName, getAlpha, getAnimation, getAnimationMatrix, getApplicationWindowToken, getAttributeResolutionStack, getAttributeSourceResourceMap, getAutofillHints, getAutofillId, getAutofillType, getAutofillValue, getBackground, getBackgroundTintBlendMode, getBackgroundTintList, getBackgroundTintMode, getBaseline, getBottom, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentCaptureSession, getContentDescription, getContext, getDefaultFocusHighlightEnabled, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getExplicitStyle, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusable, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintBlendMode, getForegroundTintList, getForegroundTintMode, getGlobalVisibleRect, getHandler, getHandwritingBoundsOffsetBottom, getHandwritingBoundsOffsetLeft, getHandwritingBoundsOffsetRight, getHandwritingBoundsOffsetTop, getHandwritingDelegatorCallback, getHasOverlappingRendering, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarThumbDrawable, getHorizontalScrollbarTrackDrawable, getId, getImportantForAccessibility, getImportantForAutofill, getImportantForContentCapture, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLocalVisibleRect, getLocationInSurface, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextClusterForwardId, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineAmbientShadowColor, getOutlineProvider, getOutlineSpotShadowColor, getOverScrollMode, getOverlay, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPivotX, getPivotY, getPointerIcon, getPreferKeepClearRects, getReceiveContentMimeTypes, getResources, getRevealOnFocusHint, getRight, getRootSurfaceControl, getRootView, getRootWindowInsets, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollCaptureHint, getScrollIndicators, getScrollX, getScrollY, getSolidColor, getSourceLayoutResId, getStateDescription, getStateListAnimator, getSystemGestureExclusionRects, getSystemUiVisibility, getTag, getTextAlignment, getTextDirection, getTooltipText, getTop, getTouchDelegate, getTouchables, getTransitionAlpha, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getUniqueDrawingId, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarThumbDrawable, getVerticalScrollbarTrackDrawable, getVerticalScrollbarWidth, getViewTranslationResponse, getViewTreeObserver, getVisibility, getWidth, getWindowId, getWindowInsetsController, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasExplicitFocusable, hasFocusable, hasNestedScrollingParent, hasOnClickListeners, hasOnLongClickListeners, hasOverlappingRendering, hasPointerCapture, hasWindowFocus, inflate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityDataSensitive, isAccessibilityFocused, isAccessibilityHeading, isActivated, isAttachedToWindow, isAutoHandwritingEnabled, isClickable, isContextClickable, isCredential, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isFocusedByDefault, isForceDarkAllowed, isHandwritingDelegate, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isImportantForAutofill, isImportantForContentCapture, isInEditMode, isInLayout, isInTouchMode, isKeyboardNavigationCluster, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingRelative, isPivotSet, isPreferKeepClear, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScreenReaderFocusable, isScrollContainer, isScrollbarFadingEnabled, isSelected, isShowingLayoutBounds, isShown, isSoundEffectsEnabled, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, isVisibleToUserForAutofill, keyboardNavigationClusterSearch, measure, offsetLeftAndRight, offsetTopAndBottom, onApplyWindowInsets, onCancelPendingInputEvents, onCapturedPointerEvent, onCheckIsTextEditor, onCreateInputConnection, onCreateViewTranslationRequest, onCreateVirtualViewTranslationRequests, onDragEvent, onDrawForeground, onFilterTouchEventForSecurity, onFinishTemporaryDetach, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onPointerCaptureChange, onPopulateAccessibilityEvent, onProvideAutofillStructure, onProvideAutofillVirtualStructure, onProvideContentCaptureStructure, onProvideStructure, onProvideVirtualStructure, onReceiveContent, onRtlPropertiesChanged, onScreenStateChanged, onScrollCaptureSearch, onStartTemporaryDetach, onTouchEvent, onTrackballEvent, onViewTranslationResponse, onVirtualViewTranslationResponses, onVisibilityAggregated, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, performAccessibilityAction, performClick, performContextClick, performHapticFeedback, performLongClick, performReceiveContent, playSoundEffect, post, postDelayed, postInvalidate, postInvalidateDelayed, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, releasePointerCapture, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, removeOnUnhandledKeyEventListener, requestApplyInsets, requestFitSystemWindows, requestFocusFromTouch, requestLayout, requestPointerCapture, requestRectangleOnScreen, requestUnbufferedDispatch, requireViewById, resetPivot, resolveSize, resolveSizeAndState, restoreHierarchyState, saveAttributeDataForStyleable, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDataSensitive, setAccessibilityDelegate, setAccessibilityHeading, setAccessibilityLiveRegion, setAccessibilityPaneTitle, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAllowClickWhenDisabled, setAllowedHandwritingDelegatePackage, setAllowedHandwritingDelegatorPackage, setAlpha, setAnimation, setAnimationMatrix, setAutoHandwritingEnabled, setAutofillHints, setAutofillId, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintBlendMode, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentCaptureSession, setContentDescription, setContextClickable, setDefaultFocusHighlightEnabled, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusableInTouchMode, setFocusedByDefault, setForceDarkAllowed, setForeground, setForegroundTintBlendMode, setForegroundTintList, setForegroundTintMode, setHandwritingBoundsOffsets, setHandwritingDelegatorCallback, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHorizontalScrollbarThumbDrawable, setHorizontalScrollbarTrackDrawable, setHovered, setId, setImportantForAccessibility, setImportantForAutofill, setImportantForContentCapture, setIsCredential, setIsHandwritingDelegate, setKeepScreenOn, setKeyboardNavigationCluster, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLeftTopRightBottom, setLongClickable, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextClusterForwardId, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnCapturedPointerListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnReceiveContentListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineAmbientShadowColor, setOutlineProvider, setOutlineSpotShadowColor, setOverScrollMode, setPadding, setPaddingRelative, setPivotX, setPivotY, setPointerIcon, setPreferKeepClear, setPreferKeepClearRects, setPressed, setRenderEffect, setRevealOnFocusHint, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScreenReaderFocusable, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollBarSize, setScrollBarStyle, setScrollCaptureCallback, setScrollCaptureHint, setScrollContainer, setScrollIndicators, setScrollX, setScrollY, setScrollbarFadingEnabled, setSelected, setSoundEffectsEnabled, setStateDescription, setStateListAnimator, setSystemGestureExclusionRects, setSystemUiVisibility, setTag, setTextAlignment, setTextDirection, setTooltipText, setTop, setTouchDelegate, setTransitionAlpha, setTransitionName, setTransitionVisibility, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVerticalScrollbarThumbDrawable, setVerticalScrollbarTrackDrawable, setViewTranslationCallback, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, startActionMode, startAnimation, startDrag, startDragAndDrop, startNestedScroll, stopNestedScroll, toString, transformMatrixToGlobal, transformMatrixToLocal, unscheduleDrawable, updateDragShadow, willNotCacheDrawing, willNotDraw -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
POBBannerView
POBBannerView(Context context)
Used to create instances when placed in XML layouts.- Parameters:
context- Activity context
-
POBBannerView
POBBannerView(Context context, AttributeSet attrs)
Used to create instances when placed in XML layouts.- Parameters:
context- Activity contextattrs- ui attributes
-
POBBannerView
POBBannerView(Context context, AttributeSet attrs, int defStyle)
Used to create instances when placed in XML layouts with default style.- Parameters:
context- Activity contextattrs- ui attributesdefStyle- default style
-
POBBannerView
POBBannerView(Context context, String publisherId, int profileId, String adUnitId, Array<POBAdSize> adSizes)
Constructor Initializes and returns a newly allocated banner view object for supporting 'No Ad Server Configuration' Publisher should create object of POBBannerView using this constructor when instantiating from code.- Parameters:
context- Activity contextpublisherId- Identifier of the publisherprofileId- Profile ID of an ad tagadUnitId- Ad unit id used to identify unique placement on screen.adSizes- List of banner ad sizes for this impression
-
POBBannerView
POBBannerView(Context context, String publisherId, int profileId, String adUnitId, POBBannerEvent event)
Constructor Initializes and returns a newly allocated banner view object Publisher should create object of POBBannerView using this constructor when instantiating from java code.- Parameters:
context- Activity contextpublisherId- Identifier of the publisherprofileId- Profile ID of an ad tagadUnitId- Ad unit id used to identify unique placement on screen.event- Valid instance of class implementing POBBannerEvent
-
-
Method Detail
-
init
void init(@NonNull() String publisherId, int profileId, @NonNull() String adUnitId, @NonNull() POBBannerEvent event)
Initializes newly allocated banner view object. Invoke this method only if POBBannerView is inflated via xml resource. Note: If validation check's pass through, the method will create POBRequest
- Parameters:
publisherId- Identifier of the publisherprofileId- Profile ID of an ad tagadUnitId- Ad unit id used to identify unique placement on screen.event- Valid instance of class implementing POBBannerEvent
-
destroy
void destroy()
Invoke this method when your activity/fragment is about to destroy. It cleans the resources.
-
pauseAutoRefresh
void pauseAutoRefresh()
Pauses the auto refresh, By default, banner refreshes automatically as per configured refresh interval on OpenWrap portal. Calling this method prevents the refresh cycle to happen even if a refresh interval has been specified.
It is recommended to use this method whenever the ad view is about to be hidden from the user for any period of time, to avoid unnecessary ad requests. You can then call `resumeAutoRefresh()` to resume the refresh when banner becomes visible.
-
resumeAutoRefresh
void resumeAutoRefresh()
Resumes the auto-refresh as per configured refresh interval on OpenWrap portal, call this method only if you have previously paused auto-refresh using `pauseAutoRefresh()`. This method has no effect if a refresh interval has not been set.
-
init
void init(@NonNull() String publisherId, int profileId, @NonNull() String adUnitId, @NonNull() Array<POBAdSize> adSizes)
Initializes newly allocated banner view object for supporting 'No Ad Server Configuration' Invoke this method only if POBBannerView is inflated via xml resource.
- Parameters:
publisherId- Identifier of the publisherprofileId- Profile ID of an ad tagadUnitId- Ad unit id used to identify unique placement on screen.adSizes- List of banner ad sizes for this impression
-
loadAd
@RequiresPermission(allOf = {Manifest.permission.INTERNET, Manifest.permission.ACCESS_NETWORK_STATE}) void loadAd()
Initiate the loading of a banner ad, if the POBRequest is available then it proceeds with further execution else it will log error
-
loadAd
@RequiresPermission(allOf = {Manifest.permission.INTERNET, Manifest.permission.ACCESS_NETWORK_STATE}) void loadAd(@NonNull() String bidResponse)
Initiates the loading of a banner ad with oRTB bid response. This API expects the response with oRTB v2.5 specification.
- Parameters:
bidResponse- oRTB response of format - oRTB-2.5
-
forceRefresh
@RequiresPermission(allOf = {Manifest.permission.INTERNET, Manifest.permission.ACCESS_NETWORK_STATE}) boolean forceRefresh()
Cancels existing ad requests and initiates new ad request.
It may skip force refresh in below cases: 1). Ad is being loaded 2). Waiting response from ad server SDK (if applicable) 3). User interacting with ad (Opening Internal browser or expanding ad)
- Returns:
Status true/false, about force refresh, as described it can skip in few cases by returning 'false'
-
getImpression
@Nullable() POBImpression getImpression()
Returns an instance of impression object created internally. It provides APIs to set pubmatic zone id and other custom parameters.
- Returns:
Returns an instance of POBImpression.
-
getAdRequest
@Nullable() POBRequest getAdRequest()
Returns an Object representing OpenWrap ad request. You may set some additional targeting parameters on this object.
- Returns:
Instance of POBRequest
-
setListener
void setListener(@Nullable() POBBannerView.POBBannerViewListener listener)
Sets instance of POBBannerViewListener for the Banner view.
- Parameters:
listener- Instance of POBBannerViewListener
-
proceedToLoadAd
boolean proceedToLoadAd()
-
proceedOnError
void proceedOnError(@NonNull() POBBidEvent.BidEventError error, @NonNull() String errorMessage)
-
getCreativeSize
@Nullable() POBAdSize getCreativeSize()
Returns the Size of the rendered ad creative
- Returns:
Instance of POBAdSize
-
setBidEventListener
void setBidEventListener(@Nullable() POBBidEventListener bidEventListener)
Sets the BidEventListener for the ad view Note: Proper reference management practices should be observed when using this listener
- Parameters:
bidEventListener- reference of POBBidEventListener
-
-
-
-