com.digitalsunray.advantage.plugin

Class Plugin

java.lang.Object

com.digitalsunray.advantage.plugin.Plugin

public class Plugin
extends java.lang.Object

Plugin is the superclass of all classes that represent internal/external plug-ins. It can be attached to the Core of the SDK via registering process.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdServerUrl()
PluginJSBridge	getJSBridge()
java.lang.String	getJsiName()
PluginFunctions	getPluginFunctions()
java.lang.String	getProtocolName()
SharedFunctionality	getToolBox() Returns a toolbox which provides generic functionality can be selectively used by plugin developers.
java.lang.String	getUniqueId()
boolean	handleCommand(java.lang.String command, java.util.HashMap<java.lang.String,java.lang.String> params) Fires the handleCommand() event of PluginFunctions to handle the incoming command.
void	init() Fires the init() event of PluginFunctions to initialize the active plugin.
void	injectLoaderScript(HtmlObject htmlObject)
void	onActivityStateChanged(Advantage.ActivityState state) Fires the onActivityStateChanged() event of PluginFunctions to manage the banner's life-cycle.
void	onOrientationChanged(android.content.res.Configuration newConfig) Fires the onOrientationChanged() event of PluginFunctions.
void	onSizeChanged(Size size) Fires the onSizeChanged() event of PluginFunctions.
void	onStateChanged(Enum.States state) Fires the onStateChanged() event of PluginFunctions.
void	onVisibilityChanged(boolean visibility) Fires the onVisibilityChanged() event of PluginFunctions to handle the new state.
void	onVisibilityPercentageChanged(VisibilityResult result) Fires the onVisibilityPercentageChanged() event of PluginFunctions.
void	onVolumeChanged(AudioInfo result) Fires the onVolumeChanged() event of PluginFunctions.
void	setAdServerUrl(java.lang.String adServerUrl) Sets the external plugin's Ad-server URL.
void	setToolBox(SharedFunctionality toolBox) Sets an instance of toolbox which allows plugin developers to implement new functionalities.

Methods inherited from class java.lang.Object

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

Method Detail

getToolBox

public SharedFunctionality getToolBox()

Returns a toolbox which provides generic functionality can be selectively used by plugin developers.

Returns:

An instance of SharedFunctionality

setToolBox

public void setToolBox(SharedFunctionality toolBox)

Sets an instance of toolbox which allows plugin developers to implement new functionalities.

Parameters:

toolBox - An instance of SharedFunctionality.

getUniqueId

public java.lang.String getUniqueId()

Returns:

the unique identifier of this instance.

getJsiName

public java.lang.String getJsiName()

Returns:

the JavaScript interface name of this instance.

getProtocolName

public java.lang.String getProtocolName()

Returns:

the protocol (command) identifier of this instance.

getAdServerUrl

public java.lang.String getAdServerUrl()

Returns:

the Ad-server URL of this instance.

setAdServerUrl

public void setAdServerUrl(java.lang.String adServerUrl)

Sets the external plugin's Ad-server URL.

Parameters:

adServerUrl - The resource URL to load.

getJSBridge

public PluginJSBridge getJSBridge()

Returns:

the JavaScript interface for this plugin.

getPluginFunctions

public PluginFunctions getPluginFunctions()

Returns:

the PluginFunctions for this plugin.

init

public void init()

Fires the init() event of PluginFunctions to initialize the active plugin.

handleCommand

public boolean handleCommand(java.lang.String command,
                             java.util.HashMap<java.lang.String,java.lang.String> params)

Fires the handleCommand() event of PluginFunctions to handle the incoming command.

Parameters:

command - The name of command.

params - List of parameters.

Returns:

true If this command handled successfully. false Otherwise.

onStateChanged

public void onStateChanged(Enum.States state)

Fires the onStateChanged() event of PluginFunctions.

Parameters:

state - Current state.

onSizeChanged

public void onSizeChanged(Size size)

Fires the onSizeChanged() event of PluginFunctions.

Parameters:

size - new size of the ad.

onOrientationChanged

public void onOrientationChanged(android.content.res.Configuration newConfig)

Fires the onOrientationChanged() event of PluginFunctions.

Parameters:

newConfig - An instance of all device configuration information.

onActivityStateChanged

public void onActivityStateChanged(Advantage.ActivityState state)

Fires the onActivityStateChanged() event of PluginFunctions to manage the banner's life-cycle.

Parameters:

state - new activity state

onVisibilityChanged

public void onVisibilityChanged(boolean visibility)

Fires the onVisibilityChanged() event of PluginFunctions to handle the new state.

Parameters:

visibility - true If banner is viewable on the screen. false Otherwise.

onVisibilityPercentageChanged

public void onVisibilityPercentageChanged(VisibilityResult result)

Fires the onVisibilityPercentageChanged() event of PluginFunctions.

Parameters:

result - An instance of VisibilityResult.

Since:

Version 2.4.7

onVolumeChanged

public void onVolumeChanged(AudioInfo result)

Fires the onVolumeChanged() event of PluginFunctions.

Parameters:

result - An instance of AudioInfo.

Since:

Version 2.5.3

injectLoaderScript

public void injectLoaderScript(HtmlObject htmlObject)