com.smarterapps.automateitplugin.sdk.fields

Class PluginDataFieldString

java.lang.Object

com.smarterapps.automateitplugin.sdk.fields.PluginDataField<java.lang.String>

com.smarterapps.automateitplugin.sdk.fields.PluginDataFieldString

public final class PluginDataFieldString
extends PluginDataField<java.lang.String>

This class represents a PluginDataField of type String

See Also:

PluginDataField

Nested Class Summary

Nested classes/interfaces inherited from class com.smarterapps.automateitplugin.sdk.fields.PluginDataField

PluginDataField.FieldType

Field Summary

Fields inherited from class com.smarterapps.automateitplugin.sdk.fields.PluginDataField

JSON_FIELD_VALUE

Constructor Summary

Constructors

Constructor and Description
PluginDataFieldString(int id, java.lang.String title, java.lang.String description, java.lang.String value) Instantiates a new plugin data field of type string.
PluginDataFieldString(org.json.JSONObject fieldJson) Do not use - for internal use only

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getFieldValue(org.json.JSONObject fieldJson, java.lang.String jsonFieldValue) Gets the field value.

Methods inherited from class com.smarterapps.automateitplugin.sdk.fields.PluginDataField

createNewField, getDescription, getId, getTitle, getType, getValue, serialize, setValue, setValueGeneric

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginDataFieldString

public PluginDataFieldString(int id,
                             java.lang.String title,
                             java.lang.String description,
                             java.lang.String value)

Instantiates a new plugin data field of type string.

Parameters:

id - The field id. To be used with PluginDataFieldCollection.getFieldById(int) to retrieve the field from a data fields collection

title - The field title to show within AutomateIt when editing the related PluginAction or PluginTrigger

description - The field description to show within AutomateIt when editing the related PluginAction or PluginTrigger

value - An initial value for the field

PluginDataFieldString

public PluginDataFieldString(org.json.JSONObject fieldJson)

Do not use - for internal use only

Method Detail

getFieldValue

protected java.lang.String getFieldValue(org.json.JSONObject fieldJson,
                                         java.lang.String jsonFieldValue)

Description copied from class: PluginDataField

Gets the field value.

Specified by:

getFieldValue in class PluginDataField<java.lang.String>

Parameters:

fieldJson - the field json

jsonFieldValue - the json field value

Returns:

the field value