ICInteractiveData
This class represents the data for user interaction on message.
setType
This method sets the type of Interactive Data.
Parameters:
Parameter | Type | Description |
---|---|---|
type | ICInteractiveDataType | type of the Interactive Data |
getType
This method is used to get the interactive data type for message
Return Value: Returns ICInteractiveDataType type of the Interactive Data.
setTid (Deprecated)
This method sets the transaction id for the form response message.
Parameters:
Parameter | Type | Description |
---|---|---|
tid | String | Transaction id that uniquely identifies the form response message |
setPayload
This method sets the interactive payload data.
Parameters:
Parameter | Type | Description |
---|---|---|
payload | JSONObject | The interactive payload data |
getPayload
This method gets interactive payload data.
Return Value: Returns JSONObject the interactive payload data.
setSubmittedAt
Sets the date on which the interaction data was submitted to the imiconnect platform
Parameters:
Parameter | Type | Description |
---|---|---|
submittedAt | Date | The interactive payload data |
getSubmittedAt
Returns the date on which the interaction data was submitted to the imiconnect platform.
Return Value: Returns Date submitted date.
toJSON
This method returns a new JSONObject instance containing message interactive data.
Return Value: Returns JSONObject representation of the message interactive data.
fromJSON
Instantiates a new ICInteractiveData instance from the supplied JSONObject.
Parameters:
Parameter | Type | Description |
---|---|---|
jsonObject | JSONObject | A valid JSONObject instance containing message interactive data. |
Return Value: Returns A new ICInteractiveData or null if jsonObject is null.
getIdentifier
This method is used to get the identifier of the Interactive Data .
Syntax: String getIdentifier()
Return Value: Returns the identifier of the Interactive Data .
setIdentifier
This method is used to set the identifier of the Interactive Data .
Syntax: void setIdentifier (String identifier)
Parameter:
Parameter | Type | Description |
---|---|---|
identifier | String | The identifier of the Interactive Data. |
getTitle
This method is used to get the title of the Interactive Button .
Syntax: String getTitle()
Return Value: Returns the title of the Interactive Button .
setTitle
This method is used to set the title of the Interactive Button .
Syntax: void setTitle(String title)
Parameter:
Parameter | Type | Description |
---|---|---|
title | String | The title of the Interactive Button. |
getReference
This method is used to get the reference of the Interactive data.
Syntax: String getReference()
Return Value: Returns the reference of the Interactive data.
setReference
This method sets the reference of the Interactive data.
Syntax: void setReference(String reference)
Parameter:
Parameter | Type | Description |
---|---|---|
reference | String | The reference of the Interactive data. |
getRelatedTransactionId
This method is used to get the transaction id for message Data response.
Syntax: String getRelatedTransactionId()
Return Value: Returns the related Transaction Id of the Interactive data.
setRelatedTransactionId
This method sets the related Transaction Id of the Interactive data.
Syntax: void setRelatedTransactionId(String relatedTransactionId)
Parameter:
Parameter | Type | Description |
---|---|---|
relatedTransactionId | String | The transaction id for message Data response |
Updated 8 months ago