com.aylanetworks.aylasdk

Class AylaMessageProperty

java.lang.Object

com.aylanetworks.aylasdk.AylaProperty<java.lang.String>

com.aylanetworks.aylasdk.AylaMessageProperty

public class AylaMessageProperty
extends AylaProperty<java.lang.String>

Message property is of a property type that's especially for properties with "message" base type. It can store either JSON string or normal text content. While the size of a normal string property is limited to 1024 characters, the size of a message property can be as large as 512 KB.

Nested Class Summary

Nested classes/interfaces inherited from class com.aylanetworks.aylasdk.AylaProperty

AylaProperty.Wrapper<T>

Field Summary

Fields inherited from class com.aylanetworks.aylasdk.AylaProperty

_owningDevice, ackedAt, ackEnabled, ackMessage, ackStatus, BASE_TYPE_BOOLEAN, BASE_TYPE_DECIMAL, BASE_TYPE_FILE, BASE_TYPE_INTEGER, BASE_TYPE_MESSAGE, BASE_TYPE_STRING, baseType, dataUpdatedAt, DEFAULT_ACK_WAIT_TIME, direction, displayName, key, MAX_DATAPOINT_COUNT, metadata, name, readOnly, type, value

Constructor Summary

Constructors

Constructor and Description
AylaMessageProperty()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createDatapointEndpoint() Returns the endpoint path required to create/get new datapoionts.
protected java.lang.String	createDatapointPayload(java.lang.String value, java.util.Map<java.lang.String,java.lang.String> metadata) Create the payload required to create the datapoiont.
AylaAPIRequest	fetchMessageContent(com.android.volley.Response.Listener<java.lang.String> successListener, ErrorListener errorListener) Fetches the message content from the cloud through the stored datapoint ID.
java.lang.String	getMessageContent() Returns the local message content which was updated from a successful call to fetchMessageContent(Response.Listener, ErrorListener), or returns null if no such message content was ever fetched.
protected java.lang.String	getMessageDatapoiontId() Returns the message datapoint Id.
boolean	isLanModeSupported() Return true if this property supports LAN mode, which means its datapoints can be created and retrieved from LAN mode.
protected java.lang.String	parseDatapointIdFromValue(java.lang.String value) Parses the value passed in and returns the message datapoint Id if found, otherwise returns null.
protected void	setMessageDatapoiontId(java.lang.String id) Set the datapoint id of this message property.
PropertyChange	updateFrom(AylaDatapoint<java.lang.String> dp, AylaDevice.DataSource dataSource) Updates the property's value from the given datapoint and notifies any listeners of our owning device of the change.
PropertyChange	updateFrom(AylaProperty otherProperty, AylaDevice.DataSource dataSource) Updates the property from another property and notifies any listeners of our owning device of any changes that resulted.
PropertyChange	updateFrom(java.lang.String value, java.util.Map<java.lang.String,java.lang.String> metadata, AylaDevice.DataSource updateSource) Updates the property's value and notifies any listeners of our owning device of the change.

Methods inherited from class com.aylanetworks.aylasdk.AylaProperty

createDatapoint, createDatapoint, createDataPointBlob, createDatapointCloud, createDatapointCloud, createDatapointEndpoint, createDatapointLAN, createDatapointLAN, createTrigger, deleteTrigger, fetchDatapoints, fetchDatapointWithID, fetchTriggers, getAckedAt, getAckMessage, getAckStatus, getBaseType, getDataUpdatedAt, getDeviceManager, getDirection, getDisplayName, getKey, getLastUpdateSource, getMetadata, getName, getOwner, getSessionManager, getType, getValue, isAckEnabled, isReadOnly, setLastUpdateSource, toString, updateTrigger

Methods inherited from class java.lang.Object

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

Constructor Detail

AylaMessageProperty

public AylaMessageProperty()

Method Detail

getMessageContent

@Nullable
public java.lang.String getMessageContent()

Returns the local message content which was updated from a successful call to fetchMessageContent(Response.Listener, ErrorListener), or returns null if no such message content was ever fetched.

See Also:

on how to fetch online message content.

getMessageDatapoiontId

@Nullable
protected java.lang.String getMessageDatapoiontId()

Returns the message datapoint Id.

setMessageDatapoiontId

protected void setMessageDatapoiontId(java.lang.String id)

Set the datapoint id of this message property.

fetchMessageContent

public AylaAPIRequest fetchMessageContent(@NonNull
                                          com.android.volley.Response.Listener<java.lang.String> successListener,
                                          @NonNull
                                          ErrorListener errorListener)

Fetches the message content from the cloud through the stored datapoint ID.

Note that the message value return from AylaProperty.getValue() differs from the real message content that it only holds an reference to the real message content in the cloud. Internally, two steps are needed to fetch the real message content.

1. Get the datapoiont ID
2. Fetch message content with the datapoiont ID

Parameters:

successListener - Listener to receive the message content on success.

errorListener - Listener to receive error information should one occurred.

Returns:

The AylaAPIRequest object queued to send for this request, can be used to cancel the request if it has not been sent yet.

parseDatapointIdFromValue

@Nullable
protected java.lang.String parseDatapointIdFromValue(@Nullable
                                                               java.lang.String value)

Parses the value passed in and returns the message datapoint Id if found, otherwise returns null.

Parameters:

value - the value that may contains a valid message datapoint Id.

createDatapointEndpoint

protected java.lang.String createDatapointEndpoint()

Description copied from class: AylaProperty

Returns the endpoint path required to create/get new datapoionts.

Overrides:

createDatapointEndpoint in class AylaProperty<java.lang.String>

createDatapointPayload

protected java.lang.String createDatapointPayload(java.lang.String value,
                                                  java.util.Map<java.lang.String,java.lang.String> metadata)

Description copied from class: AylaProperty

Create the payload required to create the datapoiont.

Overrides:

createDatapointPayload in class AylaProperty<java.lang.String>

Parameters:

value - the datapoiont value to be sent to the cloud.

metadata - (optional) metadata associated with the datapoint value.

isLanModeSupported

public boolean isLanModeSupported()

Description copied from class: AylaProperty

Return true if this property supports LAN mode, which means its datapoints can be created and retrieved from LAN mode. All property types support LAN mode by default, except message property and file property.

Overrides:

isLanModeSupported in class AylaProperty<java.lang.String>

updateFrom

public PropertyChange updateFrom(AylaDatapoint<java.lang.String> dp,
                                 AylaDevice.DataSource dataSource)

Description copied from class: AylaProperty

Updates the property's value from the given datapoint and notifies any listeners of our owning device of the change.

Overrides:

updateFrom in class AylaProperty<java.lang.String>

Parameters:

dp - Datapoint used to update this property's value

Returns:

A PropertyChange describing the change, or null if no changes occurred

updateFrom

public PropertyChange updateFrom(AylaProperty otherProperty,
                                 AylaDevice.DataSource dataSource)

Description copied from class: AylaProperty

Updates the property from another property and notifies any listeners of our owning device of any changes that resulted.

This method should only be called internally.

Overrides:

updateFrom in class AylaProperty<java.lang.String>

Parameters:

otherProperty - Property to take our new values from

Returns:

the PropertyChange that resulted from the operation, or null if no changes were made

updateFrom

public PropertyChange updateFrom(java.lang.String value,
                                 java.util.Map<java.lang.String,java.lang.String> metadata,
                                 AylaDevice.DataSource updateSource)

Description copied from class: AylaProperty

Updates the property's value and notifies any listeners of our owning device of the change.

This method should only be called internally.

Overrides:

updateFrom in class AylaProperty<java.lang.String>

Parameters:

value - New value to set

metadata - New metadata

Returns:

the PropertyChange that resulted from the operation, or null if no changes were made