com.twofortyfouram.locale.sdk.host.api

Class Setting

java.lang.Object

com.twofortyfouram.locale.sdk.host.api.Setting

@NotThreadSafe
public final class Setting
extends Object

Interfaces with plug-in settings, providing facilities to fire them.

Constructor Summary

Constructors

Constructor and Description
Setting(Context context, Plugin plugin) Constructs a new plug-in setting.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the plug-in setting, freeing up resources that were used to fire the plug-in.
void	fire(Bundle pluginBundle) Performs a blocking fire of the plug-in's setting action.
void	fire(PluginInstanceData data) Performs a blocking fire of the plug-in's setting action.

Methods inherited from class java.lang.Object

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

Constructor Detail

Setting

public Setting(Context context,
               Plugin plugin)

Constructs a new plug-in setting.

Parameters:

context - Application context.

plugin - The plug-in details.

Method Detail

fire

@Slow(value=SECONDS)
public void fire(PluginInstanceData data)

Performs a blocking fire of the plug-in's setting action.

Parameters:

data - The plug-in's instance data previously saved by the Edit Activity.

fire

@Slow(value=SECONDS)
public void fire(Bundle pluginBundle)

Performs a blocking fire of the plug-in's setting action. Note: PluginInstanceData is immutable and provides a safe interface, however guaranteed immutability requires a memory copy and deserialization, which are not efficient. This method provides an alternative for clients to optimize performance by deserializing the plug-in's Bundle once and reusing that Bundle. When using this approach, clients must not modify the Bundle.

Parameters:

pluginBundle - The plug-in's instance data previously saved by the Edit Activity, already deserialized back into a Bundle.

destroy

public void destroy()

Destroys the plug-in setting, freeing up resources that were used to fire the plug-in.