Package org.ngengine.ads

Class ImmersiveAdComponent

java.lang.Object

org.ngengine.ads.ImmersiveAdComponent

All Implemented Interfaces:

Component<Object>, Fragment, LogicFragment

public class ImmersiveAdComponent
extends Object
implements Component<Object>, LogicFragment

Constructor Summary

Constructors

Constructor	Description
ImmersiveAdComponent(Collection<String> relays, org.ngengine.nostr4j.keypair.NostrPublicKey appKey, org.ngengine.nostr4j.keypair.NostrPrivateKey userAdKey)

Method Summary

Modifier and Type	Method	Description
void	addListener(ImmersiveAdListener listener)
protected org.ngengine.nostrads.client.services.display.Adspace	getAdSpace(ImmersiveAdSpace space)
org.ngengine.nostrads.protocol.types.AdTaxonomy	getTaxonomy()
void	onAdRefresh(org.ngengine.nostrads.client.negotiation.NegotiationHandler neg, org.ngengine.nostrads.protocol.negotiation.AdOfferEvent offer, String reason)
void	onDisable(ComponentManager mng, Runner runner, DataStoreProvider dataStore)	Called when the component is disabled.
void	onEnable(ComponentManager mng, Runner runner, DataStoreProvider dataStore, boolean firstTime, Object arg)	Called when the component is enabled.
void	refreshAll()
void	register(ImmersiveAdGroup group)
void	removeListener(ImmersiveAdListener listener)
void	setAdvertiserFilterList(List<org.ngengine.nostr4j.keypair.NostrPublicKey> advertisersList, boolean isBlackList)
void	setDefaultCategories(List<org.ngengine.nostrads.protocol.types.AdTaxonomy.Term> categories)
void	setDefaultLanguages(List<String> languages)
void	setDefaultPriceSlot(org.ngengine.nostrads.protocol.types.AdPriceSlot priceSlot)
void	setFilter(Function<org.ngengine.nostrads.protocol.AdBidEvent,Boolean> filter)
void	setViewer(ImmersiveAdViewer viewer)
void	unregister(ImmersiveAdGroup group)
void	updateAppLogic(ComponentManager mng, float tpf)	Called by the application logic update loop.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ngengine.components.Component

getId, getSlot, onAttached, onDetached, onNudge

Constructor Details

ImmersiveAdComponent

public ImmersiveAdComponent(@Nullable
 Collection<String> relays,
 org.ngengine.nostr4j.keypair.NostrPublicKey appKey,
 @Nullable
 org.ngengine.nostr4j.keypair.NostrPrivateKey userAdKey)

Method Details

setFilter

public void setFilter(Function<org.ngengine.nostrads.protocol.AdBidEvent,Boolean> filter)

setViewer

public void setViewer(ImmersiveAdViewer viewer)

addListener

public void addListener(ImmersiveAdListener listener)

removeListener

public void removeListener(ImmersiveAdListener listener)

refreshAll

public void refreshAll()

setDefaultPriceSlot

public void setDefaultPriceSlot(org.ngengine.nostrads.protocol.types.AdPriceSlot priceSlot)

setAdvertiserFilterList

public void setAdvertiserFilterList(List<org.ngengine.nostr4j.keypair.NostrPublicKey> advertisersList,
 boolean isBlackList)

setDefaultCategories

public void setDefaultCategories(List<org.ngengine.nostrads.protocol.types.AdTaxonomy.Term> categories)

setDefaultLanguages

public void setDefaultLanguages(List<String> languages)

getAdSpace

protected org.ngengine.nostrads.client.services.display.Adspace getAdSpace(ImmersiveAdSpace space)

register

public void register(ImmersiveAdGroup group)

unregister

public void unregister(ImmersiveAdGroup group)

updateAppLogic

public void updateAppLogic(ComponentManager mng,
 float tpf)

Description copied from interface: LogicFragment

Called by the application logic update loop. This method is called every frame before the render phase.

Specified by:

updateAppLogic in interface LogicFragment

Parameters:

tpf - time per frame

getTaxonomy

public org.ngengine.nostrads.protocol.types.AdTaxonomy getTaxonomy()

onEnable

public void onEnable(ComponentManager mng,
 Runner runner,
 DataStoreProvider dataStore,
 boolean firstTime,
 Object arg)

Description copied from interface: Component

Called when the component is enabled. This is the most important method of the component lifecycle, where the component's main logic is implemented.

This method is called when the component is enabled, all its dependencies are satisfied, the fragments are initialized, and the resources are loaded.

Specified by:

onEnable in interface Component<Object>

Parameters:

mng - - the ComponentManager to which this component is attached

runner - - the Runner that executes the logic

dataStore - - the DataStoreProvider for storing and retrieving data and caches

firstTime - - whether this is the first time the component is being enabled

arg - - an argument that can be passed when enabling this component, can be null

onDisable

public void onDisable(ComponentManager mng,
 Runner runner,
 DataStoreProvider dataStore)

Description copied from interface: Component

Called when the component is disabled.

This should undo anything that was done in Component.onEnable(org.ngengine.components.ComponentManager, org.ngengine.runner.Runner, org.ngengine.store.DataStoreProvider, boolean, T) and reset the component state to allow future re-enabling.

This method is called when the component is explicitly disabled or when one of its dependencies is disabled.

If $

invalid reference

#onDetach

is not implemented, this method should take care of cleaning up all resources to prevent leaks.

It is always called before an enabled component is detached from the ComponentManager.

Specified by:

onDisable in interface Component<Object>

Parameters:

mng -

runner -

dataStore -

onAdRefresh

public void onAdRefresh(org.ngengine.nostrads.client.negotiation.NegotiationHandler neg,
 org.ngengine.nostrads.protocol.negotiation.AdOfferEvent offer,
 String reason)