com.appboy.models.outgoing

Class AppboyProperties

java.lang.Object

com.appboy.models.outgoing.AppboyProperties

All Implemented Interfaces:

IPutIntoJson<org.json.JSONObject>

Direct Known Subclasses:

BrazeProperties

public class AppboyProperties
extends java.lang.Object
implements IPutIntoJson<org.json.JSONObject>

Defines and stores metadata about events and purchases.

Metadata is stored as properties represented by key-value pairs.

Property keys are non-empty strings <= 255 characters, with no leading dollar signs. Property values are be integers, doubles, booleans, java.util.Date objects, or strings <= 255 characters. All strings of length > 255 characters will be truncated.

Constructor Summary

Constructors

Constructor and Description
AppboyProperties()
AppboyProperties(org.json.JSONObject jsonObject) Creates an AppboyProperties object using JSON.

Method Summary

Modifier and Type	Method and Description
AppboyProperties	addProperty(java.lang.String key, boolean value) Adds a key-value property pair to this AppboyProperties object.
AppboyProperties	addProperty(java.lang.String key, java.util.Date value) Adds a key-value property pair to this AppboyProperties object.
AppboyProperties	addProperty(java.lang.String key, double value) Adds a key-value property pair to this AppboyProperties object.
AppboyProperties	addProperty(java.lang.String key, int value) Adds a key-value property pair to this AppboyProperties object.
AppboyProperties	addProperty(java.lang.String key, long value) Adds a key-value property pair to this AppboyProperties object.
AppboyProperties	addProperty(java.lang.String key, java.lang.String value) Adds a key-value property pair to this AppboyProperties object.
protected boolean	containsProperty(java.lang.String key)
org.json.JSONObject	forJsonPut()
protected java.lang.Object	get(java.lang.String key)
boolean	isInvalid() To be valid, this object must be below Constants.EVENT_PROPERTIES_MAX_SIZE_BYTES when converted to JSON via forJsonPut().
protected java.lang.Object	removeProperty(java.lang.String key)
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

AppboyProperties

public AppboyProperties()

AppboyProperties

public AppboyProperties(org.json.JSONObject jsonObject)

Creates an AppboyProperties object using JSON. Invalid keys and invalid string values are removed from the constructed object. JSONObject.NULL values are also removed if present. The intended use of this constructor is to be able to reconstruct an AppboyProperties object from its corresponding forJsonPut() form.

Parameters:

jsonObject - object to create the AppboyProperties from

Method Detail

addProperty

public AppboyProperties addProperty(java.lang.String key,
                                    long value)

Adds a key-value property pair to this AppboyProperties object. Note that invalid key-value pairs are logged and not added to the AppboyProperties object to preserve valid internal state at all times.

Parameters:

key - Property keys are non-empty strings <= 255 characters, with no leading dollar signs. Strings of length > 255 characters will be truncated.

value - long property value.

Returns:

this

addProperty

public AppboyProperties addProperty(java.lang.String key,
                                    int value)

Adds a key-value property pair to this AppboyProperties object. Note that invalid key-value pairs are logged and not added to the AppboyProperties object to preserve valid internal state at all times.

Parameters:

key - Property keys are non-empty strings <= 255 characters, with no leading dollar signs. Strings of length > 255 characters will be truncated.

value - integer property value.

Returns:

this

addProperty

public AppboyProperties addProperty(java.lang.String key,
                                    double value)

Adds a key-value property pair to this AppboyProperties object. Note that invalid key-value pairs are logged and not added to the AppboyProperties object to preserve valid internal state at all times.

Parameters:

key - Property keys are non-empty strings <= 255 characters, with no leading dollar signs. Strings of length > 255 characters will be truncated.

value - double property value.

Returns:

this

addProperty

public AppboyProperties addProperty(java.lang.String key,
                                    boolean value)

Adds a key-value property pair to this AppboyProperties object. Note that invalid key-value pairs are logged and not added to the AppboyProperties object to preserve valid internal state at all times.

Parameters:

key - Property keys are non-empty strings <= 255 characters, with no leading dollar signs. Strings of length > 255 characters will be truncated.

value - boolean property value.

Returns:

this

addProperty

public AppboyProperties addProperty(java.lang.String key,
                                    java.util.Date value)

Adds a key-value property pair to this AppboyProperties object. Note that invalid key-value pairs are logged and not added to the AppboyProperties object to preserve valid internal state at all times.

Parameters:

key - Property keys are non-empty strings <= 255 characters, with no leading dollar signs. Strings of length > 255 characters will be truncated.

value - Date property value, required to be non-null.

Returns:

this

addProperty

public AppboyProperties addProperty(java.lang.String key,
                                    java.lang.String value)

Adds a key-value property pair to this AppboyProperties object. Note that invalid key-value pairs are logged and not added to the AppboyProperties object to preserve valid internal state at all times.

Parameters:

key - Property keys are non-empty strings <= 255 characters, with no leading dollar signs. Strings of length > 255 characters will be truncated.

value - String property value, should be <= 255 characters and not null. Strings of length > 255 characters will be truncated.

Returns:

this

size

public int size()

Returns:

the number of property key-value pairs contained in this AppboyProperties object

isInvalid

public boolean isInvalid()

To be valid, this object must be below Constants.EVENT_PROPERTIES_MAX_SIZE_BYTES when converted to JSON via forJsonPut().

containsProperty

protected boolean containsProperty(java.lang.String key)

removeProperty

protected java.lang.Object removeProperty(java.lang.String key)

get

protected java.lang.Object get(java.lang.String key)

forJsonPut

public org.json.JSONObject forJsonPut()

Specified by:

forJsonPut in interface IPutIntoJson<org.json.JSONObject>