com.mopub.nativeads

Class MoPubRecyclerAdapter

java.lang.Object

android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

com.mopub.nativeads.MoPubRecyclerAdapter

public final class MoPubRecyclerAdapter
extends android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MoPubRecyclerAdapter.ContentChangeStrategy

Constructor Summary

Constructors

Constructor and Description
MoPubRecyclerAdapter(android.app.Activity activity, android.support.v7.widget.RecyclerView.Adapter originalAdapter)
MoPubRecyclerAdapter(android.app.Activity activity, android.support.v7.widget.RecyclerView.Adapter originalAdapter, MoPubNativeAdPositioning.MoPubClientPositioning adPositioning)
MoPubRecyclerAdapter(android.app.Activity activity, android.support.v7.widget.RecyclerView.Adapter originalAdapter, MoPubNativeAdPositioning.MoPubServerPositioning adPositioning)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAds() Stops loading ads, immediately clearing any ads currently in the stream.
static int	computeScrollOffset(android.support.v7.widget.LinearLayoutManager linearLayoutManager, android.support.v7.widget.RecyclerView.ViewHolder holder)
void	destroy()
int	getAdjustedPosition(int originalPosition) Returns the position of an item considering ads in the stream.
int	getItemCount()
long	getItemId(int position) Returns a stable negative item ID for ad items & calls getItemId on your original adapter for non-ad items.
int	getItemViewType(int position)
int	getOriginalPosition(int position) Returns the original position of an item considering ads in the stream.
boolean	isAd(int position) Whether the given position is an ad.
void	loadAds(java.lang.String adUnitId) Start loading ads from the MoPub server.
void	loadAds(java.lang.String adUnitId, RequestParameters requestParameters) Start loading ads from the MoPub server, using the given request targeting information.
void	onAttachedToRecyclerView(android.support.v7.widget.RecyclerView recyclerView)
void	onBindViewHolder(android.support.v7.widget.RecyclerView.ViewHolder holder, int position)
android.support.v7.widget.RecyclerView.ViewHolder	onCreateViewHolder(android.view.ViewGroup parent, int viewType)
void	onDetachedFromRecyclerView(android.support.v7.widget.RecyclerView recyclerView)
boolean	onFailedToRecycleView(android.support.v7.widget.RecyclerView.ViewHolder holder)
void	onViewAttachedToWindow(android.support.v7.widget.RecyclerView.ViewHolder holder)
void	onViewDetachedFromWindow(android.support.v7.widget.RecyclerView.ViewHolder holder)
void	onViewRecycled(android.support.v7.widget.RecyclerView.ViewHolder holder)
void	refreshAds(java.lang.String adUnitId) Refreshes ads in the adapter while preserving the scroll position.
void	refreshAds(java.lang.String adUnitId, RequestParameters requestParameters) Refreshes ads in the adapter while preserving the scroll position.
void	registerAdRenderer(MoPubAdRenderer adRenderer) Registers an ad renderer for rendering a specific native ad format.
void	setAdLoadedListener(MoPubNativeAdLoadedListener listener) Sets a listener that will be called after the SDK loads new ads from the server and places them into your stream.
void	setContentChangeStrategy(MoPubRecyclerAdapter.ContentChangeStrategy strategy) Sets the strategy this adapter should use for moving ads when content is added or removed from the wrapped original adapter.
void	setHasStableIds(boolean hasStableIds)

Methods inherited from class android.support.v7.widget.RecyclerView.Adapter

bindViewHolder, createViewHolder, hasObservers, hasStableIds, notifyDataSetChanged, notifyItemChanged, notifyItemChanged, notifyItemInserted, notifyItemMoved, notifyItemRangeChanged, notifyItemRangeChanged, notifyItemRangeInserted, notifyItemRangeRemoved, notifyItemRemoved, onBindViewHolder, registerAdapterDataObserver, unregisterAdapterDataObserver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MoPubRecyclerAdapter

public MoPubRecyclerAdapter(android.app.Activity activity,
                    android.support.v7.widget.RecyclerView.Adapter originalAdapter)

MoPubRecyclerAdapter

public MoPubRecyclerAdapter(android.app.Activity activity,
                    android.support.v7.widget.RecyclerView.Adapter originalAdapter,
                    MoPubNativeAdPositioning.MoPubServerPositioning adPositioning)

MoPubRecyclerAdapter

public MoPubRecyclerAdapter(android.app.Activity activity,
                    android.support.v7.widget.RecyclerView.Adapter originalAdapter,
                    MoPubNativeAdPositioning.MoPubClientPositioning adPositioning)

Method Detail

onAttachedToRecyclerView

public void onAttachedToRecyclerView(android.support.v7.widget.RecyclerView recyclerView)

Overrides:

onAttachedToRecyclerView in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

onDetachedFromRecyclerView

public void onDetachedFromRecyclerView(android.support.v7.widget.RecyclerView recyclerView)

Overrides:

onDetachedFromRecyclerView in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

setAdLoadedListener

public void setAdLoadedListener(MoPubNativeAdLoadedListener listener)

Sets a listener that will be called after the SDK loads new ads from the server and places them into your stream. The listener will be active between when you call loadAds(java.lang.String) and when you call destroy(). You can also set the listener to null to remove the listener. Note that there is not a one to one correspondence between calls to loadAds(java.lang.String) and this listener. The SDK will call the listener every time an ad loads.

Parameters:

listener - The listener.

registerAdRenderer

public void registerAdRenderer(MoPubAdRenderer adRenderer)

Registers an ad renderer for rendering a specific native ad format. Note that if multiple ad renderers support a specific native ad format, the first one registered will be used.

loadAds

public void loadAds(java.lang.String adUnitId)

Start loading ads from the MoPub server. We recommend using loadAds(String, RequestParameters) instead of this method, in order to pass targeting information to the server.

Parameters:

adUnitId - The ad unit ID to use when loading ads.

loadAds

public void loadAds(java.lang.String adUnitId,
           RequestParameters requestParameters)

Start loading ads from the MoPub server, using the given request targeting information. When loading ads, MoPubNativeAdLoadedListener.onAdLoaded(int) will be called for each ad that is added to the stream.

Parameters:

adUnitId - The ad unit ID to use when loading ads.

requestParameters - Targeting information to pass to the ad server.

computeScrollOffset

public static int computeScrollOffset(android.support.v7.widget.LinearLayoutManager linearLayoutManager,
                      android.support.v7.widget.RecyclerView.ViewHolder holder)

refreshAds

public void refreshAds(java.lang.String adUnitId)

Refreshes ads in the adapter while preserving the scroll position. Call this instead of loadAds(String, RequestParameters) in order to preserve the scroll position in your view. Only usable with LinearLayoutManager or GridLayoutManager.

Parameters:

adUnitId - The ad unit ID to use when loading ads.

refreshAds

public void refreshAds(java.lang.String adUnitId,
              RequestParameters requestParameters)

Refreshes ads in the adapter while preserving the scroll position. Call this instead of loadAds(String, RequestParameters) in order to preserve the scroll position in your view. Only usable with LinearLayoutManager or GridLayoutManager.

Parameters:

adUnitId - The ad unit ID to use when loading ads.

requestParameters - Targeting information to pass to the ad server.

clearAds

public void clearAds()

Stops loading ads, immediately clearing any ads currently in the stream. This method also stops ads from loading as the user moves through the stream. When ads are cleared, MoPubNativeAdLoadedListener.onAdRemoved(int) will be called for each ad that is removed from the stream.

isAd

public boolean isAd(int position)

Whether the given position is an ad. This will return true only if there is an ad loaded for this position. You can also listen for ads to load using MoPubNativeAdLoadedListener.onAdLoaded(int).

Parameters:

position - The position to check for an ad, expressed in terms of the position in the stream including ads.

Returns:

Whether there is an ad at the given position.

getAdjustedPosition

public int getAdjustedPosition(int originalPosition)

Returns the position of an item considering ads in the stream.

Parameters:

originalPosition - The original position.

Returns:

The position adjusted by placing ads.

See Also:

MoPubStreamAdPlacer#getAdjustedPosition(int)}

getOriginalPosition

public int getOriginalPosition(int position)

Returns the original position of an item considering ads in the stream.

Parameters:

position - The adjusted position.

Returns:

The original position before placing ads.

See Also:

MoPubStreamAdPlacer#getOriginalPosition(int)}

setContentChangeStrategy

public void setContentChangeStrategy(MoPubRecyclerAdapter.ContentChangeStrategy strategy)

Sets the strategy this adapter should use for moving ads when content is added or removed from the wrapped original adapter. This strategy can be set at any time to change the behavior of the adapter.

• MoPubRecyclerAdapter.ContentChangeStrategy.INSERT_AT_END will insert ads when content is added to the end of the stream. This is the default behavior and the recommended strategy.
• MoPubRecyclerAdapter.ContentChangeStrategy.MOVE_ALL_ADS_WITH_CONTENT will cause all ad positions after an insertion or deletion to be adjusted. New ads will not be displayed when items are added to the end of the stream.
• MoPubRecyclerAdapter.ContentChangeStrategy.KEEP_ADS_FIXED will never adjust ad positions when items are inserted or removed.

getItemCount

public int getItemCount()

Specified by:

getItemCount in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

onCreateViewHolder

public android.support.v7.widget.RecyclerView.ViewHolder onCreateViewHolder(android.view.ViewGroup parent,
                                                                   int viewType)

Specified by:

onCreateViewHolder in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

onBindViewHolder

public void onBindViewHolder(android.support.v7.widget.RecyclerView.ViewHolder holder,
                    int position)

Specified by:

onBindViewHolder in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

getItemViewType

public int getItemViewType(int position)

Overrides:

getItemViewType in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

setHasStableIds

public void setHasStableIds(boolean hasStableIds)

Overrides:

setHasStableIds in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

destroy

public void destroy()

getItemId

public long getItemId(int position)

Returns a stable negative item ID for ad items & calls getItemId on your original adapter for non-ad items. Returns RecyclerView.NO_ID if your original adapter does not have stable IDs.

Overrides:

getItemId in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

onFailedToRecycleView

public boolean onFailedToRecycleView(android.support.v7.widget.RecyclerView.ViewHolder holder)

Overrides:

onFailedToRecycleView in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

onViewAttachedToWindow

public void onViewAttachedToWindow(android.support.v7.widget.RecyclerView.ViewHolder holder)

Overrides:

onViewAttachedToWindow in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

onViewDetachedFromWindow

public void onViewDetachedFromWindow(android.support.v7.widget.RecyclerView.ViewHolder holder)

Overrides:

onViewDetachedFromWindow in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>

onViewRecycled

public void onViewRecycled(android.support.v7.widget.RecyclerView.ViewHolder holder)

Overrides:

onViewRecycled in class android.support.v7.widget.RecyclerView.Adapter<android.support.v7.widget.RecyclerView.ViewHolder>