Interface IFullscreenAdQueue

Manages the pre-loading of fullscreen ads. Each IFullscreenAdQueue manages ads for one placement.

Namespace: Chartboost.Mediation.Ad.Fullscreen.Queue

Assembly: Chartboost.Mediation.dll

Syntax

public interface IFullscreenAdQueue : IAd

Properties

IsRunning

Whether or not the ad queue is currently running (active) and automatically queueing ads.

Declaration

bool IsRunning { get; }

Property Value

Type	Description
bool

Keywords

The keywords for the queue. Every load request made by this queue will include these keywords.

Declaration

Dictionary<string, string> Keywords { get; set; }

Property Value

Type	Description
Dictionary<string, string>

NumberOfAdsReady

Number of ready-to-show ads that can currently be retrieved with GetNextAd()

Declaration

int NumberOfAdsReady { get; }

Property Value

Type	Description
int

QueueCapacity

Maximum number of loaded ads the queue can hold at one time.

Request a new queue size. If the number of ad slots requested is larger than the maximum configured by the dashboard this method will log an error and set the queue size to maximum allowed size as configured on dashboard.

Declaration

int QueueCapacity { get; set; }

Property Value

Type	Description
int

Methods

GetNextAd()

Gets the next ad from the queue.

Declaration

IFullscreenAd GetNextAd()

Returns

Type	Description
IFullscreenAd	A IFullscreenAd ad

HasNextAd()

Checks if there's an ad available.

Declaration

bool HasNextAd()

Returns

Type	Description
bool	Whether or not there exists an ad in the queue.

Start()

Starts loading ads and append them to the queue automatically until capacity has been reached.

Declaration

void Start()

Stop()

Stops loading ads

Declaration

void Stop()

Events

DidRemoveExpiredAd

Event triggered when an ad expires and is removed from the queue.

Declaration

event FullscreenAdQueueRemoveExpiredAdEvent DidRemoveExpiredAd

Event Type

Type	Description
FullscreenAdQueueRemoveExpiredAdEvent

DidUpdate

Event triggered when a IFullscreenAdQueue completes a load request.

Declaration

event FullscreenAdQueueUpdateEvent DidUpdate

Event Type

Type	Description
FullscreenAdQueueUpdateEvent